...
The first section is ‘General Options,’ and it contains a field where you can add a description of what the step is trying to accomplish. You can also customize the name of the step. This section also provides a list of user-given inputs used in this step.
The second section is for ‘Required Inputs.’ These are the ‘Required Inputs’ section contains variables that must be set for the API call to proceed. This section is not always present, as not all API calls have required parameters.
The third section is for ‘Optional Inputs,’ which are ‘Optional Inputs’ section contains those parameters that the API call might make use of which are not explicitly required. Some APIs are flexible and allow you to add additional optional parameters not explicitly defined in the API specification. To allow for this, the ‘add input’ button will allow lets you to define an additional optional input arbitrary optional inputs to complete the API call.
Both All types of inputs have a small green ‘?’ next to their name which will supply help text as to what that parameter does. For more details, see the official API documentation for the API service you are using.
Both All types of inputs can be customized with the following states:
- Omitted. The default state. This parameter will not be sent with the API call. This option is not available for 'required' parameters.
- Default value. This parameter will be set to some constant, defined here.
- User given. This parameter will be supplied by the user executing the ACP Workflow.
- Workflow link. The input for this parameter is the output of another step. This will be described in greater detail later.
- Iteration. This parameter becomes available when the Iteration Options section is configured. Inputs set to ‘iteration’ are populated with the iterated run number, starting from zero. This will be described in greater detail in its own section.
- Function. The input of this parameter will be supplied by the output of a javascript function. This will be described in greater detail later.
...
- .
The fourth next section is ‘iteration options,’ which ‘Iteration Options’ and deals with how to loop over array responses. This section will be covered in more detail later.
...
Links Between Steps
Setting a Required Input or an Optional Input to be a ‘workflow link’ will indicate that this parameter is to be taken from the results of a previous step. The result can come from any previous step so long as it has already run.
When the ‘workflow link’ option is selected the form expands to gather the necessary information. The middle drop-down selects what step you will be taking this information from. Once a step is selected, the rightmost ‘property’ box accepts the name of a parameter.
For example, if you are referencing a ProVision Resource GET call you can specify ‘id’ or ‘name’ here to feed in the associated value to this parameter.
If the step you are referencing returns an array of items, you can specify which item in the array you reference by way of the syntax ‘index.property’. For example, if an API call returns an array of 3 objects, and you want to reference the id of the last one, you would put ‘2.id’ in the ‘property’ field.
If the parameter name or array index provided does not exist in the corresponding return object, null will be used.
A simple example of using the ‘workflow link’ parameter can be found in the ACP examples library as ‘Getting Started 3. Connecting Steps.’
...