PUT 1.0/{InstanceId}/Documents/{DocumentId}/Notes/{NoteId}

Updates a specific Document Note. The information for creating the new note is sent via the body of the request

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional information
InstanceId

The instance ID relating to a specific ADM database

 string

Required
DocumentId

The ID of the document containing the note

 integer

Required
NoteId

The ID of the document note to be updated

 integer

Required

Body Parameters

Contains all the information required to create a Document Note

CreateEditDocumentNoteRequest
API Parameter Details
NameDescriptionTypeAdditional 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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateEditDocumentNoteRequest'.

Response Information

Resource Description

Appropriate HTTP headers with no content are returned only