HTTP Push API Guide

exalead
TM
EXALEAD HTTP/REST
PUSH API GUIDE
AN EXALEAD S.A. OEM

SUPPORT DOCUMENT
This document details the Exalead

HTTP-Push API
Doc. No. EN.120.002.1-V4.6.1 - March 31, 2008

Copyright © 2008 by Exalead S.A. All rights reserved.
exalead one:enterprise
HTTP/REST PUSH API GUIDE
Legal Notice
Information in this document is subject to change without notice and does not represent a
commitment on the part of Exalead S.A..
This document is Copyright © by Exalead S.A. No part of this document may be reproduced or
transmitted in any form or by any means, electronic or mechanical, including photocopying or
recording, for any purpose without the express written permission of Exalead S.A..
Exalead, ExaScript, CloudView and its associated logos are Registered Trademarks of Exalead
S.A..
This document makes reference to other names and products that are Trademarks of their
respective owners.
The software described in this document is Copyright © by Exalead S.A. and is supplied under a
licence agreement, a nondisclosure agreement, or both. It is against the law to copy or transmit
this software by any medium except as specifically sanctioned by these agreements.
For more information about Exalead:

• See www.exalead.com
• Write to us at:
Exalead
10 place de la Madeleine
75008 Paris
FRANCE
• Telephone: +33 (0)1 55 35 26 26
• Fax: +33 (0)1 55 35 26 27
For Product Support:

http://www.exalead.com/software/services/support/
US and Canada only:

• Hotline: (888) 247-9214 (Monday-Friday, 9am - 9pm ET)
• Email: us-support-oneenterprise@exalead.com (General Inquiries)
us-support-oneoem@exalead.com (OEM-Related Inquiries)
Outside the US:

• Hotline: +33 1 55 35 26 00
• Email: support-emea@exalead.com
Exalead S.A. is incorporated with a nominal capital of 113 866.80 €.

RCS Paris B 432 887 875
APE 722C
This product has several patents.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 2

© 2008 BY EXALEAD S.A. REPRODUCTION AND DISCLOSURE PROHIBITED.
exalead one:enterprise
HTTP/REST PUSH API GUIDE TABLE OF CONTENTS
Table of Contents
Preface
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Acronyms and Terminology . . . . . . . . . . . . . . . . . . . . . . 7
Section 1 API Conventions and methods
API Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . 9
POST add_document . . . . . . . . . . . . . . . 11
POST add_document_list . . . . . . . . . . . . . . 12
POST delete_document . . . . . . . . . . . . . . 13
POST delete_document_list . . . . . . . . . . . . . 14
POST delete_document_collection . . . . . . . . . . . . 15
GET get_document_status . . . . . . . . . . . . . . 16
GET get_document_status_list . . . . . . . . . . . . . 17
POST set_checkpoint . . . . . . . . . . . . . . . 18
GET get_checkpoint . . . . . . . . . . . . . . . 19
POST clear_all_checkpoints . . . . . . . . . . . . . 20
POST open_document_status_collection_iterator . . . . . . . . 21
POST next_document_status_collection_iterator . . . . . . . . . 22
POST next_batch_document_status_collection_iterator . . . . . . . 23
POST close_document_status_collection_iterator . . . . . . . . 24
POST open_checkpoint_iterator . . . . . . . . . . . . 25
POST next_checkpoint_iterator . . . . . . . . . . . . 26
POST next_batch_checkpoint_iterator . . . . . . . . . . . 27
POST close_checkpoint_iterator . . . . . . . . . . . . 28
POST create_partial_flush_task . . . . . . . . . . . . 29
POST get_task_status . . . . . . . . . . . . . . 30
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 3

exalead
TM
P REFACE
How to use this guide

exalead one:enterprise PREFACE
HTTP/REST PUSH API GUIDE ABOUT THIS GUIDE
About this Guide
Revision history
Ver. Date Author Document revision history
1.0 May 31, 2007 A. Derbel Creation of document.
4.6.0 March 4, 2008 A. Derbel New versioning and format for new exalead
one:enterprise v4.6 release.
4.6.1 March 31, 2008 A. Derbel Updates for version 2 of the Push API for exalead
one:enterprise v4.6.
Documentation set The exalead one:enterprise documentation set is as follows.The exalead one:enterprise
documentation set is as follows. The technical and user reference guides are:
Document
number Title
EN.120.001 Exalead one:enterprise Administration
EN.120.002 Exalead one:enterprise Connectors
EN.120.003 Exalead one:enterprise Security
EN.120.004 Exalead one:enterprise HTML Front-end
EN.120.007 Exalead one:enterprise User
EN.120.008 Exalead one:enterprise Installation
The programming API guides are:
Document
number Title
EN.120.002.1 Exalead one:enterprise HTTP/REST Push API
EN.120.002.2 Exalead one:enterprise Push API
EN.120.018 Exalead one:enterprise Search Front-end API: XML v10
EN.120.020 Exalead one:enterprise Search Front-end API: XML v3.1
EN.120.021 Exalead one:enterprise Query Language
The technology guides are:
Document
number Title
EN.120.010 Exalead one:enterprise Categorization
EN.120.011 Exalead one:enterprise Filtering
Document audience This document has been written to explain how to use the exalead one:enterprise Push API. It is
for people who have experience with:
• HTTP API
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 5

HTTP/REST PUSH API GUIDE ABOUT THIS GUIDE
Purpose and The Exalead PUSH API is the API available for Exalead partners and contractors to index a new
data source from the exalead one:enterprise product.
application scope
The PUSH API is natively a simple HTTP/Rest API. The API user may either use this Rest API
directly from the language of its choice, or use provided client-side wrappers for the API (C#, Java,
Ruby, Perl, ExaScript).
This document describes version 2 of the API at the HTTP/Rest level, including:
– HTTP url syntax,
– parameters convention,
– types serialization/de-serialization,
– error handling and
– security aspects.
Please refer to the Push API documentation for more details about global notions.
API users should refer to the general Push API documentation of their client-side wrappers
documentation for more detailed explanations and examples.
Formatting The following formatting conventions are used in this document.

conventions
The text style Is used for
Italic Titles used in cross-references and variable names.
All output and for anything you would type in a console window.
Output font
COURRIER NEW FONT Text labels from a graphic user interface.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 6

HTTP/REST PUSH API GUIDE ACRONYMS AND TERMINOLOGY
Acronyms and Terminology
Acronyms The following acronyms are used in this guide.
Acronym Means
HTTP Hypertext Transfer Protocol
URI Universal Resource Identifier
PAPI Push API
IP Internet Protocol
URL Universal Resource Locator
XML Extensible Markup Language
Terminology Some important terms used in this document are defined below.
Term Definition
Command A "Command" refers to the function requested on the server
(add_document, delete_document, ...)
URL The "URL" refers to the address on which the client must send POST or
GET request. It includes the HTTP Push Server host and port number, the
conventional prefix for the connectors command, the source name and,
lastly, the Command.
For example:
http://myexaserver:10011/private/connectors/mysource/add_document
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 7

exalead
TM
S ECTION 1
A P I C ONVENTIONS AND
METHODS
A description of the HTTP/Rest Push API conventions

and methods
exalead one:enterprise SECTION 1 API CONVENTIONS AND METHODS
HTTP/REST PUSH API GUIDE API CONVENTIONS
API Conventions
Command The parameters can be sent in different ways using the:

parameters
Parameter Description
URL The parameter in the request URL, for example:
...../addDocument?uri='file://mydir/file1.doc'
FORM the parameter is part of the form data
The recommended way parameters should be sent to the server is specified for each
parameter in the Command description: [URL] or [FORM].
HTTP Methods The HTTP methods used are the following:
GET The GET method.
POST The POST method can be encoded as MIME multipart/form-
data content-type (RFC 2388), or application/x-www-form-
urlencoded
HTTP Header To detect hazardous mixes of the two API versions between the client and the server
Parameters side, an extra Parameter is added to every request.
Papi-Version The possible values for the PAPI version (at this moment)
are the following:
• PAPI_v1.0
• PAPI_v2.0
Command The Exalead PUSH API operations processing may be asynchronous. This means that
response requested add or delete operations are accepted but we don't know for sure when they
will be performed. Subsequent errors can be retrieved asynchronously, by retrieving the
status of Document.
But some errors can occurs at a lower level, here is the presentation of the general
default HTTP responses; special cases are described below for the Commands
concerned.
HTTP Response Description

OK No problem during parameters de-serialization process.
BAD_REQUEST An error occurred while parameters parsing or during command

treatment. The body of the result contains the error description.
METHOD_NOT_ALLOWED Usage of POST or GET method is strict with the HTTP
Push API, only specified methods are authorized for each Command.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 9

HTTP/REST PUSH API GUIDE API CONVENTIONS
Example 1 - Convention for error serialization
<error>
<type> ... </type>
<short_message> ... </short_message>
<message> ... </message>
</error>
List of possible error types:

• InvalidConnectorError
• InvalidParameterError
• InvalidFilterError
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 10

HTTP/REST PUSH API GUIDE POST add_document
POST add_document
Parameters The parameters are described in the table below.
PAPI_uri [URL] The URI parameter is directly the string of the document's URI.
PAPI_stamp [FORM] (optional) The stamp parameter is the string representing the document's Stamp.
PAPI_meta_<metaname> [FORM] The meta_* parameter is a string containing the value of the metadata referenced by
metaname.
A metadata does not have to be unique, but you have to check for which of them it
make senses to have multiple values on the metadata description page (refer to
Exalead Push API document).
PAPI_part_bytes:<name> [FORM] The part_bytes parameter is the content of the document's part that is identified by
'name'.
PAPI_part_ext:<name> [FORM] The part_ext parameter is the extension hint of the document's part that is identified
(optional) by 'name'.
PAPI_part_mime:<name> [FORM] The part_mime parameter is the mime hint of the document's part that is identified by
(optional) 'name'.
Description Request for a document addition.

For better performance, it's recommended to use a multipart/form-data instead of
application/x-www-form-urlencoded.
Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 11

HTTP/REST PUSH API GUIDE POST add_document_list
POST add_document_list

NOTE These parameters must be repeated (with a different id) for very
document you want to send.
PAPI_<id>:uri [FORM] The URI parameter is directly the string of the document's URI.
PAPI_<id>:stamp (optional) The stamp parameter is the string representing the document's Stamp.
[FORM]
PAPI_<id>:meta_<metaname> The meta_* parameter is a string containing the value of the metadata referenced by
[FORM] metaname.
PAPI_<id>:part_bytes:<name> The part_bytes parameter is the content of the document's part that is identified by
[FORM] 'name'.
PAPI_<id>:part_ext:<name> The part_ext parameter is the extension hint of the document's part that is identified
[FORM] (optional) by 'name'.
PAPI_<id>:part_mime:<name> The part_mime parameter is the mime hint of the document's part that is identified by
[FORM] (optional) 'name'.
Description Request for a document addition on the collection sent.

Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 12

HTTP/REST PUSH API GUIDE POST delete_document
POST delete_document
PAPI_uri [URL] The URI parameter is directly the string of the document's uri.
Description Request for a document deletion.
Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 13

HTTP/REST PUSH API GUIDE POST delete_document_list
POST delete_document_list
PAPI_uriList [FORM] The uriList parameter is directly the string of the document's uriList serialized using the following
xml serialization format:
<uriList>
<uri>file://....</uri>
</uriList>
Description Request for a document deletion on the specified URI list.
Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 14

HTTP/REST PUSH API GUIDE POST delete_document_collection
POST delete_document_collection
PAPI_filter [URL] The filter parameter is directly the string representation of the filter.
For more details, see the filter chapter in the Exalead one:enterprise Push API Guide.
Description Request for a document deletion on a collection selected by the filter.
Response An error status indicating an InvalidFilterError occurred can be returned in case the
filter syntax is incorrect.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 15

HTTP/REST PUSH API GUIDE GET get_document_status
GET get_document_status
PAPI_uri [URL] The URI parameter is directly the string of the document's URI.
Description Retrieve from the Indexing System the status of the document specified by the URI
parameter. The structure is serialized and returned in the response body.
Response If successful (status = OK), then the body contains the serialized form of the
DocumentStatus in XML format:
<DocumentStatus>
<uri> ... </uri>
<stamp> ... </stamp>
<status> ... </status>
</DocumentStatus>
Where status can take the following values: EXISTS, MISSING, ERROR
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 16

HTTP/REST PUSH API GUIDE GET get_document_status_list
GET get_document_status_list
PAPI_uriList [FORM] The uriList parameter is directly the string of the document's uriList serialized using the
following XML format:
<uriList>
</uriList>
Description Retrieve from the Indexing System the status of all documents specified by the uriList
parameter. The structure is serialized and returned in the response body.
DocumentStatus[] in XML format:
<DocumentStatusList>
<DocumentStatus>
<uri> ... </uri>
</DocumentStatus>
...
</DocumentStatusList>
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 17

HTTP/REST PUSH API GUIDE POST set_checkpoint
POST set_checkpoint
PAPI_checkpoint [URL] The checkpoint parameter is directly the string of the checkpoint's value.
PAPI_name(optional) This optional parameter can be used in case you need to manage many checkpoints for a
[URL] connector.
Description Set the given checkpoint. If the optional name is given, then the concerned checkpoint
is changed.
Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 18

HTTP/REST PUSH API GUIDE GET get_checkpoint
GET get_checkpoint
PAPI_name(optional) This optional parameter can be used in case you need to manage many checkpoints for a
[URL] connector.
Description Get the last saved checkpoint. If the optional name is given, then the concerned
checkpoint is returned.
Response If successful (status = OK), then the body contains the serialized form of the checkpoint,
which is directly the string value of the checkpoint
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 19

HTTP/REST PUSH API GUIDE POST clear_all_checkpoints
POST clear_all_checkpoints
Description Delete all checkpoints created using an optional name.
Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 20

HTTP/REST PUSH API GUIDE POST open_document_status_collection_iterator
POST open_document_status_collection_iterator
PAPI_filter [URL] The filter parameter is directly the string representation of the filter.
Description Open an iterator on a document collection matching the filter given as parameter.
Response If successful (status = OK), then the body contains the serialized form of the IteratorID,
which is directly the string value of the IteratorID (int).
The IteratorID will be used to address the correct iterator (in case of multiple concurrent
iterator) stored in the server context.
An error status indicating an InvalidFilterError occurred can be returned in case the
filter syntax is incorrect.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 21

HTTP/REST PUSH API GUIDE POST next_document_status_collection_iterator
POST next_document_status_collection_iterator
PAPI_iteratorID [URL] The iteratorID parameter is directly the string representation of the integer value.
Description Return the next DocumentStatus available in the enumeration associated to the
iteratorID.
DocumentStatus in XML format:
<DocumentStatus>
<uri> ... </uri>
</DocumentStatus>
Where status can take the following values: EXISTS, MISSING, ERROR
If the end of the iterator has been reached, then <null/> is returned.
An error status indicating an InvalidIteratorError occurred can be returned in case the
iteratorID is invalid.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 22

HTTP/REST PUSH API GUIDE POST next_batch_document_status_collection_iterator
POST next_batch_document_status_collection_iterator
PAPI_iteratorID The iteratorID parameter is directly the string representation of the integer value.
[URL]
PAPI_count [URL] The count parameter is directly the string representation of the integer value.
Description Return the next DocumentStatus[] available in the enumeration associated to the
iteratorID.
DocumentStatus[] in XML format:
<DocumentStatusList>
<DocumentStatus>
<uri> ... </uri>
</DocumentStatus>
...
</DocumentStatusList>
If no more results are available, then <DocumentStatusList/> is returned.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 23

HTTP/REST PUSH API GUIDE POST close_document_status_collection_iterator
POST close_document_status_collection_iterator
PAPI_iteratorID The iteratorID parameter is directly the string representation of the integer value.
[URL]
Description Release resources allocated on the server side associated to the iteratorID.
Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 24

HTTP/REST PUSH API GUIDE POST open_checkpoint_iterator
POST open_checkpoint_iterator
N/A
Description Open an iterator on the list of optional name used to create checkpoints.
Response In case of success (status = OK), then the body contains the serialized form of the
IteratorID, which is directly the string value of the IteratorID (int).
The IteratorID will be used to address the correct iterator (in case of multiple concurrent
iterator) stored in the server context.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 25

HTTP/REST PUSH API GUIDE POST next_checkpoint_iterator
POST next_checkpoint_iterator
PAPI_iteratorID[URL] The iteratorID parameter is directly the string representation of the integer value.
Description Return the next checkpoint name available in the enumeration associated to the
iteratorID.
Checkpoint name in XML format:
<Checkpoint> ... </Checkpoint>
If the end of the iterator has been reached, then <null/> is returned.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 26

HTTP/REST PUSH API GUIDE POST next_batch_checkpoint_iterator
POST next_batch_checkpoint_iterator
PAPI_count[URL] The count parameter is directly the string representation of the integer value.
Description Return the next String[] available in the enumeration associated to the iteratorID.
String[] in XML format:
<CheckpointList>
<Checkpoint> ... </Checkpoint>
...
</CheckpointList>
If no more results are available, then <CheckpointList/> is returned.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 27

HTTP/REST PUSH API GUIDE POST close_checkpoint_iterator
POST close_checkpoint_iterator
Description Release resources allocated on the server side associated to the iteratorID.
Response (default)
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 28

HTTP/REST PUSH API GUIDE POST create_partial_flush_task
POST create_partial_flush_task
Description Create on the server a partial flush (commit) operation asynchronously, and return a
TaskID that could be used to monitor the status of the task.
Response In case of success, returns an integer, which is the TaskID of the created task.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 29

HTTP/REST PUSH API GUIDE POST get_task_status
POST get_task_status
PAPI_taskID[URL] The taskID parameter is directly the string representation of the integer value of the
Task we want to monitor.
Description Check the status of a task previously created on the server .
Response The status of the task :
<TaskStatus>
<status>1,2 or 3</status>
<message>….</message>
</TaskStatus>
Status table:
1 : RUNNING
2 : FINISHED
3 : ERROR
In case of ERROR, the message field contains the description of the error.
DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 30

exalead
TM
About Exalead
Founded in 2000 by search-engine pioneers, Exalead (www.exalead.com) is a global provider of software that is
designed to simplify all aspects of information search and retrieval for organizations of all sizes. Based on the first and
only unified technology platform for desktop, intranet or Web search, Exalead offers easier deployment,
administration and use than any other enterprise-type search software. This is true whether for one or thousands of
desktops, a small business or global enterprise, and conforms to any technology environment. It also adapts to user
habits for a uniquely satisfying search experience.
Exalead software is used by leading banking and financial services, media, consumer packaged goods, research,
retailing sports entertainment and telecommunications companies around the world, including Air Liquide, BNP
Paribas and Carlson Wagonlit. Exalead is an operating unit of Qualis, an international holding company.
Call Exalead for Your Information Access Needs

Talk to us about your information access needs. Our sales technicians will be delighted to answer any questions you
may have.
Exalead - France Exalead - USA Exalead - Italy Exalead - United Kingdom Exalead - Germany
10 place de la Madeleine 576 Folsom Street - 2nd floor Corso Giuseppe Garibaldi, 86 International House Niederlassung Deutschland
75008 Paris, France San Francisco, CA 94105 20121 - MILANO, Italy Stanley Bvd, Hamilton Robert-Bosch-Strasse 7
Glasgow G72 0BN 64293 Darmstadt
Tel: +33 (0)1 55 35 26 26 Tel: +1 (415) 230-3800 Tel: +39 02 62 71 10 10 Tel: +44 (0)1698 404630 Tel: +49 6151 35 99 690-0
Fax: +33 (0)1 55 35 26 27 Fax: +1 (415) 568-3375 Fax: +39 02 62 71 10 11 Fax: +44 (0)1698 404639 Fax: +49 6151 35 99 690-35
contact@exalead.com www.exalead.com
31 DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008

LAST PAGE

HTTP Push API Guide

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

HTTP Push API Guide

Uploaded by

Copyright:

Available Formats

exalead

AN EXALEAD S.A. OEM

This document details the Exalead

Doc. No. EN.120.002.1-V4.6.1 - March 31, 2008

For more information about Exalead:

For Product Support:

US and Canada only:

Outside the US:

Exalead S.A. is incorporated with a nominal capital of 113 866.80 €.

This product has several patents.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 2

About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Section 1 API Conventions and methods

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 3

How to use this guide

About this Guide

The programming API guides are:

The technology guides are:

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 5

Formatting The following formatting conventions are used in this document.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 6

Acronyms and Terminology

Acronyms The following acronyms are used in this guide.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 7

A description of the HTTP/Rest Push API conventions

Command The parameters can be sent in different ways using the:

HTTP Methods The HTTP methods used are the following:

HTTP Response Description

BAD_REQUEST An error occurred while parameters parsing or during command

METHOD_NOT_ALLOWED Usage of POST or GET method is strict with the HTTP

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 9

Example 1 - Convention for error serialization

List of possible error types:

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 10

Parameters The parameters are described in the table below.

Description Request for a document addition.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 11

Parameters The parameters are described in the table below.

Description Request for a document addition on the collection sent.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 12

Parameters The parameters are described in the table below.

Description Request for a document deletion.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 13

Parameters The parameters are described in the table below.

Description Request for a document deletion on the specified URI list.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 14

Parameters The parameters are described in the table below.

Description Request for a document deletion on a collection selected by the filter.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 15

Parameters The parameters are described in the table below.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 16

Parameters The parameters are described in the table below.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 17

Parameters The parameters are described in the table below.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 18

Parameters The parameters are described in the table below.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 19

Description Delete all checkpoints created using an optional name.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 20

Parameters The parameters are described in the table below.

DOC. NO. EN.120.002.1-V4.6.1 - MARCH 31, 2008 21

Parameters The parameters are described in the table below.