Skip to main content
Version: 0.1.0

BlueprintVariableInput

A ProjectV3's BlueprintVariable represent key-value pairs: each a variable name and its value. These variables can either reference a variable spec, as defined by the Blueprint, or they can be declared as "custom variables" for the ProjectV3.

To reference a variable spec, specify either variableSpecID or the variableName that corresponds to a variable spec.

To declare a custom variable, specify the variableName and the variableType. If there is a variableSpec with the same name, the variableType will be ignored, and the variableSpec will take precedence.

All BlueprintVariables must specify their value. The VariableValueInput is serialized as a string, and is parsed server-side according to the variableType.

input BlueprintVariableInput {
  variableSpecID: UUID
  variableName: String
  value: VariableValueInput!
  variableType: BlueprintVariableType
}

Fields​

BlueprintVariableInput.variableSpecID ● UUID scalar​

ID of the corresponding variable spec. Must be present if variableName is not specified.

BlueprintVariableInput.variableName ● String scalar​

Name of the corresponding variable spec, or name to use when declaring a variable without referencing a variable spec. Must be present if variableSpecID is not specified.

BlueprintVariableInput.value ● VariableValueInput! non-null scalar​

The variable value. Always a string value, which will be parsed according to the variableType, determined either by the referenced variableSpec, or the provided variableType

BlueprintVariableInput.variableType ● BlueprintVariableType enum​

Type specification is required when variable is being declared without referencing a variable spec.

Member Of​

CreateProjectV3Input input ● UpdateProjectV3Input input