Versions Compared

Key

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

A JSON object that represents a version the history of a segment text. Whenever, a text is edited (by a different user than the previous one) the system logs the change.

PROPERTIES

...

ty

The type of revision:

  • text: The event refers to a change of the text (revision)
  • flags: The event refers to a change of either the status or bookmark


string
current

True if this event refers to the current version. The properties are then those of the current version.

For example, if the text in val is the current actual text

version

of the segment.

False if this is an older version.

bool

val

The text.

string
locThe locale
of the text
for which the change was done.string
dt

Date of change.

datetime
pid
uidThe person ID who edited this version. Null if
text was not edited by a user but is either empty or a pretranslation.int?edLast editor type (none, pretranslation, human edit...). See list of possible values.int
set by machine or connected user has no right to see the user details.int?
tskOptional task code. If the comment was added in the framework of a job, then this includes the task code of the job. Otherwise null.string?
flgdtOnly set when current is true. Last change of either status or bookmark.datetime?flgpidOnly set when current is true. User who changed status or bookmark.int?

 

EXAMPLES

 

piOptional person initials. Null if set by machine.string?




Properties used only with "text" events
valThe text.string
edLast editor type (none, pretranslation, human edit...). See Last Editor (Enumeration)int?
mtidIf a machine translation then this (may) contain the MT profile ID used.int?
mk

Null or an array of text ranges that differ from the preceding or succeeding text version (this depends on the algorithm chosen in the method that yields this object).

"mk" is null if there are no differences.

If there is at least one difference, the array contains these objects:

  • p: First position of range (0 or above).
  • l: Length of range (1 or above)
  • mt: Strength of difference:
    • 1 = major difference (use strike-out style)
    • 2 = medium difference (use yellow background color)
    • 3 = small difference (use gray background color)
array?<int>
simIf text is a pretranslation then this property indicates the degree of similarity (110, 100, 95 etc.).byte?

Properties used only with "flags" events
stThe status: 0 = none, 1 = OK/green, 2 = error/redint
bkThe bookmark value: 0 = none, 1 = blue, 2 = redint


EXAMPLES


Code Block
{
	"ty": "text",
	"current": true,
      	"val": "Corrected translation",
      	"tsk": null,
      	"ed": 1,
      	"dt": "2017-04-07T07:39:11.2253404Z",
	"uid": null,
	"loc": "en",
    "pidsim": null
},
{
	"ty": "text",
	"current": false,
 	"locval": "enCorrected translation",
	"tsk": null,
	"ed": 1,
  	"flgdtdt": "2017-04-07T07:5039:4111.6683829Z2253404Z",
	"uid":      "flgpidnull,
	"loc": 7"en",
    }
 

    {
      "current"sim": falsenull
},
{
     "val	"ty": "Testword1flags",
      "tsk	"current": nulltrue,
      "ed	"tsk": 1null,
      	"dt": "2017-02-14T09:4742:5950.0990044Z0220044Z",
      "pid	"uid": 37,
      	"loc": "en",
	"st":      "flgdt1,
	"bk": null0,
 
    "flgpidsim": null
}

  },