Creates a document metadata (JobDocument). The DocumentGUID is returned in the response. The document does not yet create a file or a thumbnail, they can be added using Set Document Resource, Set Document Meta Data and Set Document Thumbnail.
URL:
POST: http://api.aurelon.com/api/v2/document/create
Request Headers:
Content-Type : application/json
MisKey : see Authentication
Request Body:
JSON Object containing:
-
- DocumentGUID – optional – the Document GUID, when specified this GUID is used and if document with such GUID is already exist error will be shown
- Name – required – document name
- Dimensions – Size of the document in units concatenated into a string in the following format: “{width},{height}”; this property is deprecated, use width and height directly;
- Width – Width of the document in units
- Height – Height of the document in units
- IsAsset – Mark a document as an asset (won’t be subject to auto-delete)
Response:
Content type application/json containing the result of the operation.
Success:
200 OK : {“Message”:”Document successfully created”, “DocumentGUID”:”00000000-0000-0000-0000-000000000000″}
Error:
- 400 Bad Request : {“Message”:”A document with this DocumentGUID already exists”}
- 401 Unauthorised : {“Message”:”Invalid MisKey”}
- 401 Unauthorised : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 415 Unsupported Media Type : {“Message”:”This request is not properly formatted”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}