Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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
}

 

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

 

skip

The number of items skipped. Used for pagination. Always 0 except when using pagination in the API.

countTotal 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.

fiThe source file name including relative path.
foNot 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.

Read about meta information.

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.

sindexA sequential id assigned to the segment within the file.
txThe source text.
txa

The text right after the present segment inside the original file. This is the context.

txbThe 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.

edA code indicating the origin of a translation, if any.
lkThe 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  

txThe translation. Null is no translation.
txaThe translation of the source text right after the present segment inside the original file. This is the context.
txbThe translation of the source text right before the present segment inside the original file. This is the context.
updThe date when the translation or its properties were last updated.
valThe translation currently is approved or not

 

 

 

  • No labels