‚Äč

Cloud OCR SDK Documentation

listTasks Method

The method returns the list of tasks created by your application. By default, the Deleted tasks are included, but you can filter them out. 

[GET] http(s)://cloud.ocrsdk.com/listTasks

The tasks are ordered by the date of the last action with the task. This method can list up to 1000 tasks. If you process a large number of tasks, call this method for shorter time periods.

Parameters

ParameterIs requiredDefault valueDescription
fromDate No The current date minus 7 days Specifies the date to list tasks from. The date must be specified in the W3C XML DateTime data type (for example, yyyy-mm-ddThh:mm:ssZ).
toDate No The current date Specifies the date to list tasks to. The date must be specified in the W3C XML DateTime data type (for example, yyyy-mm-ddThh:mm:ssZ).
excludeDeleted No "false"

Specifies if the tasks that have already been deleted must be excluded from the listing. The parameter can have one of the following values:

  • true
  • false

Status codes and response format

General status codes and response format of the method are described in HTTP Status Codes and Response Formats.

The following status codes can be returned when this method is called:

CodeDescription
200 Successful method call.
450 Incorrect parameters have been passed. One of the following errors occurred:
  • The incorrect start date has been specified.
  • The incorrect end date has been specified.
  • The start date exceeds the end date.