String getCheckpoint([String name])

The getCheckpoint method retrieves checkpoints in the indexing process.

The optional parameter name can be used if many checkpoints are needed for a given source. The default value is "".

A getCheckpoint() called immediately after a setCheckpoint() set with the sync parameter to false may not return the last value. getCheckpoint() always returns the last synced checkpoint.

This page discusses:

HTTP method

The method used is: 

GET no-cache http://<host>:<port>/papi/4/connectors/<connectorName>/get_checkpoint

HTTP parameters

The parameters are described in the table below.

Parameter

Location

Description

PAPI_name

[URL]

This optional parameter can be used when you need to manage many checkpoints for a connector.

PAPI_session

[URL]

The optional parameter that retrieves the session given by a previous call to get_current_session_id

Action: if there is a session mismatch, the Push API server refuses the command and returns an exception.

HTTP response

The command uses the standard HTTP responses. See HTTP command response.

If successful (status = OK), then the body contains the serialized form of the checkpoint, which is the string value of the checkpoint.