[PATCH] Reprocess Task

Use this request to restart processing of a specific Task. Note that this is a DESTRUCTIVE process - all previous edits to the task will be lost.

Re-processing is useful when the task is stuck in a specific TaskStatus for a long time.

You can use the GET Task Status, GET Task Status List or GET Task Status List Paginated requests to find tasks that are stuck and reprocess those you see fit.

A successful reprocess request increases the restartCount of the task by one, and updates preProcessingStartedOn. More information about these fields can be found in the GET Task Status page.

Reprocess Task

PATCH/api/v1.0/external/sdtask/restartprocessing?taskId=104

Automatic Task reprocessing

SmartDocumentor will not automatically reprocess tasks without your intervention, to minimize credit costs in your Organization.

However, we detect Tasks stuck for a long period of time, and revert them to the nearest valid TaskStatus. Additionally, Tasks stuck in the ExportCompleted or Processed statuses are automatically moved to the Task History screen.

All tasks updated by this process are visually identified by a warning icon next to the task status in the Tasks Inbox or Task History screens.

Task Assignment

Reprocessing a task will reset the status of all assigned users for the task, restarting the entire assignment workflow from the start.

Payload of reprocessed tasks

Note that tasks are reprocessed with the information that existed at the time of the first processing request. It is not possible to update this information after Task creation.

Query Parameters

Name	Type	Description
taskId	integer (optional)	The ID that identifies the task to reprocess. This ID is always unique and never changes after it has been created.
externalId	string (optional)	An optional External ID, valid for your organization and added to the Task at creation that uniquely identifies it in your Organization.

At least one of taskId or externalId must be specified.

Example Request

curl

curl --location --request PATCH 'https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/restartprocessing?taskId=104' --header 'Authorization: Bearer {your access token here}'

C#

var client = new HttpClient();

var accessToken = "your access token here";
var request = new HttpRequestMessage(HttpMethod.Patch, "https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/restartprocessing?taskId=104");

request.Headers.Add("Authorization", $"Bearer {accessToken}");

var response = await client.SendAsync(request);

response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Python

import requests

url = "https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/restartprocessing?taskId=104"
access_token = "your access token here"

payload = {}
headers = {
'Authorization': f'Bearer {access_token}'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

Javascript

const myHeaders = new Headers();
const accessToken = "your access token here";
myHeaders.append("Authorization", `Bearer ${accessToken}`);

const requestOptions = {
method: 'PATCH',
headers: myHeaders,
redirect: 'follow'
};

fetch("https://cloud.smartdocumentor.net/api/v1.0/external/sdtask/restartprocessing?taskId=104", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Responses

204 No Content

Response body has no content.

Note Returned when the reprocessing request is accepted successfully.

404 Not Found

Response body has no content.

Note Returned when no Task was found with the specified taskId or externalId.

400 Bad Request

Response body has no content.

Note Returned when a taskId or externalId are not specified.