invantive documentation
Invantive Support ForumsLog In / Sign Up

DocumentStatusesByDocumentId: DeepL Document Statuses

read only REST

  • Catalog: DeepL
  • Schema: Documents
  • Label: Document Statuses

Can only retrieve data.

Summary

The status of a document being translated.

API Source

  • Endpoint: /v2/document/{document_id}

Performance Characteristics

Characteristic Value
Average access latency (ms) 31

Parameters

Name Data Type Required Default Documentation
document_id varchar2 The document id deepl_documents.upload_document answered.
document_key varchar2 The document key deepl_documents.upload_document answered.

Table Columns

The columns of the table DocumentStatusesByDocumentId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
billed_characters int64 itgen_dpl_billed_characters filters on the platform, writable Characters billed; billed only after the download.
document_id varchar2 itgen_dpl_document_id filters on the platform, writable The document id.
error_message varchar2 itgen_dpl_error_message filters on the platform, writable The error, when the translation failed.
seconds_remaining int32 itgen_dpl_seconds_remaining filters on the platform, writable Estimated seconds until done; only while translating.
status varchar2 itgen_dpl_status filters on the platform, writable queued, translating, done or error.