Segment (Object)

The sequential ID of the segment in the document. It consists of the "paragraph" number and an optional sub-segment number.

Applies to project resources/memories only. With translation memories and termbases this field has no meaning.

Examples:

For example, a document with 3 segments uses "1", "2" and "3".

If the second segment is split into 3 sub-segments, the numbers will be "1", "2", "2-2", "2-3" and "3".

Format:

"no" is constructed from the "bsid" and "bssid" fields described below and using this formula:

Note: We use the term "paragraph" to denote a segment including all its sub-segments. This may be a paragraph in a Word document that may or may not be split on sentence level into one or more sub-segments.

The globally unique ID of the segment. Use this id and not "no" to uniquely identify a segment within your platform.

The globally unique resource ID. We sometimes refer to this as the "document set id", a term we use internally at Wordbee.

A resource has zero or more documents, which each have zero or more segments.

A numeric index denoting a sub-section of a document. The index starts at 0. If a document consists of sections such as slides in a Powerpoint file, then this is the index of the section or slide. When translating Word files, the sections are (among others) the "header", "body" and "footer".

The context of the segment. It typically contains information of the paragraphs style.

Microsoft Word files: "Heading 1", "Heading 2", "Footnote"

Microsoft Excel: "Cell 2,3"

HTML: "p", "script", ...

This field can be edited by users, see below.

A list of labels assigned to the segment. Note that labels need to be configured by the administrator under "Settings" > "Labels" > "Segments".

Each array element has these properties:

• id: The unique ID of the label (int)
• value: The assigned label value (string)
• sav: A boolean which is true if the label value was never explicitly assigned but the value is configured to be "sticky" (i.e. shown by default)

If there is no label, the array is empty.

Indicates if labels can be edited. With the labels specifications you further obtain an information which labels exist, which options and for which labels editing rights are revoked.

If false, editing is prohibited.

A list of segment level custom fields, that is custom fields not assigned to a specific language but globally to the segment.

Each array element has these properties:

• id: The ID of the custom field (int). IDs start at 1.
• val: The field value (string)

If there is no custom field, the array is empty.

Indicates if custom fields can be edited. With the custom field specifications you further obtain an information which custom fields are configured and which are editable.

If false, editing is prohibited.

An object containing all the column values as defined in the layout.

A column may contain the English source text, another the Spanish translation, another comments, another the status of translation, another all the revisions, etc.

See below for details.

The actual data in the column. The structure depends on the column type:

• bk - Bookmark
• cm - Comments
• ctx - Segment context
• cf - Custom field
• lbl - Label
• ed - Last editor
• lck - Lock status
• hits - Memory hits
• cmnew - New comment box
• revs - Revision history
• st - Status
• txt - Text (source and translation)
• err - Q&A error details

Example:

"cols": {
		"_0": { 
			"column": 0,
			"bk": 1				// Bookmark is "blue"
			"bk_edit": true
		}
}

The different column types are explained in the next chapters.

Indicates if the column is editable.

Example:

"cols": {
		"_0": { 
			"bk_edit": true
			...

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark

Numeric source or translation status:

• 0 = none
• 1 = green status
• 2 = red status

"lock" status:

• false = properties in language not locked for editing
• true = properties in language locked for editing

Numeric "last editor" status.

See Last Editor (Enumeration)

Last Q&A error for a text. 

Null or context. 

JSON object with properties, see below. 

The text (source text or a translation) 

The translation status:

• 0 = none
• 1 = green status
• 2 = red status

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark

If the text was edited in the framework of a job, stores the type of job (the task code).

Examples:

• TR: Translation
• RV: Revision

Please note that task codes are customizable.

If the translation was obtained from a memory pre-translation then this is the degree of similarity. For example, 110 stands for perfect pretranslation.

0 = no pre-translation.

Numeric "lock" status:

• false = properties in language not locked for editing
• true = properties in language locked for editing

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark

Numeric bookmark status:

• 0 = none
• 1 = blue bookmark
• 2 = red bookmark