Action Participants

The Action Participants resource represents the participants of an action.


Resource Properties
Scope Parameteractionparticipants
Location/actionparticipants
MethodsGET POST DELETE
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
participantNumberSequential number defining the order the action participants were added to an action.integerfalsedefaultread-only
actionThe Action.stringtruelinkimmutable
participantTypeThe Participant Type.stringtruelinkimmutable
participantThe Participant.stringtruelinkimmutable


Link Templates
IdentifierResourceLocation Template
actionparticipants.actionactions/actions/{actionparticipants.action}
actionparticipants.participantTypeparticipanttypes/participanttypes/{actionparticipants.participantType}
actionparticipants.participantparticipants/participants/{actionparticipants.participant}

POST Request

When creating a new action participant, the request body should be structured as follows:

{
"actionparticipants": {
"links": {
"action": "1",
"participant": "41471",
"participantType": "27"
}
}
}

Related pages