Background Task Object


Background task job that processes data items in bulk.

Properties
idstringRead-onlyformat GUID

Task ID.


typestring

Task type.


statusstringRead-only

Task status.


startedAtstringRead-onlyformat date-time

Task start time. Empty if the task status is NEW.


finishedAtstringRead-onlyformat date-time

Task finish time. Empty until the task status updates to COMPLETED or FAILED.


itemsFailedintegerRead-only

Number of items whose processing failed.


failuresArray <ApplicationError>Read-onlymaxItems 100

List of errors generated during the task.

Learn more about Wix Data error codes.


estimatedItemCountintegerRead-only

Estimated number of items affected by the task.


itemsSucceededintegerRead-only

Number of items successfully processed so far.


ONE OF:

deleteByQueryOptionsDeleteByQueryOptionsbeta

Options for tasks of the type DELETE_BY_QUERY.


copyFieldDataOptionsCopyFieldDataOptionsbeta

Options for tasks of the type COPY_FIELD_DATA.


editFieldDataOptionsEditFieldDataOptionsbeta

Options for tasks of the type EDIT_FIELD_DATA.


updatePublishStatusOptionsUpdatePublishStatusOptionsbeta

Options for tasks of the type UPDATE_PUBLISH_STATUS.

Task
JSON
{ "id": "097a5564-0fec-4425-8d1e-3e753b48a422", "type": "DELETE_BY_QUERY", "status": "COMPLETED", "startedAt": "2024-09-05T10:34:59.507Z", "finishedAt": "2024-09-05T10:35:03.654Z", "itemCount": 3, "itemsSucceeded": 3, "itemsFailed": 0, "failures": [], "deleteByQueryOptions": { "dataCollectionId": "Items", "environment": "LIVE", "filter": { "altText": { "$contains": "Placeholder" } } } }
Did this help?