Versions Compared

Old Version 1

changes.mady.by.user Aaron Pettit (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Terra Yi (Unlicensed)

Saved on

Key

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


Info
The information in this document is currently
in 
in BETA
 and
and subject to change.

...


The Action Documents Scratch Notes resource represents documents stored in an actionnotes on the scratch pad.

 


Resource Properties
Scope Parameterscratchnotes
Location/scratchnotes
MethodsGET POST PUT DELETE
Default Page Size50
Max Page Size200
Default IncludesNone

 


Resource Attributes
Field
Description
Format
Required
Field Type
Restrictions
Notes
timestampThe
name of the document.string
time that the scratch note was createdtimestampfalsedefault
read-only
 


text
When the document last modified
The content of the scratch note.
number
stringtruedefault
  


statusThe status of the scratch note.stringfalsedefaultread-only
 participantThe Participant that the scratch note belongs to.stringfalselinkread-only 

 

Link Templates
Identifier
Resource
Location Template
scratchnotes.participantparticipants/participants/{scratchnotes.participant}

 

Errors
Code
Field
Condition
AD-01folderThe value of the status attribute must be either "Active", "Inactive", "Closed" or "Template"AD-02folderThe value of the priority field is numeric.AD-03statusCannot modify this document as it is currently checked out.