A JSON object that represents name and other details for a document in a scope.
PROPERTIES
| did | The document id. | int |
| dsid | The document set id.
| int |
| name | The name of the document. | string |
| pmax | Null or the maximum document paragraph (segment id) to which the connected user has access. This is used when only a portion of a document is assigned as a job to a worker. | int? |
| pmin | Null or the minimum document paragraph. | int? |
| ptype | Parser type, internal use. | int? |
| pdomain | Parser domain: WORD, EXCEL, TXT, POT etc. | string |
| previewapp | A preview application identifier. Used when translating subtitles or voice overs. Requires timestamp information in the segment context field. Supported values: "video" More information: resources/documents/{did}/previewapp | string? |
| previewurl | The URL used by the preview application. With videos previews this would be the video's URL (in a Wordbee project or an external URL). | string? |
| edit | True if the user can "likely" edit the document's segments. | bool |
| Advanced properties: Included by some API methods only | ||
| ctags | List of custom markup tag names that can be inserted into segments. | array<string> |
| sub | Null or the list of sub documents. For example, a Powerpoint file will be stored as one document with one sub document per slide. Each sub document has these properties:
| array<json> |
EXAMPLES
-