...
The message body contains a JSON object:
scope | The scope object. Note that if you use a document set or global search scope, you will receive an "available" = false result. In fact these scopes do not support files. |
| did | The document id. This must be a document within the scope. |
| locales | Null or optional list of locales you want to get information for. If null then you get info for all the authorized locales in scope. |
| populateDepth | Null or optional depth of file structure to load:
|
...
available | Boolean. If false, then no other property is populated. It means that the scope does not propose any file management or the user cannot do any file management. Ideally, completely hide away files tools or show a message. This property is also included in the segments rights properties as property "hasFiles". So you should check this first! | bool |
| did | The document id. | int |
| dsid | The document set id. | int |
| name | The name of the original file (including folders). | string |
| locales | A dictionary where the key is a locale and the value is an object with files details in this language, see below. | dictionary |
| previewers | A JSON object with each previewer system and whether it is enabled or not. Source and target documents include the information of the previewer system used. Hence this can be used to tell if the preview is possible or if it needs to be enabled or subscribed to first. | object |
| previewersCanEnable | Boolean. If true, the current user has the right to activate previewers that are not enabled. In Wordbee Translator this is done from the "Settings" page. | bool |
| encodings | An array of all encodings. Each encoding is an object with "v" (encoding code), "t" (user friendly title of encoding). This information can be used when creating deliverables or previewing files to choose an encoding for text based files. | object[] |
| rm | Represents the project reference material. See description of node further down. This node is null if either (a) the scope is not a project or job scope, or (b) the user has no access to the reference material. | object? |
Each item in locales has these properties:
locale | The locale. | string |
| isSource | True: This is the source language. | bool |
| Source file or deliverable related properties | ||
| 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? |
| 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 |
| canDocSet | Boolean. Tells if the deliverable can be set, renamed or deleted. | bool |
| canDocDownload | Boolean. Right to download the file. | bool |
| canDocPreview | Boolean: Right to web preview the file. | |
| document | A file node describing the document. | |
| Attachments | ||
| bool | ||
| canAttSet | Boolean. User can set, rename, delete, manipulate attachments. | bool |
| document | A file node describing the document. | object |
| attachments | A folder node that contains the attachments. | object |
The file/folder nodes form a tree structure. A folder node may have file node and folder node children.
isdir | True: This is a folder node False: This is a file node | bool |
| name | Name of file or folder | string |
| folder | Internal identifier of the parent node. Folder IDs are required when manipulating files. | string |
| exists | Boolean. Tells if the file or folder actually exists. If this node is a deliverable, it will be prepopulated with all information (such as the expected name of deliverable) but the deliverable may not yet exist on the server. | bool |
| readonly | Boolean. Tells if the file is readonly or not. The original file will be readonly. Currently, the API does not allow to set this flag, so basically it is of not much use today. | bool |
| date | File/folder date. Null if not exists. | date? |
| size | File/folder date. 0 if file/folder not exists. | int |
| File nodes only | ||
| canPreview | Boolean. If true then the file can potentially be previewed in the browser. Use these methods for previewing:
| bool |
| Folder nodes only | ||
| scanned | Tells if the sub folders have been loaded. Ths is related to the populateDepth parameter. | bool |
| files | Only exists if isdir is true. Array of file nodes contained in the present folder node. | object[]? |
| folders | Only exists if isdir is true. Array of folder nodes contained in the present folder node. | object[]? |
EXAMPLES
The rm node has these properties:
| canSet | True if the user can add/remove/rename reference material. | bool |
| contents | The files and folders contained in the reference material. This object has the same structure as file/folder nodes described above. | object |
EXAMPLES
See this example:
| Code Block |
|---|
{
"did": 1865,
"dsid": 367,
"available": true,
"name": "html.txt",
"locales": {
"en-US": {
"locale": "en-US",
"isSource": true,
"canDocSet": false,
"canDocDownload": true,
"canDocPreview": true,
"canAttSet": true,
"dvrequired": false,
"dvapproved": false,
"document": {
"folder": "doc:en-US",
"name": "html.txt",
"isdir": false,
"exists": true,
"readonly": true,
"date": "2017-02-05T22:57:24.7403048Z",
"size": 502,
"scanned": true,
},
"attachmentscanPreview": {false
},
"attachments": {
"folder": "att:en-US\\html.txt_",
"name": "",
"isdir": true,
"exists": true,
"readonly": false,
"date": "2017-0204-06T1405T07:5153:5111.7538074Z3225939Z",
"size": null,
"scanned": true,
"files": [
{
"folder": "att:en-US\\html.txt_",
"name": "Html replace term.config",
"isdir": false,
"exists": true,
"readonly": false,
"date": "2017-02-06T14:51:48.9304819Z",
"size": 11997,
"scanned": true,
} "canPreview": false
], },
"folders": [] {
} }, "zh-Hans": { "locale"folder": "zh-Hansatt:en-US\\html.txt_",
"isSourcename": false"xyz.html",
"canDocSet": true, "canDocDownloadisdir": truefalse,
"canDocPreview": true, "canAttSetexists": true,
"dvrequired": false,
"dvapprovedreadonly": truefalse,
"document": { "folderdate": "doc:zh-Hans2017-04-03T15:06:34.2892225Z",
"namesize": "html-out.txt",11997,
"isdirscanned": falsetrue,
"existscanPreview": true,
"readonly": false, }
"date": "2017-02-07T14:09:21.9940303Z" ],
"sizefolders": [
25, "scanned": true
},
{
"attachments": { "folder": "att:zhen-HansUS\\html.txt_\\folder1",
"name": "folder1",
"isdir": true,
"exists": true,
"readonly": false,
"date": "2017-0204-06T1405T07:5153:5502.7070816Z523813Z",
"size": null,
"scanned": true,
" "files": [],
"folders": [ {
{ "folder": "att:zhen-HansUS\\html.txt_\\folder1",
"name": "NewFolderdocument.docx",
"isdir": truefalse,
"exists": true,
"readonly": false,
"date": "2017-0204-07T1405T07:0752:3853.8219265Z8390226Z",
"size": null11997,
"scanned": true,
"files "canPreview": [false
{}
"folder": "att:zh-Hans\\html.txt_\\NewFolder"],
"namefolders": "NoBOMTest3.txt", []
}
"isdir": false, ]
}
},
"existszh-Hans": true,{
"locale": "zh-Hans",
"readonlyisSource": false,
"canDocSet": true,
"datecanDocDownload": "2017-02-06T14:52:00.3383798Z"true,
"canDocPreview": true,
"sizecanAttSet": 25true,
"dvrequired": false,
"scanneddvapproved": true,
"document": {
} ],
"folder": "doc:zh-Hans",
"name": "html-out.txt",
"isdir": false,
"exists": false,
"readonly": true,
"date": null,
"size": null,
"scanned": true,
"canPreview": false
},
"attachments": {
"folder": "att:zh-Hans\\html.txt_",
"name": "",
"isdir": true,
"exists": true,
"readonly": false,
"date": "2017-02-06T14:51:55.7070816Z",
"size": null,
"scanned": true,
"files": [],
"folders": [
{
"folder": "att:zh-Hans\\html.txt_\\NewFolder",
"name": "NewFolder",
"isdir": true,
"exists": true,
"readonly": false,
"date": "2017-02-07T14:07:38.8219265Z",
"size": null,
"scanned": true,
"files": [
{
"folder": "att:zh-Hans\\html.txt_\\NewFolder",
"name": "NoBOMTest3.txt",
"isdir": false,
"exists": true,
"readonly": false,
"date": "2017-02-06T14:52:00.3383798Z",
"size": 25,
"scanned": true,
"canPreview": false
}
],
"folders": []
}
]
}
}
},
"rm": null,
"previewers": {
"MsgReader": {
"enabled": true
},
"Browser": {
"enabled": true
},
"CodeMirror": {
"enabled": true
},
"Beebox": {
"enabled": false
},
"MicrosoftLive": {
"enabled": true
},
"Frontlab": {
"enabled": false
}
},
"previewersCanEnable": true,
"encodings": [
{
"v": "UTF-8",
"t": "UTF-8"
},
{
"v": "UTF-16",
"t": "UTF-16"
},
{
"v": "ISO-8859-1",
"t": "ISO-8859-1"
},
{
"v": "WINDOWS-1252",
"t": "WINDOWS-1252"
},
{
"v": "US-ASCII",
"t": "US-ASCII"
},
{
"v": "MACINTOSH",
"t": "MACINTOSH"
},
{
"v": "IBM850",
"t": "IBM850"
},
{
"v": "ISO-8859-6",
"t": "ISO-8859-6"
},
{
"v": "WINDOWS-1256",
"t": "WINDOWS-1256"
},
{
"v": "X-MAC-ARABIC",
"t": "X-MAC-ARABIC"
},
{
"v": "ASMO-708",
"t": "ASMO-708"
},
{
"v": "DOS-720",
"t": "DOS-720"
},
{
"v": "ISO-8859-4",
"t": "ISO-8859-4"
},
{
"v": "WINDOWS-1257",
"t": "WINDOWS-1257"
},
{
"v": "IBM775",
"t": "IBM775"
},
{
"v": "IBM500",
"t": "IBM500"
},
{
"v": "ISO-8859-2",
"t": "ISO-8859-2"
},
{
"v": "WINDOWS-1250",
"t": "WINDOWS-1250"
},
{
"v": "IBM852",
"t": "IBM852"
},
{
"v": "X-MAC-CE",
"t": "X-MAC-CE"
},
{
"v": "EUC-CN",
"t": "EUC-CN"
},
{
"v": "GB2312",
"t": "GB2312"
},
{
"v": "HZ-GB-2312",
"t": "HZ-GB-2312"
},
{
"v": "X-MAC-CHINESESIMP",
"t": "X-MAC-CHINESESIMP"
},
{
"v": "BIG5",
"t": "BIG5"
},
{
"v": "X-CHINESE-CNS",
"t": "X-CHINESE-CNS"
},
{
"v": "X-CHINESE-ETEN",
"t": "X-CHINESE-ETEN"
},
{
"v": "X-MAC-CHINESETRAD",
"t": "X-MAC-CHINESETRAD"
},
{
"v": "ISO-8859-5",
"t": "ISO-8859-5"
},
{
"v": "ISO-8859-9",
"t": "ISO-8859-9"
},
{
"v": "WINDOWS-1251",
"t": "WINDOWS-1251"
},
{
"v": "KOI8-R",
"t": "KOI8-R"
},
{
"v": "KOI8-U",
"t": "KOI8-U"
},
{
"v": "X-MAC-CYRILLIC",
"t": "X-MAC-CYRILLIC"
},
{
"v": "ISO-8859-7",
"t": "ISO-8859-7"
},
{
"v": "WINDOWS-1253",
"t": "WINDOWS-1253"
},
{
"v": "IBM737",
"t": "IBM737"
},
{
"v": "IBM869",
"t": "IBM869"
},
{
"v": "X-MAC-GREEK",
"t": "X-MAC-GREEK"
},
{
"v": "ISO-8859-8",
"t": "ISO-8859-8"
},
{
"v": "ISO-8859-8-I",
"t": "ISO-8859-8-I"
},
{
"v": "X-MAC-HEBREW",
"t": "X-MAC-HEBREW"
},
{
"v": "DOS-862",
"t": "DOS-862"
},
{
"v": "IBM861",
"t": "IBM861"
},
{
"v": "X-MAC-ICELANDIC",
"t": "X-MAC-ICELANDIC"
},
{
"v": "EUC-JP",
"t": "EUC-JP"
},
{
"v": "ISO-2022-JP",
"t": "ISO-2022-JP"
},
{
"v": "SHIFT_JIS",
"t": "SHIFT_JIS"
},
{
"v": "CSISO2022JP",
"t": "CSISO2022JP"
},
{
"v": "X-MAC-JAPANESE",
"t": "X-MAC-JAPANESE"
},
{
"v": "KS_C_5601-1987",
"t": "KS_C_5601-1987"
},
{
"v": "EUC-KR",
"t": "EUC-KR"
},
{
"v": "ISO-2022-KR",
"t": "ISO-2022-KR"
},
{
"v": "JOHAB",
"t": "JOHAB"
},
{
"v": "X-MAC-KOREAN",
"t": "X-MAC-KOREAN"
},
{
"v": "ISO-8859-3",
"t": "ISO-8859-3"
},
{
"v": "ISO-8859-15",
"t": "ISO-8859-15"
},
{
"v": "WINDOWS-874",
"t": "WINDOWS-874"
},
{
"v": "WINDOWS-1254",
"t": "WINDOWS-1254"
},
{
"foldersv": []"IBM857",
"t": "IBM857"
},
{
]"v": "WINDOWS-1258",
}"t": "WINDOWS-1258"
}
}]
} |
...