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. This method may be useful if you need to compile an application usage log for some period of time.

Customize the following request URL according to your application processing location:

[GET] https://<PROCESSING_LOCATION_ID>.ocrsdk.com/v2/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

Parameter Is required Default value Description
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

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

Response format

The result is returned as a JSON response. The JSON response has the following format:

{
    "tasks":
    [
        <task1>,
        <task2>,
        ...
    ]
}

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.