The Actions resource is a core resource in Actionstep. An Action is either directly or indirectly related to most of the other resources in Actionstep. Actions serve as the containers within which most other resources reside. This includes Tasks, Email, Documents, Action Participants, Filenotes and many more. New Actions are created from templates called Action Types. Action Types dictated the much of the behavior and characteristics of the Action; for example, its workflow.
Resource Properties
| Scope Parameter | actions |
|---|
| Location | /actions |
|---|
| Methods | GET, PUT |
|---|
| Default Page Size | 50 |
|---|
| Max Page Size | 200 |
|---|
| Default Includes | None |
|---|
Resource Attributes
| Field | Description | Format | Required | Field Type | Notes |
|---|
| name | The action name | string | true | default |
|
| priority | Numeric priority. | number | false | default |
|
| status | The status of the Action. | string | true | default | Limited to "Active", "Inactive", "Closed" and "Template" |
| reference | An additional reference name or number. | string | false | additional |
|
| statusTimestamp | The timestamp of when the status was updated. | timestamp | false | additional | Read-only. True, if the status is being updated. |
| isBillableOverride | Has a billing override. | boolean | false | additional | Limited to "T" or "F". |
| createdTimestamp | When the Action was created. | date | false | additional | Read-only. |
| modifiedTimestamp | When the Action was last modified. | timestamp | false | additional | Read-only. |
| isDeleted | If the Action has been deleted. | boolean | true | additional | Read-only. |
| deletedBy | The full name of the Participant who deleted the Action. | string | false | additional | Read-only. |
| deletedTimestamp | When the Action was deleted. | timestamp | false | additional | Read-only. |
| isFavorite | If the action has been favorited by the current user. | boolean | false | additional |
|
| overrideBillingStatus | Indicates if a matter can be billed. | string | false | additional | Limited to "Active" or "Closed" |
| lastAccessTimestamp |
| timestamp | false | additional |
|
| division | The Division that the Action belongs to. | string | false | link |
|
| assignedTo | The Participant that is assigned to the Action. | string | true | link |
|
| actionType | The Action Type the Action belongs to. | string | true | link |
|
| node | The node in the Step Tree the Action is at. | string | false | link | Not Yet Implemented. |
| step | The Step that the Action is on. | string | false | link |
|
| billingPreference | The Billing Preference associated to the Action. | string | false | link | Not Yet Implemented. |
| primaryParticipants | An array of the primary participant(s) for the Action | collection | false | default |  Currently Read-only |
| billSettings |
| string | false | link |
|
| relatedActions |
| collection | true | default |
|
Link Templates
| Identifier | Resource | Location Template |
|---|
| actions.actionType | actiontypes | /actiontypes/{actions.actionType} |
| actions.assignedTo | participants | /participants/{actions.assignTo} |
| actions.node | steptreenodes | /steptreenodes/{actions.node} |
| actions.step | steps | /steps/{actions.step} |
| actions.division | divisions | /divisions/{actions.division} |
| actions.billingPreference | billingpreferences | /billingpreferences/{actions.billingPreference} |
| actions.primaryParticipants | participants | /participants/{actions.primaryParticipants} |
| actions.billSettings | actionbillsettings | /actionbillsettings/{actions.billSettings} |
Errors
| Code | Field | Condition |
|---|
| A-01 | status | The value of the status attribute must be either "Active", "Inactive", "Closed" or "Template" |
| A-02 | priority | The value of the priority field is numeric. |
| A-03 | assignedTo | The assignedTo participant must be a system user. |
| A-04 | assignedTo | The assignedTo participant must belong to the specified division. |