Web Services Developer's Guide → Web Services API Reference → SBM Application Web Services → Application Calls → DeleteItems
This service uses the delete transition to delete multiple items.
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. |
itemID (required) | ItemIdentifier | The item or items that you want to delete. |
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. |
An empty XML response is returned and the items are deleted using the default delete transition. Failure will not delete items.
<ae:DeleteItemsResponse></ae:DeleteItemsResponse>
This call permanently deletes the primary or auxiliary items you specify. Any items referring to these items will be reduced or set to (None). All items in the list are processed. If any failures occur, each successive error message is appended to the string that is returned. Multiple error messages are separated by a single newline. Failures do not result in a return before all items have been processed.
The following XML is a snippet of the payload being sent with DeleteItems.
<urn:DeleteItems> <urn:auth> <urn:userId>admin</urn:userId> <urn:password></urn:password> <urn:hostname>localhost</urn:hostname> </urn:auth> <urn:itemId> <urn:displayName></urn:displayName> <urn:id></urn:id> <urn:uuid></urn:uuid> <urn:tableId></urn:tableId> <urn:tableIdItemId>1000:153</urn:tableIdItemId> <urn:issueId></urn:issueId> </urn:itemId> <urn:itemId> <urn:displayName></urn:displayName> <urn:id>154</urn:id> <urn:uuid></urn:uuid> <urn:tableId>1000</urn:tableId> <urn:tableIdItemId></urn:tableIdItemId> <urn:issueId></urn:issueId> </urn:itemId> <urn:options> <urn:extraOption></urn:extraOption> <urn:multiOption>CONTINUE-ON-FAILURE</urn:multiOption> </urn:options> </urn:DeleteItems>
Copyright © 2007–2017 Serena Software, Inc. All rights reserved.