A JSON object that represents a comment of a segment or document.
PROPERTIES
| cty | Either "d" for a comment attached to a document or "s" for a comment attached to a segment. | string |
| cmid | String identifier of the comment. For your information: The first letter tells if the comment is a segment ("s") or a document ("d") level comment. Examples:
| string |
txt | The comment text. Plain text. | string |
| loc | The locale to which the comment is attached. This can be a source or target locale. | string |
| dt | Date when comment was added or updated. | datetime |
| uid | The user/person ID who created or last updated the comment. | int |
| pi | Optional person initials. Null if set by machine. | string? |
| tsk | Optional 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 |
| cat | The comments category. Defines the category (a name) as well as visual style. | int |
| fro | Information only. If true then the comment is flagged as read-only and cannot be edited under no circumstances. This is typically a comment exported from the original file and to be maintained in its current state. | bool |
| fpd | Information only. If true, then the comment is embedded in the actual original file. Used with some file formats such as PO or XLIFF. Typically the comment is then saved back to the translated file. | bool |
| edit | True if the user is allowed to edit or delete the comment. False, if no change is permitted. | bool |
EXAMPLES
A document level comment:
{
"cty": "d",
"cmid": "d1908-91",
"sid": null,
"did": 1908,
"txt": "This is a sample comment",
"tsk": null,
"dt": "2017-04-10T08:19:30.9117921Z",
"cat": 0,
"fpd": false,
"fro": false,
"loc": "en",
"pid": 7,
"edit": true
}
A segment level comment:
{
"cty": "s",
"cmid": "s99387-882",
"sid": 99387,
"did": 1908,
"txt": "This is a sample comment",
"tsk": null,
"dt": "2017-04-10T08:19:30.9117921Z",
"cat": 0,
"fpd": false,
"fro": false,
"loc": "en",
"pid": 7,
"edit": true
}