The Steps resource represents the steps available on an action. Refer to the Action Create resource for usage.
Resource Properties
| Scope Parameter | steps |
|---|
| Location | /steps |
|---|
| Methods | GET |
|---|
| Default Page Size | 50 |
|---|
| Max Page Size | 200 |
|---|
| Default Includes | None |
|---|
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|
| id |
| string |
| default |
|
|
| stepNumber |
| string |
| default |
|
|
| stepName |
| string |
| default |
|
|
| description |
| string |
| default |
|
|
| actionStatus |
| string |
| default |
|
|
| assignToMandatory |
| boolean |
| default |
|
|
| actionType |
| integer |
| link |
|
|
| assignToParticipantType |
| integer |
| link |
|
|
Link Templates
| Identifier | Resource | Location Template |
|---|
| steps.actionType | actiontypes | /actiontypes/{steps.actionType} |
| steps.assignToParticipantType | participanttypes | /participanttypes/{steps.assignToParticipantType} |