Versions

POST 1.0/{InstanceId}/Documents/{DocumentId}/Versions

Checks in an edited document, creating a new document version

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required
DocumentId	The ID of the document to be checked in	integer	Required

Body Parameters

Contains the information needed to create a new document version

CreateDocumentVersionRequest

API Parameter Details
Name	Description	Type	Additional information
ServerFileKey	The key, related to the file that was seperately uploaded for this document version	string	None.
MajorRevision	The Major revision, which composes the 2-part revision number of this document version	boolean	None.
Comments	Represents comments that will be stored with a document when it's checked in successfully	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ServerFileKey": "sample string 1",
  "MajorRevision": true,
  "Comments": "sample string 3"
}

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 'CreateDocumentVersionRequest'.

Response Information

Resource Description

Returns "OK" if the document ws checked in successfully

CreatedResourceResponse

API Parameter Details
Name	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"
}