ONonecodex

POST documents instances_confirm_upload

post/api/v1/documents/confirm_upload

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/documents/confirm_upload
  • Auth
    API key in header X-API-Key

Request body

document_idstring required

The document_id returned by /documents/init_upload. Note that the document will not be accessible via /documents/<id> until the upload is confirmed.

Response

OK

messagestring required

A success or error message.

successboolean required

Whether the upload was successful.

Example response

{
  "document": {
    "__DOLLAR_REF__": "/api/v1/documents/a1b2c3d4e5f67890"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.