Provides access to the data of a single segment
URL: | /editor/segment/[ID] |
Available Methods: | GET / PUT |
Specialities: | Only possible with a task in edit mode. Resource Layout is dynamic. |
Resource Layout
Name | Type | Info |
id | int | GET only |
fileId | int | GET only, set by import |
| isFirstofFile | boolean | GET only, calculated depending on filters set |
segmentNrInTask | int | GET only, set by import |
userName | string | GET only, set by server |
timestamp | date | GET only, set by server |
editable | boolean | GET only, set by import |
autoStateId | int | GET only, set by server |
workflowStep | string | GET only, set by server |
| workflowStepNr | int | GET only, set by server |
matchRate | int | initially set by import, should be changed only when new text content comes from a system which provides a new matchRate |
| matchRateType | string | initially set by import to "import", should be changed when changing the above matchRate |
durations | object |
|
comments | string | GET only, set by server |
qmId | string |
|
stateId | int |
|
[FIELD] | string | GET only |
[FIELD]Edit | string | Optional, only if field is editable. |
| isWatched | boolean | GET only, set by server (user dependent) |
| segmentUserAssocId | int | GET only, set by server (user dependent) |
Segments contain dynamic fields, defined on import. This dynamic fields contain the segment payload.
Additonal Meta Informations
In the JSON response you will find an additional object "metaData" beneath the normally used "rows" array. Currently metaData contains only the integer field "firstEditable" which contains the rowIndex of the first segment which is editable in the current sort and filtered segment list. This field is only returned in the first request.
Special URLs
| URL | Method | Parameters | Description |
|---|---|---|---|
| /editor/segment/nextsegments | POST | next: boolean; 1 to find and return the next editable segment nextFiltered: boolean; 1 to find and return the next editable segment filtered by workflow prev: boolean; 1 to find and return the previous editable segment prevFiltered: boolean; 1 to find and return the previous editable segment filtered by workflow filter: the same filter parameters as for the segment listing sort: the same sort parameters as for the segment listing segmentId: integer; The ID of the segment which should be used as start point | In big tasks where only a few segments are editable, This information must then be calculated separately. The response contains a plain JSON Object, containing the segment IDs for the requested steps (next / nextFiltered / prev / prevFiltered). For example (only next and nextFiltered were delivered with 1 (true) on the request): {
next: 123
nextFiltered: 321
}
|
| /editor/segment/terms | POST | id: integer; the segment id to get the terminology entries for | returns a HTML Fragment with the terminology entries of the requested segment. |