Sign in

v4

latestSwagger 2.02026-07-1382857.5 KB

Returns the status for a specific document

Returns the translation status for a specific document based on the request Id and document Id.

get/document/batches/{id}/documents/{documentId}

Path parameters

idstring uuid required

Format - uuid. The batch id

documentIdstring uuid required

Format - uuid. The document id

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

pathstring

Location of the document or folder

sourcePathstring required

Location of the source document

createdDateTimeUtcstring date-time required

Operation created date time

lastActionDateTimeUtcstring date-time required

Date time in which the operation's status has been updated

status'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Cancelled' | 'Cancelling' | 'ValidationFailed' required

List of possible statuses for job or document

tostring required

To language

progressnumber float required

Progress of the translation if available

idstring uuid required

Universally Unique Identifier

characterChargedinteger

Character charged by the API

totalImageScansSucceededinteger

Total image scans charged by the API

totalImageScansFailedinteger

Total image scans failed

imageChargedinteger

Images charged by the API

imageCharacterDetectedinteger

Characters detected within images