Download document
Permits to download an original or translated document from a project.
This method is very similar to the one exposed by the document library.
The difference is that you do not need to know the actual physical library path of translations (may differ from the original document path). Here you simply specify the source document path and the language of the translation.
URL
(GET) projects/{projectid}/documents/{locale}/file
PARAMETERS
token | The token obtained on connection | Required |
projectid | The project id | Required |
locale | The language version of the document to download. The language must be a project language. | Required |
docid | Identifies the document to download by its id. The document id is the same for all language versions. | Optional |
name | Identifies the document to download by its path/name. The path/name is language independent. | Optional |
reference | Identifies the document to download by its reference. References are not necessarily unique. | Optional |
RESULTS
A document is uniquely defined by both the "docid" and the "name". It is not required to set both.
However, the "reference" does not necessarily point to a single document.