Input through PromptSets

PromptSet variables can be passed through the AE REST API request on execution given the objects to be executed have at least one PromptSet assigned.

REST request example:

• "&TEXT1#"

  Field type: Text field

• "&NUMBER1#

  Field type: Number field

• "&CHECKBOX_ARRAY#"

  Field type: Checkbox field

  It is recommended to define a Checkbox field as Array when used to pass values through the AE REST API.

  Recommendations: Array=true

• &CHECKBOX_STRING#

  Field type: Text field

  Recommendations: Array = false, separator = ";"

• "&MULTILINE1#"

  Field type: Text field

  Recommendations: Attribute "Multi-line" checked, \n for line breaks

Notes:

• The attribute Array of the PromptSet field CHECKBOX_ARRAY has to be set to true because the Automation Engine must handle it as an array.

• No object variables can be set here.

• Some REST requests contain the inputs parameter, which lists PromptSet variables. This context implies that they are all variables and there is no need to state explicitly a leading "&". The trailing "#" depends on the variable definition.

More information:

• AE REST API - Execute Objects with and without Inputs
• Variables and VARA Objects.

See also:

• REST API Reference
• AE REST API - General Info