Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The method returns the details of the updated segments (with the language details specified in the layout).

Each element has these properties:


result.rowsArray of the updated segments. See this page for details: Segment Details (Object)object[]
result.docsDetails of the documents that are referenced by result.rows. This contains the same information as sent back by resources/segments/search (check this page for details)object[]
results.usersDetails of the users that are referenced by result.rows. This contains the same information as sent back by resources/segments/search (check this page for details)object[]

...


EXAMPLES

We submit this update:

Code Block
PUT /api/resources/segments/view/update
BODY:
{
	"layout": {
		"columns": [
			{ "index": 0, "ftype": 1, "fqualifier": 0, "loc": "fr" },
			{ "index": 1, "ftype": 1, "fqualifier": 0, "loc": "en-US" }
		]
	},
	"scope": {
		"type": "Project",
		"projectid": 6632
	},
	"updates": [
		{
			"sid": 21567228,
			"cols": {
				"_10": {
					"txt": {
						"val": "MyNouvelle new translationtraduction"
					}
				}
			}
		}
	]

object[]

...


}


And get this result back:

Code Block
"updates{
	"result": {
		"rows": [
			{
				"no": "2",
				"ts": "2020-04-17T09:18:23.4389404Z",
				"sid": 21567229,
				"did": 36250,
				"dsid": 7719,
				"cty": 1,
				"sdid": 1,
				"bsid": 21567228,
 2,
				"bssid": 0,
				"edit": true,
				"tags": null,
				"tmx": [],
				"split": true,
				"ctx": "ListParagraph",
				"ctx_edit": true,
				"chmin": null,
				"chmax": null,
				"ch_edit": true,
				"lbls": [],
				"lbls_edit": true,
				"cfs": [],
				"cfs_edit": true,
				"tbx": [],
				"_changed": true,
				"cols": {
					"_0": {
						"column": 0,
						"txt": {
							"val": "Nouvelle traduction",
							"st": 0,
							"bk": 0,
							"tsk": null,
							"loc": "fr",
							"cmc": 0,
							"ed": 1,
							"rep": 0,
							"usid": 2,
							"usdt": "2020-04-17T09:18:23.4389404Z",
							"hh": false,
							"sim": 0,
							"err": null,
							"lck": false,
							"lck_edit": true,
							"hn": null,
							"hp": null,
							"cfs": [],
							"cfs_edit": true,
							"lbls": [],
							"lbls_edit": true,
							"usfid": null,
							"usfdt": null,
							"tbx": [],
							"sent": null,
							"sentdt": null,
							"tmx": []
						},
						"txt_edit": true
					},
					"_1": {
						"column": 1,
						"txt": {
							"val": "New translation",
							"st": 1}}
": 0,
							"bk": 0,
							"tsk": null,
							"loc": "en-US",
							"cmc": 0,
							"ed": 0,
							"rep": 0,
							"usid": null,
							"usdt": "2020-04-14T12:34:32.2196478Z",
							"hh": false,
							"sim": 0,
							"err": null,
							"lck": false,
							"lck_edit": true,
							"hn": 1681133032,
							"hp": -126583649,
							"cfs": [],
							"cfs_edit": true,
							"lbls": [],
							"lbls_edit": true,
							"usfid": null,
							"usfdt": null,
							"tbx": [],
							"sent": null,
							"sentdt": null,
							"tmx": []
						},
						"txt_edit": true
					}
				}
			}
		],
		"docs": {
			"_36250": {
				"did": 36250,
				"dsid": 7719,
				"name": "english.docx",
				"pmax": null,
				"pmin": null,
				"ptype": 4,
				"pdomain": "MSWORD",
				"previewapp": null,
				"previewurl": null,
				"previewtf": null,
				"edit": true
			}
		},
		"users": {
			"_2": {
				"id": 2,
				"nm": "Internal Translator A",
				"cid": 2,
				"cnm": "My LSP"
			}
		}
	}
}