| 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 actionattachments to emails.
Resource Properties
| Scope Parameter | actiondocumentsemailattachments |
|---|---|
| Location | /actiondocumentsemailattachments |
| Methods | GET POST PUT DELETE |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
...
| Field | Description | Format | Required | Field Type | Restrictions | Notes | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namecontentDisposition | The name of the document. | string | true | default | |||||||||||||||||||||
| modifiedTimestampmimeContentId | When the document last modified. | numberstring | false | default | read-only | ||||||||||||||||||||
| statusdisplayName | The status of the document. | string | falsetrue | default | read-only | ||||||||||||||||||||
| keywordsattachmentSize | Search keywords for the document. | stringinteger | false | additional | |||||||||||||||||||||
| summary | The document summary. | timestamp | false | additional | |||||||||||||||||||||
| checkedOutTimestamp | When the document was checked out. | boolean | false | additional | default | read-only | |||||||||||||||||||
| checkedOutTooldNfsPath | 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. | timestampdocument summary. | string | false | additionalread-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 attachment file extension. | string | falsetrue | defaultlink | ||||||||||||||||
| sharepointUrl | The URL to access the document via SharePoint. | string | false | additional | read-only | ||||||||||||||||||||
| action | The Action that the document email | The Email that the 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 | ||||
|---|---|---|---|---|---|---|
| actiondocuments.action | actionsemailattachments,file | files | / | actionsfiles/{ | actiondocumentsemailattachments. | actionfile} |
| actiondocumentsemailattachments.checkedOutByemail | participantsemails | /participantsemails/{actiondocumentsemailattachments.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.email} |