Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Resource Properties
Scope Parameteractiondocumentsactionrates
Location/actiondocumentsactionrates
MethodsGET POST PUT DELETE
Default Page Size50
Max Page Size200
Default IncludesNone

...

 
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
nameoverrideRateThe name of the document.stringtruedefault modifiedTimestampWhen the document last modified.numberfalsedefaultread-only 
statusThe status of the document.stringfalsedefaultread-only 
keywordsSearch keywords for the document.stringfalseadditional  
summaryThe document summary.timestampfalseadditional  
checkedOutTimestampWhen the document was checked out.booleanfalseadditionalread-only 
checkedOutToThe name of the Participant the document is checked out to.timestampfalseadditionalread-only 
checkedOutEtaTimestampWhen the document is expected to be checked back in.timestampfalseadditionalread-only 
fileTypeThe file type.booleantruedefault  
fileSizeThe size of the document.stringfalsedefaultread-only.fileNameThe name of the file.  additionalread-only 
extensionThe file extension.stringfalsedefault  
sharepointUrlThe URL to access the document via SharePoint.stringfalseadditionalread-only 
actionThe Actionthat 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 
documentTemplateThe Template for this documentrateThe Rate.stringfalselink  

 

Link Templates

...