Page Comparison

comments

An array of all comments of the segment, sorted by descending date.

It includes comments in all the scope languages to which the user has access.

See Comment (Object) for details.

An array of all text and flag changes of the segment, sorted by descending date.

These are notably changes of the texts by different workers over time.

See Segment Change (Object) for details.

An object containing the persons referred to by comments or revisions. Note:

• Excludes persons contained in parameter knownpersons.
• Excludes persons that the user cannot see. There is an access right to prevent a user from viewing user and company names.

The object has keys where the key is the person id.

"persons": {
    "_7": {
      "id": 7,
      "nm": "Stephan",
      "cid": 1,
      "cnm": "Tradubee"
    },
    "_3": {
      "id": 3,
      "nm": "Thierry",
      "cid": 1,
      "cnm": "Freelancebee"
    }

• nm: Full name of person
• id: Id of person
• cnm: Company of person
• cid: Company id

A list of all locales available for this segment and which are within the scope. You can use these in a comments/revisions language filter.

A few access rights that are specifically useful when working with the results:

• canSendEmail: When a user adds/edits a comment, this boolean tells if the user can notify the comment by email or not.
• canAdd: Tells if the user can add a new comment in one of the locales.

Note: When using the APIs to add/edit/delete comments, you may obtain a not authorized information even when the edit, canAdd or canSendEmail properties are true. The reason for this is that further detailed access rights check are done upon those advanced operations.

strings

Object that contains names of companies, persons and task codes that are referenced by this report. We include this purely for convenience so that you do not need to issue more calls to get the names. Properties:

• companies: Array of object each with company id ("id") and name ("name")
• persons: Array of object each with company id ("id") and name ("name")
• tasks: Array of object each with task code ("id") and name ("name")

Contains work volume information with totals and individually for each type of job and month:

• totals: An object with grand totals:
  • task: Always null
  • jobs: Total jobs
  • documents: Total documents in jobs
  • segments: Total segments in jobs
  • words: Total words
  • chars: Total characters
  • wdpreident: Total identically pretranslated words
  • wdprefuzzy: Total fuzzy pretranslated words
  • wdfuzzy: Total fuzzy matches or repetitions

• tasks: An array that shows the above information individually per job task type. For example if the supplier translated and revised, you will see totals for translation jobs and totals for revision jobs.

• months: Shows totals per each month in the selected date range. Each array element has these properties:
  • title: The year and month as a string
  • jobs: Total jobs in month
  • words: Total words in month
  • chars: Total chars in month

Also see example at the end of this page.