Refresh Items

This task allows to manually perform a full item refresh on a given table. This may be useful if an error occurred while updating a table or if you voluntarily skipped the automatic refresh that occurs after a table update.

Examples

Refresh items for a given table

{
    "name": "table-refresh-items",
    "taskReferenceName": "The business title of the task",
    "description": "The business description of the task",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "mode": "BY_TABLE_KEY",
        "tableKey": "PRODUCTS"
    }
}

Refresh items for all tables in the current account

{
    "name": "table-refresh-items",
    "taskReferenceName": "The business title of the task",
    "description": "The business description of the task",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "mode": "ALL"
    }
}

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	Type	Description
	:	When set to ALL, all tables in the current account will be refreshed. When set to BY_TABLE_KEY, only the table with the given key will be refreshed. When set to BY_TABLE_ID, only the table with the given id will be refreshed.
		The key of the table to refresh example: PRODUCTS
		The id of the table to refresh example: 123456

Outputs

Property	Type	Description
		The number of items that have been updated.