Actions

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 Parameteractions
Location/actions
MethodsGET, PUT
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeNotes
nameThe action namestringtruedefault
priorityNumeric priority.numberfalsedefault
statusThe status of the Action.stringtruedefaultLimited to "Active", "Inactive", "Closed" and "Template"
referenceAn additional reference name or number.stringfalseadditional
statusTimestampThe timestamp of when the status was updated.timestampfalseadditionalRead-only. True, if the status is being updated.
isBillableOverrideHas a billing override.booleanfalseadditionalLimited to "T" or "F".
createdTimestampWhen the Action was created.datefalseadditionalRead-only.
modifiedTimestampWhen the Action was last modified.timestampfalseadditionalRead-only.
isDeletedIf the Action has been deleted.booleantrueadditionalRead-only.
deletedByThe full name of the Participant who deleted the Action.stringfalseadditionalRead-only.
deletedTimestampWhen the Action was deleted.timestampfalseadditionalRead-only.
isFavoriteIf the action has been favorited by the current user.booleanfalseadditional
overrideBillingStatusIndicates if a matter can be billed.stringfalseadditionalLimited to "Active" or "Closed"
lastAccessTimestamp
timestampfalseadditional
divisionThe Division that the Action belongs to.stringfalselink
assignedToThe Participant that is assigned to the Action.stringtruelink
actionTypeThe Action Type the Action belongs to.stringtruelink
nodeThe node in the Step Tree the Action is at.stringfalselinkNot Yet Implemented.
stepThe Step that the Action is on.stringfalselink
billingPreferenceThe Billing Preference associated to the Action.stringfalselinkNot Yet Implemented.
primaryParticipantsAn array of the primary participant(s) for the Actioncollectionfalse default  Currently Read-only
billSettings
stringfalselink
relatedActions
collectiontruedefault


Link Templates
IdentifierResourceLocation Template
actions.actionTypeactiontypes/actiontypes/{actions.actionType}
actions.assignedToparticipants/participants/{actions.assignTo}
actions.nodesteptreenodes/steptreenodes/{actions.node}
actions.stepsteps/steps/{actions.step}
actions.divisiondivisions/divisions/{actions.division}
actions.billingPreferencebillingpreferences/billingpreferences/{actions.billingPreference}
actions.primaryParticipantsparticipants /participants/{actions.primaryParticipants}
actions.billSettingsactionbillsettings/actionbillsettings/{actions.billSettings}


Errors
CodeFieldCondition
A-01statusThe value of the status attribute must be either "Active", "Inactive", "Closed" or "Template"
A-02priorityThe value of the priority field is numeric.
A-03assignedTo The assignedTo participant must be a system user.
A-04assignedTo The assignedTo participant must belong to the specified division.