Beebox JSON Format

Beebox uses JSON in these places:

To export translation jobs to translation teams or translation management systems.
To download selected segments from the translation editor.
When retrieving segments with the API.

Example

The following is a sample translation job containing one segment with a translation and one without.

{ "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	Attribute	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	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.