Web API for xConnect Data Tools

Monitor a purge API task

Version:

You can use the xConnect Web API to monitor a purge task.

To track the task progress:

Use the following GET request and substitute the {{TaskId}} parameter with the ID of the ongoing registered task:
<instance>/sitecore/api/datatools/purge/tasks/{{TaskId}}

GET response

The GET response contains the following data:

{
    "Id": "049cd8b3-b120-4949-a42f-cdc2fe4f3086",
    "Created": "2020-08-18T10:59:39.7216673Z",
    "Updated": "2020-08-18T10:59:52.0965327Z",
    "TaskType": 1,
    "Status": 2,
    "Progress": 0,
    "Total": null,
    "Description": "",
    "PrerequisiteTaskIds": []
}

The data in the GET response is as follows:

Field	Description
`Id`	The task ID.
`Created`	Date and time of task creation.
`Updated`	Date and time of the last status change.
`TaskType`	DeferredAction = 0 DistributedProcessing = 1
`Status`	Pending = 0 Processing = 1 Completed = 2 Failed = 3 Expired = 4 Canceled = 5
`Progress`	The number of items processed by the task.
`Total`	The total approximate number of items to process.
`Description`	Gets the human-readable description of the task. If applied.
`PrerequisiteTaskIds`	The list of task IDs that are prerequisites for this task.

If you have suggestions for improving this article, let us know!