CheckpointsInfoIterator enumerateCheckpointsInfo (boolean showSynchronizedOnly)

Opens an Iterator over the list of defined checkpoints, with a boolean parameter allowing to retrieve either synchronized checkpoints only (true) or all checkpoints (false). Iterated results are streamed and used when needed.

The default checkpoint has the name "" (empty string).

This page discusses:

Data types

A CheckpointsInfoIterator is an abstract object used to retrieve CheckpointsInfo.

HTTP parameter

The parameter is described in the table below.

Parameter

Location

Description

PAPI_showSynchronizedOnly

[URL]

This parameter is used to specify if you want to retrieve synchronized checkpoints only.

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 method

The method used is: 

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

HTTP response

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

Here is the response format for each entry: 

[url_encode(NAME)] [space] [escape(VALUE)] [\n]

Where:

  • url_encode() – is a function which performs an url encoding of the given value.

  • escape() – is a function which replaces \r and \n with \\r and \\n.

  • NAME – can be empty.