Overview | Service | Command |
Attempts to delete a search task.
Returns empty <DeleteXMbxSearchResponse/> element on success or Fault document on error.
Network edition only API | TRUE |
Authorization token required | true |
Admin Authorization token required | true |
<DeleteXMbxSearchRequest> ## DeleteXMbxSearchRequest
<searchtask searchID="{search-id} (int)" /> ## SearchID
<account by="{acct-selector-by} (adminName|appAdminName|id|foreignPrincipal|name|krb5Principal)">{key}</account> ## AccountSelector
</DeleteXMbxSearchRequest>
The following table describes elements and attributes you can define within a
<DeleteXMbxSearchRequest>
element:
XPath | Required / Optional | Description |
/searchtask | Required (only 1) | Search task information |
/searchtask@searchID | Required (only 1) | Type:int Search ID |
/account | Optional (0 or 1) | Type:{key} Account Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by} |
/account@by | Required (only 1) | Type:adminName|appAdminName|id|foreignPrincipal|name|krb5Principal Select the meaning of {acct-selector-key} |
<DeleteXMbxSearchResponse /> ## DeleteXMbxSearchResponse