X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Operation: Remove-Documents

The operation Remove-Documentsdeletes documents based on a unique source key (sourceKey)from the database.

Input

The adapter excepts an XML document with the following structure as input.

<x4ai_adapter>
   <sourceKey>DonQuixote</sourceKey>
   <sourceKey>Faust</sourceKey>
   <sourceKey>Hamlet</sourceKey>
</x4ai_adapter>

The following elements can be contained in the input:

Element

Description

x4ai_adapter

Enclosing element for the input of the operation Remove-Documents

sourceKey

Uniquw source key to identify the document to be deleted. Add the unique document name here.

Possible values:

String

Example:

Installation Manual

Output

The adapter generates a XML document as output:

<?xml version="1.0" encoding="UTF-8"?>
<output>
   <response>
      <num_deleted>3</num_deleted>
   </response>
</output>

The following elements can be contained in the output:

Element

Description

Output

Enclosing element for the output of the operation Remove-Documents

response

Enclosing element for the element num_deleted.

num_deleted

Number of deleted documents.

"invalid_keys": [...]: Specifies if the sourceKey in the input is invalid.