Action Documents

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 Parameteractiondocuments
Location/actiondocuments
MethodsGET POST PUT DELETE
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
nameThe name of the document.stringtruedefault

modifiedTimestampWhen the document last modified.timestampfalsedefaultread-only
statusThe status of the document.stringfalsedefaultread-only
keywordsSearch keywords for the document.stringfalseadditionalimmutable
summaryThe document summary.stringfalseadditional

checkedOutTimestampWhen the document was checked out.timestampfalseadditionalread-only
checkedOutToThe name of the Participant the document is checked out to.stringfalseadditionalread-only
checkedOutEtaTimestampWhen the document is expected to be checked back in.timestampfalseadditionalread-only
fileTypeThe file type.stringfalsedefaultread-only
fileSizeThe size of the document.integerfalsedefaultread-only.
fileNameThe name of the file.stringfalseadditionalread-only
extensionThe file extension.stringfalsedefaultread-only
isDeleted
booleanfalsedefaultread-only
sharepointUrlThe URL to access the document via SharePoint.stringfalseadditionalread-only
actionThe Action that the document belongs to.stringtruelink

checkedOutByThe Participant that has currently checked out the document.stringfalselinkread-only
folder.The ActionFolder the document is located in.stringfalselink

createdByThe Participant that created the document.stringfalselinkread-only
tagThe Tag associated with this docummentstringfalselink

documentTemplateThe Template for this document.stringfalselink

fileThe document Filestringtruefile


Link Templates
IdentifierResourceLocation Template
actiondocuments.actionactions/actions/{actiondocuments.action}
actiondocuments.checkedOutByparticipants/participants/{actiondocuments.checkedOutBy}
actiondocuments.actionFolderactionfolders/actionfolders/{actiondocuments.actionFolder}
actiondocuments.createdByparticipants/participants/{actiondocuments.createdBy}
actiondocuments.tagtags/tags/{actiondocuments.tag}
actiondocuments.documentTemplatedocumentTemplates/documentTemplates/{actiondocuments.documentTemplate}
actiondocuments.filefiles/files/{actiondocuments.file}


Errors
CodeFieldCondition
AD-01folderInvalid folder action id.
AD-02folderInvalid folder id.
AD-03statusCannot modify this document as it is currently checked out.

Related pages