Export Flex container content to a simple Excel file. You are able to customize the columns using the layout object (see below).
(POST) /api/apps/wbflex/documents/{id}/io/export |
The URL parameters are:
id | Specify either a document ID (such as 1000) or a job ID (such as c300). | string, Mandatory |
The BODY must be a JSON object with these properties:
layout | Optional. A layout object. The layout defines the columns of the Excel file. If not specified, a default layout will be used. See Excel Layout - Defining Columns for details. | object, Optional |
query | Optional. Use to filter the segments to export. See resources/segments/search for more details on the query syntax. | object, Optional |
callback | Specify a URL which will be called upon success or failure of operation. This makes polling for operation status unnecessary. See Callbacks (with asynchronous operations) | object, Optional |
The operation is asynchronous and may take a few seconds to complete. The method returns an Asynchronous operation result:
{
"trm": {
"requestid":32230,
"status":"Waiting",
"statusText":"Waiting..."
}
} |
Specify the callback in the payload to be automatically notified of completion. Otherwise you need to poll the operation for completion (until status = “Finished”). When finished (or via the callback) you obtain the results as a JSON:
{
"trm": { ... }
"custom": {
"filetoken": "827cb939a59246f389f74c6f4a028417",
"segments": 4
}
} |
The important fields are in the custom node. It has these properties:
filetoken | Use to download the Excel file with media/get/{token} | string |
segments | Total segments extracted to the Excel | int |
An export may typically look as follows. Here we added only one target language but an Excel may contain all target languages of the Flex container.
