...
Each item in documents has these properties:
did | Document id. | int |
| dsid | Document set id. | int |
| name | The source document name or the deliverable name (depending on language) | string |
| src | Boolean. The source locale of this document. | string |
| domain | The parser domain code, such as HTML, PLAINTEXT, etc. | string |
| locales | An array with document details per language, see below. Sorted alphabetically with source language ALWAYS on top. | object[] |
The locales array items have these properties:
locale | Language code. | string |
| localet | Language name. | string |
| isSource | True if this is the source language of the document. The source language item is always shown in first position. | bool |
| name | The original file name or the deliverable name. Note that deliverables can be renamed by the user. | string |
| dvrequired | Boolean. True if the user must submit a deliverable. If true, the user can only approve if a physical file was set (see exists property on deliverable). | bool |
| dvapproved | Boolean. True if the user confirmed that deliverable is done as expected. Includes case where user says no, I do not want to set a deliverable. | bool |
| encoding | The encoding if the document is a text file (xml, json...). For example "utf-8". In some cases this information may not be available. For binary formats such as Word or InDesign, the encoding is null. | string? |
EXAMPLES
See this example:
...