Versions Compared

Key

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

...

requestid

The ID of the operation as returned by an asynchronous API method

int, Mandatory

RESULTS

See Asynchronous Operation (Object)   


EXAMPLES

The result if the operation still runs in the background.

Code Block
languagejs
{
	"trm": {
		"requestid": 559,
		"isbatch": false,
		"status": "Waiting",
		"statusText": "Waiting..."
	}
}

 

Oups, this operation failed:

Code Block
languagejs
{
	"trm": {
		"requestid": 559,
		"isbatch": false,
		"status": "Failed",
		"statusText": "Operation failed!",
		"statusInfo": "The parameter xy was not properly supplied"
	}
}

 

The operation terminated with success. Results are included in the custom and/or results nodes.

Note that this is a sample result from resources/segments/view/export. It is used to export a job or project to XLIFF. The XLIFF file itself is downloaded with the "fileref" token - please see the documentation for more details.

Code Block
languagejs
{
	"trm": {
		"requestid": 0,
		"isbatch": false,
		"status": "Finished",
		"statusText": "Finished!"
	},
	"custom": {
		"fileref": "ea9c1adeb02f4a9ebe8771583c12fa6b",
		"filename": "export_wm-1180_en_fr.xlf",
		"segments": 10
	}
}