/
Action Participants
Action Participants
The Action Participants resource represents the participants of an action.
Resource Properties
Scope Parameter | actionparticipants |
---|---|
Location | /actionparticipants |
Methods | GET POST DELETE |
Default Page Size | 50 |
Max Page Size | 200 |
Default Includes | None |
Resource Attributes
Field | Description | Format | Required | Field Type | Restrictions | Notes |
---|---|---|---|---|---|---|
participantNumber | Sequential number defining the order the action participants were added to an action. | integer | false | default | read-only | |
action | The Action. | string | true | link | immutable | |
participantType | The Participant Type. | string | true | link | immutable | |
participant | The Participant. | string | true | link | immutable |
Link Templates
Identifier | Resource | Location Template |
---|---|---|
actionparticipants.action | actions | /actions/{actionparticipants.action} |
actionparticipants.participantType | participanttypes | /participanttypes/{actionparticipants.participantType} |
actionparticipants.participant | participants | /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 content
Action Create
Action Create
More like this
Action Types
Action Types
Read with this
Participants
Participants
More like this
Data Collection Fields
Data Collection Fields
Read with this