Page Comparison

The scope object. It delimits the total range of segments and related resources that can be queried.

Example:

"scope": { "type": "Project", "projectid": 1234 }

Optional layout object. The layout is required when updating language level content such as source text or translation text.

If not specified, the system expects that update operations are for the scope's source and first target language. This may not be what is expected. It is strongly recommended to explicitly set this object with the language(s) to be updated.

Example for updating French and English content. The index is assigned starting from 0 and will be referenced in the updates node below. Property ftype defines the type of column, value 1 refers to the text content.

"layout": {
		"columns": [
			{ "index": 0, "ftype": 1, "loc": "fr" },
			{ "index": 1, "ftype": 1, "loc": "en-US" }
		]
	}

When updating language custom fields or labels, to attach comments to a language, etc. then you will need to add more columns to target those properties. Please see  layout object for more information.

Segment level fields including segment custom fields, do not require column definitions.

An array with update instructions.

Example to update the English (United States) translation. The "_1" property key refers to the layout column with index = 1, prefixed with an underscore character. The sid property is the segment ID.

"updates": [
		{
			"sid": 21567228,
			"cols": {
				"_1": { "txt": { "val": "My new translation" } }
			}
		}
	]

Example for updating translation and setting the status to OK (green) - see resources/segments/search to learn more on the different fields and values.

Example for updating multiple segments, source texts, translations and status:

"updates": [
		{
			"sid": 21567228,
			"cols": {
				"_1": { "txt": { "val": "Please click here", "st": 1 } }
			}
		},
		{
			"sid": 21567240,
			"cols": {
				"_0": { "txt": { "val": "Öffne den Dialog" } },
				"_1": { "txt": { "val": "Open the dialog", "st": 1 } }
			}
		}
	]