Segment Change (Object)

A JSON object that represents 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 of the segment.

False if this is an older version.

bool
locThe locale for which the change was done.string
dt

Date of change.

datetime
uidThe person ID who edited this version. Null if 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?
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


{
	"ty": "text",
	"current": true,
	"val": "Corrected translation",
	"tsk": null,
	"ed": 1,
	"dt": "2017-04-07T07:39:11.2253404Z",
	"uid": null,
	"loc": "en",
    "sim": null
},
{
	"ty": "text",
	"current": false,
	"val": "Corrected translation",
	"tsk": null,
	"ed": 1,
	"dt": "2017-04-07T07:39:11.2253404Z",
	"uid": null,
	"loc": "en",
    "sim": null
},
{
	"ty": "flags",
	"current": true,
	"tsk": null,
	"dt": "2017-02-14T09:42:50.0220044Z",
	"uid": 7,
	"loc": "en",
	"st": 1,
	"bk": 0,
    "sim": null
}

   
 

Copyright Wordbee - Buzzin' Outside the Box since 2008