PUT 1.0/{InstanceId}/Documents/{DocumentId}/Versions/CheckOut

Checks out a document for editing, for creating a new version

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 to be edited

 integer

Required

Body Parameters

Contains the information required to check out this document

CheckOutDocumentVersionRequest
API Parameter Details
NameDescriptionTypeAdditional information
Comments

Represents comments that will be stored with a document when it's checked out successfully

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Comments": "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 'CheckOutDocumentVersionRequest'.

Response Information

Resource Description

Appropriate HTTP headers with no content are returned only