Documents

POST 1.0/{InstanceId}/Documents

Creates a document within the desired folder in the Folder Structure

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required

Body Parameters

Contains all the details required to create the document

CreateDocumentRequest

API Parameter Details
Name	Description	Type	Additional information
ServerFileKey	A key that is returned when uploading a file using the FileUploadController	string	None.
Attributes	A simplified list of attributes for creating a new document	DocumentAttributes	None.
IndexingInfo	Contains Doc Type and Tag Values to be stored with the corresponding document	MetaDataProperties	None.

Request Formats

application/json, text/json

Sample:

{
  "ServerFileKey": "sample string 1",
  "Attributes": {
    "Title": "sample string 1",
    "DestinationFolderId": 1
  },
  "IndexingInfo": {
    "DocTypeId": 1,
    "TagValues": [
      {
        "TagId": 1,
        "TagValue": {}
      },
      {
        "TagId": 1,
        "TagValue": {}
      }
    ]
  }
}

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

Response Information

Resource Description

Returns "Created" and the id / uri if document was successfully created, otherwise an appropriate error message

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"
}