Checkpoint and Restart Methods

Method Description
getCheckpoint Gets a checkpoint from the system.

If the checkpoint is not found, a null is returned.

The user calling this method must have AdministratorRight and cannot be assigned to a department.

removeCheckpoint Removes a checkpoint from the system.

The user calling this method must have AdministratorRight and cannot be assigned to a department.

searchCheckpoints Retrieves all checkpoint records that match the search criteria specified in the Checkpoint object.
Searches are only done on the following fields:
  • File Id
  • User Id
  • Client File Name
  • Node Name
  • Transaction Id
  • Proxy Transaction Id
  • Server File Name
Set the fields in the Checkpoint object that you want to search on. All other fields will be ignored. You can set from one to all the fields. Use the percent sign (%) as a wildcard character. The results are returned as an array of Checkpoint objects. The last element of the array is null. If no checkpoints are found, an array of one element is returned with a value of null.

The user calling this method must have AdministratorRight and cannot be assigned to a department.

retrieveAllCheckpoints Retrieves all checkpoints from the system as an array of checkpoint.

The last element of the array is null. If no checkpoints are found, an array of one element is returned with a value of null.

The user calling this method must have AdministratorRight and cannot be assigned to a department.