...
Code Block | ||
---|---|---|
| ||
{ "count" : 5, "hasmore" : false, "rows" : [ { "source" : { "dt" : "2015-08-03T14:54:57.5306901Z", "fi" : "Machine Views\\RearView.png.xml", "fo" : "", "key" : "x-shape-bubble", "meta" : null, "rid" : null, "sindex" : 0, "tx" : "Rear Electronics Enclosure", "txa" : "Rear Viewer", "txb" : null }, "target" : { "cm" : null, "ed" : "◀Perfect previous version translation▶", "lk" : false, "loc" : "es-419", "st" : 2, "tr" : 1, "tx" : "Caja trasera de componentes electrónicos", "txa" : "Visor Trasero", "txb" : null, "upd" : "0001-01-01T00:00:00", "val" : false } }, { "source" : { "dt" : "2015-08-03T14:54:57.5306901Z", "fi" : "Machine Views\\RearView.png.xml", "fo" : "", "key" : "x-shape-bubble", "meta" : null, "rid" : null, "sindex" : 4, "tx" : "Air Filtration and Distribution", "txa" : null, "txb" : "Main Power CB" }, "target" : { "cm" : null, "ed" : "", "lk" : false, "loc" : "fr-FR", "st" : 0, "tr" : 0, "tx" : null, "txa" : null, "txb" : null, "upd" : "2015-08-03T14:54:57.5306901Z", "val" : false } } ], "skip" : 0 } |
Standard and custom attributes
The Beebox uses these attributes. Beebox custom attributes are prefixed with namespace "wb".
...
Xml node
...
File content
When exporting content to JSON, the file is always for one specific target language. It is not possible to retrieve multilingual content.
The file has these root properties:
Field | Description
| |
---|---|---|
xliff | wb:sender | Your company name. This is a Beebox specific extension to Xliff. |
xliff | wb:projectkey | The unique Beebox project id. This is a Beebox specific extension to Xliff. |
xliff | wb:jobname | The job name. This is a Beebox specific extension to Xliff. |
xliff | wb:jobkey | The job id. This is a Beebox specific extension to Xliff. |
file | datatype | Standard xliff attribute. Always contains “x-beebox”. |
file | original | The name and relative path of the original file. Example "folder1/game.docx" or "mypage.html". |
file | wb:file | The name of the original file, same as the “original” attribute. This is a Beebox specific extension to Xliff. |
file | wb:folder | Always empty. This is a Beebox specific extension to Xliff. |
file | tool-id | Standard xliff attribute. Contains “Beebox”. |
trans-unit | id | A sequential number assigned by the Beebox. |
trans-unit | wb:editor||
skip | The number of items skipped. Used for pagination. Always 0 except when using pagination in the API. | |
count | Total segments in file. | |
hasmore | "true" if the list is not complete. Used for pagination. Always "false" except when using pagination in the API. | |
rows | Array of segments. Each segment has two nodes: source: Detailed information on the segment and the source text. target: Information on the translation |
The source node has these attributes:
Field | Description
|
---|---|
dt | The date when this segment was extracted from the source file. Typically, this is done once per source file unless reprocessing is explicitly triggered from the UI or API. |
fi | The source file name including relative path. |
fo | Not used. |
key | Contextual information on the segment. Content is file format dependent. In Word this may say "Heading 1", in XML this may be content extracted from a node attribute, etc. |
meta | Any meta information that may have been extracted from the file or the instructions file. |
rid | Used when content is from a translation memory (and not from project or job). Otherwise null. Contains the alphanumeric ID of the translation memory. |
sindex | A sequential id assigned to the segment within the file. |
tx | The source text. |
txa | The text right after the present segment inside the original file. This is the context. |
txb | The text right before the present segment inside the original file. This is the context. |
The target node has these attributes:
Field | Description
| |
---|---|---|
cm | The date when this segment was extracted from the source file. Typically, this is done once per source file unless reprocessing is explicitly triggered from the UI or API. | |
ed | A code indicating the origin of a translation, if any. | This is a Beebox specific extension to Xliff.|
trans -unit | wb-words | Total source words of segment. This is a Beebox specific extension to Xliff. |
trans -unit | wb-key | Optional meta-information included with the original segment: Hyperlink, Footnote, etc. This is a Beebox specific extension to Xliff.|
lk | The translation is locked for editing by the user | |
loc | The target language code. | |
st | The Quality Assurance status: 0 = not set, 1 = QA Ok, 2 = QA Error | |
tr | Level of trust: 0 = no translation yet, 1 =Untrusted translation such as machine translation, 2 =Medium trusted translation, might require verification, 3 =Trusted translation | |
tx | The translation. Null is no translation. | |
txa | The translation of the source text right after the present segment inside the original file. This is the context. | |
txb | The translation of the source text right before the present segment inside the original file. This is the context. | |
upd | The date when the translation or its properties were last updated. | |
val | The translation currently is approved or not |