com.laserfiche.repository.api.clients

Interface TasksClient

All Known Implementing Classes:

TasksClientImpl

public interface TasksClient

The Laserfiche Repository Tasks API client.

Method Summary

Modifier and Type	Method and Description
CancelTasksResponse	cancelTasks(ParametersForCancelTasks parameters) - Starts the cancellation for a set of one or more tasks. - Provide comma-separated list of task IDs to cancel.
TaskCollectionResponse	listTasks(ParametersForListTasks parameters) - Returns the status of a set of one or more tasks. - Provide a comma-separated list of task IDs to get the task status, progress, and any errors that may have occurred. - Leave the taskIds query parameter empty, to get the list of all the task IDs associated with the current access token. - TaskStatus can be one of the following values: NotStarted, InProgress, Completed, Cancelled, or Failed. - This API employs long polling technique and could return the result immediately (e.g.

Method Detail

listTasks

TaskCollectionResponse listTasks(ParametersForListTasks parameters)

- Returns the status of a set of one or more tasks.
- Provide a comma-separated list of task IDs to get the task status, progress, and any errors that may have occurred.
- Leave the taskIds query parameter empty, to get the list of all the task IDs associated with the current access token.
- TaskStatus can be one of the following values: NotStarted, InProgress, Completed, Cancelled, or Failed.
- This API employs long polling technique and could return the result immediately (e.g. if the export operation is failed or completed successfully) or after at most 60 seconds.
- Required OAuth scope: None

Parameters:

parameters - An object of type ParametersForListTasks which encapsulates the parameters of listTasks method.

Returns:

TaskCollectionResponse The return value

cancelTasks

CancelTasksResponse cancelTasks(ParametersForCancelTasks parameters)

- Starts the cancellation for a set of one or more tasks.
- Provide comma-separated list of task IDs to cancel. Should be used if an operation was created in error, or is no longer necessary.
- Check the status of the task to determine if the task has been cancelled successfully.
- Leave the taskIds query parameter empty, to cancel the list of all the task IDs associated with the current access token.
- Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled.
- Required OAuth scope: None

Parameters:

parameters - An object of type ParametersForCancelTasks which encapsulates the parameters of cancelTasks method.

Returns:

CancelTasksResponse The return value