POST 1.0/{InstanceId}/Documents/{DocumentId}/Notes
Creates a new document note
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
InstanceId |
The instance ID relating to a specific ADM database |
string |
Required |
DocumentId |
The ID of the document where teh note will be added |
integer |
Required |
Body Parameters
Contains details of the document note to be created
CreateEditDocumentNoteRequestName | Description | Type | Additional information |
---|---|---|---|
NoteType |
The type of note |
NoteType |
None. |
Content |
The text of the note |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "NoteType": "Public", "Content": "sample string 1" }
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Returns "Created" and the id / uri if the note was created successfully, otherwise an appropriate error message
CreatedResourceResponseName | Description | Type | Additional information |
---|---|---|---|
Id |
The id of the newly created resource |
integer |
None. |
Uri |
The Uri location of the newly created resource |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "Uri": "sample string 2" }