A JSON object that represents a segment with all data requested by the layout and to which a user has access. The object further includes information on what data can be edited.
PROPERTIES
| Identifiers | ||
| no | 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. | string |
| bsid | The paragraph sequential ID with the document. Starting at 1. | int |
| bssid | The sub-segment ID, starting at 0. 0 = first sub-segment, 1 = second sub-segment... | int |
| sid | The globally unique ID of the segment. Use this id and not "no" to uniquely identify a segment within your platform. | int |
| did | The globally unique document ID. Each segment is attached to exactly one document. If the underlying resource is a translation memory or termbase then the "document" is understood as a grouping of related segments. For example, all segments imported from a TMX are grouped together. | int |
| dsid | 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. | int |
| sdid | 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". | int |
| Segment level data | ||
| edit | General indicator if the segment can be edited or not. | |
| tags | Markup information. Contains the list of markup elements in the original text of the segment. This information is encoded. | string? |
| ctx | 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. | string |
| ctx_edit | Indicates if the "ctx" field can be edited. | bool |
| chmin | Minimum text length constraint. Null if none. Expressed in terms of characters, excluding markup. | int? |
| chmax | Maximum text length constraint. Null if none. Expressed in terms of characters, excluding markup. | int? |
| ch_edit | Indicates if the "chmin" and "chmax" fields can be edited. | bool |
| lbls | 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:
If there is no label, the array is empty. | object[] |
| lbl_edit | 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. | bool |
| cfs | 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:
If there is no custom field, the array is empty. | object[] |
| cf_edit | 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. | |
| cols | 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. | object[] |
Columns "cols"
Each column appears as a property named "_" + the index of the column:
"cols": {
"_0": { value of column #1 },
"_1": { value of column #2 },
"_2": { value of column #3 },
...
}
Each object has these properties.
| column | The column index starting at 0. | |
| (code)_edit | Indicates if the column is editable. "code" is an abbreviation of the data in this column:
| |
| (code) | The actual data in the column. The structure depends on the column type:
| int |
EXAMPLES
{
"no": "4",
"sid": 509648,
"did": 1270,
"dsid": 281,
"sdid": null,
"bsid": 4,
"bssid": 0,
"edit": true,
"tags": null,
"ctx": "",
"ctx_edit": true,
"chmin": null,
"chmax": null,
"ch_edit": true,
"lbls": [],
"lbls_edit": true,
"cfs": [],
"cfs_edit": true,
"cols": {
"_0": {
"column": 0,
"txt": {
"val": "PO Box 650740",
"st": 0,
"bk": 0,
"tsk": null,
"loc": "en",
"cmc": 0,
"ed": 0,
"usid": null,
"usdt": "2016-10-21T10:58:05.0421378Z",
"hh": false,
"sim": 0,
"err": null,
"lck": false,
"lck_edit": true,
"hn": -317207512,
"hp": 1010215521,
"cfs": [],
"cfs_edit": true,
"usfid": null,
"usfdt": null
},
"txt_edit": true
},
"_1": {
"column": 1,
"txt": {
"val": "",
"st": 2,
"bk": 0,
"tsk": "PROOF",
"loc": "fr",
"cmc": 0,
"ed": 1,
"usid": 66,
"usdt": "2016-11-02T14:27:10.3167023Z",
"hh": false,
"sim": 0,
"err": "Translation is empty. If this is intentional change status to green.",
"lck": false,
"lck_edit": true,
"hn": null,
"hp": null,
"cfs": [],
"cfs_edit": true,
"usfid": null,
"usfdt": null
},
"txt_edit": true
},
"_2": {
"column": 2,
"cf": null,
"cf_edit": true
}
}
}