variable id/name
variable value
variable description
Optional
expressionType: VariableExpressionTypetype of the value
Optional
noEncode: booleando not encode if passing a pre-encoded (base64) value
a promise that resolves to a variable object
Delete variable by id/name
variable id/name
a promise that resolves to a variable object
Export variable. The response can be saved to file as is.
variable id/name
Optional
noDecode: booleanDo not decode value (default: false)
Promise resolving to a VariablesExportInterface object.
Export all variables
Optional
noDecode: booleanDo not decode values (default: false)
Promise resolving to an VariablesExportInterface object.
Get variable by id/name
variable id/name
a promise that resolves to a variable object
since v2.0.0 use readVariable instead
readVariable(variableId: string): Promise<VariableSkeleton>
Get all variables
a promise that resolves to an array of variable objects
Import variable by id
variable id/name
import data
imported variable object
Import variables
import data
array of imported variable objects
Create variable
variable id/name
base64-encoded variable value
variable description
Optional
expressionType: VariableExpressionTypetype of the value
a promise that resolves to a variable object
since v2.0.0 use createVariable instead
createVariable(variableId: string, value: string, description: string, expressionType?: VariableExpressionType): Promise<VariableSkeleton>
Read variable by id/name
variable id/name
Optional
noDecode: booleanDo not decode value (default: false)
a promise that resolves to a variable object
Read all variables
Optional
noDecode: booleanDo not decode values (default: false)
a promise that resolves to an array of variable objects
Attempt to resolve a string to an ESV variable in AIC deployments.
Input string to be evaluated as a possible ESV.
Provide an empty or prepopulated map of ESV variables. The function adds any resolved variables to the map that don't exist.
Returns the resolved value of the ESV or the original input string
Set variable description
variable id/name
variable description
a promise that resolves to an empty string
since v2.0.0 use updateVariableDescription instead
updateVariableDescription(variableId: string, description: string): Promise<any>
Update or create variable
variable id/name
variable value
variable description
Optional
expressionType: VariableExpressionTypetype of the value
Optional
noEncode: booleando not encode if passing a pre-encoded (base64) value
a promise that resolves to a variable object
Update variable description
variable id/name
variable description
a promise that resolves to a status object
Create variable