The information in this document is currently in BETA and subject to change.
The Action Documents resource represents documents stored in an action.
Resource Properties
| Scope Parameter | actiondocuments |
|---|---|
| Location | /actiondocuments |
| Methods | GET POST PUT DELETE |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|---|---|---|---|---|---|
| name | The name of the document. | string | true | default | ||
| modifiedTimestamp | When the document last modified. | number | false | default | read-only | |
| status | The status of the document. | string | false | default | read-only | |
| keywords | Search keywords for the document. | string | false | additional | ||
| summary | The document summary. | timestamp | false | additional | ||
| checkedOutTimestamp | When the document was checked out. | boolean | false | additional | read-only | |
| checkedOutTo | The name of the Participant the document is checked out to. | timestamp | false | additional | read-only | |
| checkedOutEtaTimestamp | When the document is expected to be checked back in. | timestamp | false | additional | read-only | |
| fileType | The file type. | boolean | true | default | ||
| fileSize | The size of the document. | string | false | default | read-only | . |
| fileName | The name of the file. | additional | read-only | |||
| extension | The file extension. | string | false | default | ||
| sharepointUrl | The URL to access the document via SharePoint. | string | false | additional | read-only | |
| action | The Action that the document belongs to. | string | true | link | ||
| checkedOutBy | The Participant that has currently checked out the document. | string | false | link | read-only | |
| folder | .The ActionFolder the document is located in. | string | false | link | ||
| createdBy | The Participant that created the document. | string | false | link | read-only | |
| documentTemplate | The Template for this document. | string | false | link |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| actiondocuments.action | actions | /actions/{actiondocuments.action} |
| actiondocuments.checkedOutBy | participants | /participants/{actiondocuments.checkedOutBy} |
| actiondocuments.actionFolder | actionfolders | /actionfolders/{actiondocuments.actionFolder} |
| actiondocuments.createdBy | participants | /participants/{actiondocuments.createdBy} |
| actiondocuments.tag | tags | /tags/{actiondocuments.tag} |
| actiondocuments.documentTemplate | documentTemplates | /documentTemplates/{actiondocuments.documentTemplate} |
Errors
| Code | Field | Condition |
|---|---|---|
| AD-01 | folder | The value of the status attribute must be either "Active", "Inactive", "Closed" or "Template" |
| AD-02 | folder | The value of the priority field is numeric. |
| AD-03 | status | Cannot modify this document as it is currently checked out. |