Analysis

Analysis are always related to a translationTask. Each translationTask can have multiple analysis. When creating an analysis the system will process your request and ask TCM to analyse all sourceDocuments of the given translation task in all given language combinations. TCM will use the translation memory that is configured for your organization.

Endpoints

Method URI
GET /rest/api/analysis/{analysis_id}
POST /rest/api/analysis/

Default Schema

{
  "_id": "LFtaFrBA9HQcoNvqy",
  "translationTaskId": "57713b7e0f627d65ba122cef",
  "createdAt": "2017-03-21T15:26:19.790Z",
  "updatedAt": "2017-03-21T15:30:45.850Z",
  "state": "ANALYZED",
  "response": {
    "en-GB": {
      "resultTotal": "<<RESULT>>",
      "resultsByDocument": [
        "<<RESULT>>"
      ]
    },
    "ab-GE": {
      "resultTotal": "<<RESULT>>",
      "resultsByDocument" : [
        "<<RESULT>>"
      ]
    }
  },
  "error": null
}

Properties

Property Writeable Value
id readonly The id that identifies the analysis.
createdAt readonly The date when the analysis has been created. The date time will be provided as ISO 8601 date format.
updatedAt readonly The date when the analysis has been updated. This happens when the analysis results from the tm-analysis are saved.
translationTaskId readonly The unique id of the TranslationTask the analysis is associated with.
response readonly The response to the analysis request, aka the result.
state readonly The state of a quote. The state can be:
REQUESTED
The analysis for the documents of the translationTask are requested.
ANALYZED
All documents of the translationTask were analyzed.
ERROR
An error occurred during the analysis of the documents.
error readonly If there is an error with the analysis.

Analysis Result: resultTotal / resultsByDocument

{
  "numSegments100" : 0,
  "numSegments98" : 0,
  "numSegments85" : 0,
  "numSegments75" : 0,
  "numSegments50" : 0,
  "numSegmentsRepeated" : 0,
  "numSegmentsNoMatch" : 0,
  "numSegmentsTotal" : 9,
  "percentage100" : 0,
  "percentage98" : 0,
  "percentage85" : 0,
  "percentage75" : 0,
  "percentage50" : 0,
  "percentageNoMatch" : 0,
  "percentageRepeated" : 0,
  "numCharacters100" : 0,
  "numCharacters98" : 0,
  "numCharacters85" : 0,
  "numCharacters75" : 0,
  "numCharacters50" : 0,
  "numCharactersNoMatch" : 0,
  "numCharactersRepeated" : 0,
  "numCharactersTotal" : 9,
  "numWords100" : 0,
  "numWords98" : 0,
  "numWords85" : 0,
  "numWords75" : 0,
  "numWords50" : 0,
  "numWordsRepeated" : 0,
  "numWordsNoMatch" : 0,
  "numWordsTotal" : 91,
  "numPlaceables100" : 0,
  "numPlaceables98" : 0,
  "numPlaceables85" : 0,
  "numPlaceables75" : 0,
  "numPlaceables50" : 0,
  "numPlaceablesRepeated" : 0,
  "numPlaceablesNoMatch" : 0,
  "numPlaceablesTotal" : 0
}

resultTotal / resultsByDocument

Property Value
Property Value
numSegments100 Number of segments that are 100% matches.
numSegments98 Number of segments that are 98% matches.
numSegments85 Number of segments that are 85% matches.
numSegments75 Number of segments that are 75% matches.
numSegments50 Number of segments that are 50% matches.
numSegmentsRepeated Number of segments that are repetitions.
numSegmentsNoMatch Number of segments that don't have matches in the TM.
numSegmentsTotal Total number of segments.
percentage100 Percentage of 100% matched segments.
percentage98 Percentage of 98% matched segments.
percentage85 Percentage of 85% matched segments.
percentage75 Percentage of 75% matched segments.
percentage50 Percentage of 50% matched segments.
percentageNoMatch Percentage of not matches segments.
percentageRepeated Percentage of repeated segments.
numCharacters100 Number of characters in 100% matched segments.
numCharacters98 Number of characters in 98% matched segments.
numCharacters85 Number of characters in 85% matched segments.
numCharacters75 Number of characters in 75% matched segments.
numCharacters50 Number of characters in 50% matched segments.
numCharactersNoMatch Number of characters in not matched segments.
numCharactersRepeated Number of characters in repeated segments.
numCharactersTotal Total Number of segments.
numWords100 Number of words in 100% matched segments.
numWords98 Number of words in 98% matched segments.
numWords85 Number of words in 85% matched segments.
numWords75 Number of words in 75% matched segments.
numWords50 Number of words in 50% matched segments.
numWordsRepeated Number of words in repeated segments.
numWordsNoMatch Number of words in not matched segments.
numWordsTotal Total number of words.
numPlaceables100 Number of placeables in 100% matched segments.
numPlaceables98 Number of placeables in 98% matched segments.
numPlaceables85 Number of placeables in 85% matched segments.
numPlaceables75 Number of placeables in 75% matched segments.
numPlaceables50 Number of placeables in 50% matched segments.
numPlaceablesRepeated Number of placeables in repeated segments.
numPlaceablesNoMatch Number of placeables in not matched segments.
numPlaceablesTotal Total number of placeables.

Description of Endpoints

get:/rest/api/analysis/{analysis_id}

Gets a analysis by a it's id.

Example Request:

GET /rest/api/analysis/577135d30f627d65ba122ce8 HTTP/1.1

Example Response:

{
  "_id": "LFtaFrBA9HQcoNvqy",
  "translationTaskId": "57713b7e0f627d65ba122cef",
  "createdAt": "2017-03-21T15:26:19.790Z",
  "updatedAt": "2017-03-21T15:30:45.850Z",
  "state": "ANALYZED",
  "response": {
    "en-GB": {
      "resultTotal": "<<RESULT>>",
      "resultsByDocument": [
        "<<RESULT>>"
      ]
    },
    "ab-GE": {
      "resultTotal": "<<RESULT>>",
      "resultsByDocument" : [
        "<<RESULT>>"
      ]
    }
  },
  "error": null
}

post:/rest/api/analysis/

Creates and requests a new analysis for a TranslationTask.

Example Request:

POST /rest/api/analysis/ HTTP/1.1

{
  "translationTaskId": "HSfoW7ZAnj7vM3Fru"
}

Example Response:

{
  "_id": "LFtaFrBA9HQcoNvqy",
  "translationTaskId": "57713b7e0f627d65ba122cef",
  "createdAt": "2017-03-21T15:26:19.790Z",
  "updatedAt": "2017-03-21T15:30:45.850Z",
  "state": "ANALYZED",
  "response": {
    "en-GB": {
      "resultTotal": "<<RESULT>>",
      "resultsByDocument": [
        "<<RESULT>>"
      ]
    },
    "ab-GE": {
      "resultTotal": "<<RESULT>>",
      "resultsByDocument" : [
        "<<RESULT>>"
      ]
    }
  },
  "error": null
}