The Action Documents resource allows you to get and set the metadata associated with files stored in actions.
If you need to download or upload the file itself you will need to use the Files resource. To download a file first obtain the "file" identifier by issuing an actiondocuments GET request (below) and then use that identifier in the files resource request to download the file. To upload a file first use the Files resource to PUT the file and then update the actiondocuments resource below with the file identifier to link it to the desired action and folder.
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. | timestamp | false | default | read-only |
|
| status | The status of the document. | string | false | default | read-only |
|
| keywords | Search keywords for the document. | string | false | additional | immutable |
|
| summary | The document summary. | string | false | additional |
|
|
| checkedOutTimestamp | When the document was checked out. | timestamp | false | additional | read-only |
|
| checkedOutTo | The name of the Participant the document is checked out to. | string | false | additional | read-only |
|
| checkedOutEtaTimestamp | When the document is expected to be checked back in. | timestamp | false | additional | read-only |
|
| fileType | The file type. | string | false | default | read-only |
|
| fileSize | The size of the document. | integer | false | default | read-only | . |
| fileName | The name of the file. | string | false | additional | read-only |
|
| extension | The file extension. | string | false | default | read-only |
|
| isDeleted |
| boolean | false | default | read-only |
|
| 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 |
|
| tag | The Tag associated with this documment | string | false | link |
|
|
| documentTemplate | The Template for this document. | string | false | link |
|
|
| file | The document File | string | true | file |
|
|
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} |
| actiondocuments.file | files | /files/{actiondocuments.file} |
Errors
| Code | Field | Condition |
|---|
| AD-01 | folder | Invalid folder action id. |
| AD-02 | folder | Invalid folder id. |
| AD-03 | status | Cannot modify this document as it is currently checked out. |