...
Field | Description | Format | Field Type | Notes |
---|---|---|---|---|
id | Action ID | string | default | |
mustCompleteTasks | List of existing "tasks" which need to be completed PRIOR to moving to this step | collection | link | These tasks must be completed (or deleted) via the tasks resource before making a POST request to the actionchangestep resource. |
mustHaveEmailAddresses | List of participant records which need to have an email address defined PRIOR to moving to this step | collection | link | These are usually due to emails in the stepMessages, if you change the participants or disable an email from being sent then you can assume their email address is not longer required. |
step | Link to the "Start" step being described | string | link | |
node | Link to the "node" in the step tree (required in the POST) | integer | link | |
stepTasks | List of all the tasks (both required + optional) for this step | collection | link | |
stepMessages | List of all the messages to be sent (currently limited to emails) for this step | collection | link | |
documentTemplates | List of all the document templates to be added to the action for this step | collection | link | |
stepParticipantTypes | List of all the participant types specifically requested to be displayed to the user for this step | collection | link | |
otherParticipantTypes | List of participant types (other than those in stepParticipantTypes) that should be shown to the user due to their inclusion in an email etc | collection | link | |
stepDataFields | List of data-fields that should be editable by the user for this step | collection | link | |
stepRelatedActionTypes | List of related action types that are required for the user to associate on this step | collection | link |
...