Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldDescriptionFormatField TypeNotes
idAction IDstringdefault 
mustCompleteTasksList of existing "tasks" which need to be completed PRIOR to moving to this stepcollectionlink These tasks must be completed (or deleted) via the tasks resource before making a POST request to the actionchangestep resource.
mustHaveEmailAddressesList of participant records which need to have an email address defined PRIOR to moving to this stepcollectionlinkThese 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.
stepLink to the "Start" step being describedstringlink 
nodeLink to the "node" in the step tree (required in the POST)integerlink 
stepTasksList of all the tasks (both required + optional) for this stepcollectionlink 
stepMessagesList of all the messages to be sent (currently limited to emails) for this stepcollectionlink 
documentTemplatesList of all the document templates to be added to the action for this stepcollectionlink 
stepParticipantTypesList of all the participant types specifically requested to be displayed to the user for this stepcollectionlink 
otherParticipantTypesList of participant types (other than those in stepParticipantTypes) that should be shown to the user due to their inclusion in an email etccollectionlink 
stepDataFieldsList of data-fields that should be editable by the user for this stepcollectionlink 
stepRelatedActionTypesList of related action types that are required for the user to associate on this stepcollectionlink 

...