Learning Center

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 ​

json
{
    "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"
    }
}
json
{
    "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 ​

PropertyTypeRequiredDescription
name
STRING
required
The name (or type) of the task
taskReferenceName
STRING
required
The unique name of the task in your job. It is used to reference this task in the workflow.
description
STRING
required
The functional description of this task in your job.
type
STRING
required
The type of the task. It must be SUB_WORKFLOW.
optional
BOOLEAN
required
true: the job continues if there is an error on this task.
false: the job fails.
inputParameters
OBJECT
required
Input parameters of the task. See below

Inputs ​

PropertyTypeDescription
mode
ENUM
:
ALL

BY_TABLE_KEY

BY_TABLE_ID
required
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.
tableKey
STRING
required if `mode=BY_TABLE_KEY`
The key of the table to refresh
example: PRODUCTS
tableId
STRING
required if `mode=BY_TABLE_ID`
The id of the table to refresh
example: 123456

Outputs ​

PropertyTypeDescription
updatedItems
NUMBER
The number of items that have been updated.