Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
The information in this document is currently in BETA and subject to change.


The Steps Step Participant Types resource represents the steps available on an action. Refresh participant types available for a step. Refer to the Action Create resource for usage.

Resource Properties
Scope Parameter
steps
stepparticipanttypes
Location/
steps
stepparticipanttypes
MethodsGET
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
id
string
default
stepNumber


isRequired
string

boolean
default
stepName


displayOrder
string

integer
default
description


actionType
string

integer
default

link
actionStatus


step
string
defaultassignToMandatorybooleandefault
actionTypeinteger

link
assignToParticipantType


participantType
integer
link


Link Templates
IdentifierResourceLocation Template
steps
stepparticipanttypes.actionTypeactiontypes/actiontypes/{
steps
stepparticipanttypes.actionType}
stepparticipanttypes.stepsteps
.assignToParticipantType
/steps/{stepparticipanttypes.step}
stepparticipanttypes.participantTypeparticipanttypes/participanttypes/{
steps
stepparticipanttypes.
assignToParticipantType
participantType}