...
| Info |
|---|
| The information in this document is currently in BETA and subject to change. |
The Action Documents Email Attachments resource represents documents stored in an action. attachments to emails.
Resource Properties
actiondocuments| emailattachments |
| Location | / |
|---|
actiondocuments| emailattachments |
| 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 name | content disposition of the |
document.| attachment | string | true | default |
| | | modifiedTimestamp | When the document last modified. | number | false | default | read-only | |
status | The status of the document. | | e.g attachment or inline |
| mimeContentId |
| 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 |
|
|
| displayName | 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| attachment to be displayed. | string | true | default |
| | fileSize
|
|
| attachmentSize | The size of the |
document.string| integer | false | default | read-only |
. fileName | The name of the file. | | read-only | | extension extensionfalsefalse | default | | | sharepointUrl | The URL to access the document via SharePoint. | string | read-only | | action Action document | attachment 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 |
|---|
actiondocumentsactionactionsactionsactiondocuments.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.