Export Schema
You need to export a structure from a Product-Live table.
Json
Example
json
{
"name": "table-export-schema",
"taskReferenceName": "export_table_schema",
"description": "The business description of the task",
"type": "SUB_WORKFLOW",
"optional": false,
"inputParameters": {
"tableKey": "PRODUCTS",
"mode": "ALL",
"fileName": "items.xml"
}
}1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Definition
| Property | Type | Required | Description |
|---|---|---|---|
| The name (or type) of the task | |||
| The unique name of the task in your job. It is used to reference this task in the workflow. | |||
| The functional description of this task in your job. | |||
The type of the task. It must be SUB_WORKFLOW. | |||
true: the job continues if there is an error on this task. false: the job fails. | |||
| Input parameters of the task. See below |
Inputs
| Property | Description |
|---|---|
| tableKey | Reference a table key. |
| mode | ALL | ACTIVE. ACTIVE = only elements that are not archived are exported. ALL = all elements are exported regardless their status. |
| fileName | Defines name of the output file. It must not contain the extension. |
| accountKey | The account key of the partner. You need to indicates the account key only if it's a shared table by a partner otherwise do not use this property. You can find the partner key in Settings > Network > Partners |
Outputs
| Property | Type | Description |
|---|---|---|
| file | The table schema in the XML format described below. The output format is basically the same as the input format, to read more about the input format: Import Table |
Limits and additional notes
- The limitation of the output file size is 250 Mb.
FAQ
How to export the strcuture of a partner?
You must indicate the property accountKey in the input parameters. See the definition above.