Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Gets a business analytical oriented view into all translations on edits of a document for a specific target language.

Provides details on:

  • Who edited how many text
  • Time spent with translations and edits
  • Quality metrics

...

The message body contains a JSON object:

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!

didThe document id.
dsidThe document set id.
nameThe name of the original file (including folders).
localesA dictionary where the key is a locale and the value is an object with files details in this language, see below.
previewersA 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.
previewersCanEnableBoolean. 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.
encodingsAn 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.

 

Each item in locales has these properties:

locale

The locale.

isSourceTrue: This is the source language.
 Source file or deliverable related properties
dvrequiredBoolean. 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).
dvapprovedBoolean. 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.
canDocSetBoolean. Tells if the deliverable can be set, renamed or deleted.
canDocDownload

Boolean. Right to download the file.

canDocPreviewBoolean: Right to web preview the file.
documentA file node describing the document.
 Attachments
canAttSetBoolean. User can set, rename, delete, manipulate attachments.
attachmentsA folder node that contains the attachments.

 

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

nameName of file or folder
folderInternal identifier of the parent node. Folder IDs are required when manipulating files.
existsBoolean. 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.
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.

dateFile/folder date. Null if not exists.
sizeFile/folder date. 0 if file/folder not exists.
  
 File nodes only
canPreview

Boolean. If true then the file can potentially be previewed in the browser. Use these methods for previewing:

  • resources/files/details : Get exact information on how to preview this file. This will tell if preview is "really" possible and which parameters such as encoding information needs to be supplied to the preview method below.
  • resources/files/preview : Obtain a URL to preview file online
  
 Folder nodes only
scannedTells if the sub folders have been loaded. Ths is related to the populateDepth parameter.
filesOnly exists if isdir is true. Array of file nodes contained in the present folder node.
foldersOnly exists if isdir is true. Array of folder nodes contained in the present folder node.
  

 

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,
        "canPreview": false
      },
      "attachments": {
        "folder": "att:en-US\\html.txt_",
        "name": "",
        "isdir": true,
        "exists": true,
        "readonly": false,
        "date": "2017-04-05T07:53:11.3225939Z",
        "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
          },
          {
            "folder": "att:en-US\\html.txt_",
            "name": "xyz.html",
            "isdir": false,
            "exists": true,
            "readonly": false,
            "date": "2017-04-03T15:06:34.2892225Z",
            "size": 11997,
            "scanned": true,
            "canPreview": true
          }
        ],
        "folders": [
          {
            "folder": "att:en-US\\html.txt_\\folder1",
            "name": "folder1",
            "isdir": true,
            "exists": true,
            "readonly": false,
            "date": "2017-04-05T07:53:02.523813Z",
            "size": null,
            "scanned": true,
            "files": [
              {
                "folder": "att:en-US\\html.txt_\\folder1",
                "name": "document.docx",
                "isdir": false,
                "exists": true,
                "readonly": false,
                "date": "2017-04-05T07:52:53.8390226Z",
                "size": 11997,
                "scanned": true,
                "canPreview": false
              }
            ],
            "folders": []
          }
        ]
      }
    },
    "zh-Hans": {
      "locale": "zh-Hans",
      "isSource": false,
      "canDocSet": true,
      "canDocDownload": true,
      "canDocPreview": true,
      "canAttSet": true,
      "dvrequired": false,
      "dvapproved": 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": []
          }
        ]
      }
    }
  },
  "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"
    },
    {
      "v": "IBM857",
      "t": "IBM857"
    },
    {
      "v": "WINDOWS-1258",
      "t": "WINDOWS-1258"
    }
  ]
}

 

 

 

{  "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,        "canPreview": false      },      "attachments": {        "folder": "att:en-US\\html.txt_",        "name": "",        "isdir": true,        "exists": true,        "readonly": false,        "date": "2017-04-04T09:25:15.4282486Z",        "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          },          {            "folder": "att:en-US\\html.txt_",            "name": "stephan1.zip",            "isdir": false,            "exists": true,            "readonly": false,            "date": "2017-02-16T09:21:42.0299691Z",            "size": 5368,            "scanned": true,            "canPreview": false          },          {            "folder": "att:en-US\\html.txt_",            "name": "xyz.html",            "isdir": false,            "exists": true,            "readonly": false,            "date": "2017-04-03T15:06:34.2892225Z",            "size": 11997,            "scanned": true,            "canPreview": true          }        ],        "folders": [          {            "folder": "att:en-US\\html.txt_\\folder1",            "name": "folder1",            "isdir": true,            "exists": true,            "readonly": false,            "date": "2017-02-16T09:21:19.2557227Z",            "size": null,            "scanned": true,            "files": [              {                "folder": "att:en-US\\html.txt_\\folder1",                "name": "Html replace term.config",                "isdir": false,                "exists": true,                "readonly": false,                "date": "2017-02-16T09:21:19.2557227Z",                "size": 11997,                "scanned": true,                "canPreview": false              }            ],            "folders": [              {                "folder": "att:en-US\\html.txt_\\folder1\\sub",                "name": "sub",                "isdir": true,                "exists": true,                "readonly": false,                "date": "2017-02-15T07:55:17.4403201Z",                "size": null,                "scanned": true,                "files": [                  {                    "folder": "att:en-US\\html.txt_\\folder1\\sub",                    "name": "sub.config",                    "isdir": false,                    "exists": true,                    "readonly": false,                    "date": "2017-02-15T07:55:15.089319Z",                    "size": 11997,                    "scanned": true,                    "canPreview": false                  }                ],                "folders": []              }            ]          },          {            "folder": "att:en-US\\html.txt_\\folder2",            "name": "folder2",            "isdir": true,            "exists": true,            "readonly": false,            "date": "2017-02-15T07:55:02.8362808Z",            "size": null,            "scanned": true,            "files": [],            "folders": []          },          {            "folder": "att:en-US\\html.txt_\\stephan1",            "name": "stephan1",            "isdir": true,            "exists": true,            "readonly": false,            "date": "2017-02-16T09:22:50.1502032Z",            "size": null,            "scanned": true,            "files": [              {                "folder": "att:en-US\\html.txt_\\stephan1",                "name": "Html replace term.config",                "isdir": false,                "exists": true,                "readonly": false,                "date": "2017-02-16T09:22:50.1492033Z",                "size": 11997,                "scanned": true,                "canPreview": false              }            ],            "folders": [              {                "folder": "att:en-US\\html.txt_\\stephan1\\folder1",                "name": "folder1",                "isdir": true,                "exists": true,                "readonly": false,                "date": "2017-02-16T09:22:50.1462008Z",                "size": null,                "scanned": true,                "files": [                  {                    "folder": "att:en-US\\html.txt_\\stephan1\\folder1",                    "name": "Html replace term.config",                    "isdir": false,                    "exists": true,                    "readonly": false,                    "date": "2017-02-16T09:22:50.1151703Z",                    "size": 11997,                    "scanned": true,                    "canPreview": false                  }                ],                "folders": [                  {                    "folder": "att:en-US\\html.txt_\\stephan1\\folder1\\sub",                    "name": "sub",                    "isdir": true,                    "exists": true,                    "readonly": false,                    "date": "2017-02-16T09:22:50.1482022Z",                    "size": null,                    "scanned": true,                    "files": [                      {                        "folder": "att:en-US\\html.txt_\\stephan1\\folder1\\sub",                        "name": "sub.config",                        "isdir": false,                        "exists": true,                        "readonly": false,                        "date": "2017-02-16T09:22:50.1462008Z",                        "size": 11997,                        "scanned": true,                        "canPreview": false                      }                    ],                    "folders": []                  }                ]              }            ]          }        ]      }    },    "zh-Hans": {      "locale": "zh-Hans",      "isSource": false,      "canDocSet": true,      "canDocDownload": true,      "canDocPreview": true,      "canAttSet": true,      "dvrequired": false,      "dvapproved": 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": []          }        ]      }    }  },  "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"    },    {      "v": "IBM857",      "t": "IBM857"    },    {      "v": "WINDOWS-1258",      "t": "WINDOWS-1258"    }  ]

segments

An object with various segment counts:

  • total: Total
  • error: With error status
  • ok: With OK status
  • missing: Without translation
  • filled: With translation
words

An object with various word counts:

  • total: Total
  • error: With error status
  • ok: With OK status
  • missing: Without translation
  • filled: With translation
dtfirstFirst edit date in document. Null if none.
dtfirsttFirst edit date as a string.
dtlastLast edit date in document. Null if none.
dtlasttLast edit date as a string.
scores

An array of document level scores. See table below.
editors

Provides statistics per "last editor" (human edit, pre-translation, MT, etc.).

See table below.

workers

Provides statistics per worker who edited at least one segment.

See table below.

 

Editors node

The editors element is an array of objects with these properties.

Note that the last array element contains the grand totals.

editor

An internal code for the type of editor.

titleTitle of editor.
segments

An object with various segment counts:

  • initial: Total that had this editor initially (when marking a document for translation)
  • current: Total that have this editor now.
  • unchanged: Total that had this editor and still have now.
  • translation: Total translated.
  • postEditing: Total post edited.
  • revision: Total revised
words

An object with various word counts:

  • initial: Total that had this editor initially (when marking a document for translation)
  • current: Total that have this editor now.
  • unchanged: Total that had this editor and still have now.
  • translation: Total translated.
  • postEditing: Total post edited.
  • revision: Total revised
actionsTotal of interventions
actionsCorrectionsTotal of interventions correcting a previous text
scoresAn array of document level scores. See table below.

 

Workers node

The workers element is an array of objects with these properties.

Note that the last array element contains the grand totals.

pid

Person ID. Null if current user is not authorized to see this.

cidCompany ID. Null if current user is not authorized to see this.
pnamePerson name. Null if current user is not authorized to see this.
pcodePerson code. Null if current user is not authorized to see this.
cnameCompany name. Null if current user is not authorized to see this.
  
segments

An object with various segment counts:

  • total: Total texts edited by this person
  • corrected: Total texts edited by this person and which were subsequently corrected/edited by someone else. 
  • translation: Total texts translated by user from scratch.
  • postEditing: Total texts post-edited by user (from a memory or MT pre-translation).
  • revision: Total texts revised by user (i.e. user edited a human translation/edit done by someone else)
words

An object with various word counts:

  • total: Total texts edited by this person
  • corrected: Total texts edited by this person and which were subsequently corrected/edited by someone else. 
  • translation: Total texts translated by user from scratch.
  • postEditing: Total texts post-edited by user (from a memory or MT pre-translation).
  • revision: Total texts revised by user (i.e. user edited a human translation/edit done by someone else)
dtfirstFirst edit date in document.
dtfirsttFirst edit date as a string.
dtlastLast edit date in document.
dtlasttLast edit date as a string.
scoresAn array of document level scores. See table below.

 

Scores node

Each scores element contains an array of objects with these properties:

title

Print title for score.

valueDecimal value of score.
unitNull or the unit of the scroe. For example "%" with percentages.
descA description of the score.
maxThe maximum value the score can have.

 

EXAMPLES

See this example:

Code Block
{
  "segments": {
    "error": 0,
    "ok": 0,
    "missing": 0,
    "filled": 4,
    "total": 4
  },
  "words": {
    "error": 0,
    "ok": 0,
    "missing": 0,
    "filled": 8,
    "total": 8
  },
  "dtfirst": "2017-02-06T07:09:09.8944871Z",
  "dtlast": "2017-02-06T07:09:22.4785955Z",
  "dtfirstt": "06/02/2017 08:09 UTC+1",
  "dtlastt": "06/02/2017 08:09 UTC+1",
  "editors": [
    {
      "editor": "None",
      "title": "Not translated",
      "segments": {
        "initial": 4,
        "unchanged": 0,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "words": {
        "initial": 8,
        "unchanged": 0,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "Actions": 4,
      "ActionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "editor": "RefMaterialIdentical",
      "title": "Pre-translation Exact",
      "segments": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "words": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "Actions": 0,
      "ActionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": null,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "editor": "RefMaterialFuzzy",
      "title": "Pre-translation Fuzzy",
      "segments": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "words": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "actions": 0,
      "actionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": null,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "editor": null,
      "title": "TOTAL",
      "segments": {
        "initial": 4,
        "unchanged": 0,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "current": 4
      },
      "words": {
        "initial": 8,
        "unchanged": 0,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "current": 8
      },
      "actions": 4,
      "actionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    }
  ],
  "workers": [
    {
      "pid": 7,
      "cid": 1,
      "pname": "Stephan Bohmig",
      "pcode": "SB",
      "cname": "Pons",
      "segments": {
        "total": 4,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "words": {
        "total": 8,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "dtfirst": "2017-02-06T07:09:09.8944871Z",
      "dtlast": "2017-02-06T07:09:22.4785955Z",
      "dtfirstt": "06/02/2017 08:09 UTC+1",
      "dtlastt": "06/02/2017 08:09 UTC+1",
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "pid": 0,
      "cid": 0,
      "pname": "TOTAL",
      "pcode": "TOTAL",
      "cname": null,
      "segments": {
        "total": 4,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "words": {
        "total": 8,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "dtfirst": "2017-02-06T07:09:09.8944871Z",
      "dtlast": "2017-02-06T07:09:22.4785955Z",
      "dtfirstt": "06/02/2017 08:09 UTC+1",
      "dtlastt": "06/02/2017 08:09 UTC+1",
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    }
  ],
  "scores": [
    {
      "title": "Completed",
      "value": 100.0,
      "unit": "%",
      "desc": "Percentage translations supplied and not marked errorneous.",
      "max": 0.0
    },
    {
      "title": "Human translation quality",
      "value": 10.0,
      "unit": null,
      "desc": "0 out of 4 human translated or post-edited segments required correction.",
      "max": 10.0
    },
    {
      "title": "Pre-translated",
      "value": null,
      "unit": "%",
      "desc": "No segments are pre-translated by machine or from memories to calculate score.",
      "max": 0.0
    },
    {
      "title": "Pre-translation quality",
      "value": null,
      "unit": null,
      "desc": "No segments are pre-translated by machine or from memories to calculate score.",
      "max": 10.0
    },
    {
      "title": "Overall Efficiency",
      "value": 5.0,
      "unit": null,
      "desc": "4 segments required a total of 4 human interventions.",
      "max": 10.0
    }
  ]
}