DeleteItemsByQuery

Description

This service deletes all the items that match the specified where clause.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
table (required)	TableIdentifier	Specifies the table in which items are deleted.
queryWhereClause (required)	string	An SQL statement to find items with TS_ID>0. Sending an empty where clause will delete all items.
options	MultipleOptions	Holds name value pairing for future elements and enumeration to determine if the service should stop on failure and send an error message or continue processing.

Response

An empty XML response is returned and the items are deleted using the default delete transition. Failure will not delete items.

<ae:DeleteItemByQueryResponse></ae:DeleteItemsByQueryResponse>

Usage

This call permanently deletes the primary or auxiliary items you specify. Any items referring to these items will be reduced or set to (None). The items that are deleted are determined via the table and where clause.

Note: You need only pass the conditions in the where clause itself. For example:

<urn:queryWhereClause>TS_ISSUEID LIKE '00106' OR TS_ISSUEID LIKE '00029'
 OR TS_ISSUEID LIKE '00105'</urn:queryWhereClause>

<urn:queryWhereClause>TS_ISSUEID='00038'</urn:queryWhereClause>

<urn:queryWhereClause>TS_ID='4'</urn:queryWhereClause>

To delete all items, send a null query:

<urn:queryWhereClause></urn:queryWhereClause>

Faults

Invalid database pointer.
The table ID is not valid.
The user lacks sufficient permission.
The delete transition fails to execute.

XML

The following XML is a snippet of the payload that is sent with DeleteItemsByQuery.

<urn:DeleteItemsByQuery>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
    </urn:auth>
    <urn:table>
        <urn:displayName></urn:displayName>
        <urn:id>1000</urn:id>
        <urn:uuid></urn:uuid>
        <urn:dbName></urn:dbName>
    </urn:table>
    <urn:queryWhereClause>TS_ISSUEID LIKE '000208' OR TS_ISSUEID LIKE '000209'
 OR TS_ISSUEID LIKE '000210'</urn:queryWhereClause>
    <urn:options>
        <urn:extraOption></urn:extraOption>
        <urn:multiOption>CONTINUE-ON-FAILURE</urn:multiOption>
    </urn:options>
</urn:DeleteItemsByQuery>