Description
Deletes all the items in the view.
WARNING
This operation is permanent!
URL parameters
| Name | Required | Type | Description |
|---|---|---|---|
ViewID |
True | numeric | Unique identifier of the view. |
JobID |
False | numeric | Unique identifier of the job. |
ItemStatusIncludeColumn |
False | boolean | Yes, No – Yes to include the column in the data file. Default is No. See additional options below. |
ViewParameter.<ParameterName> |
False | string | Used for dynamic view criteria. E.g. criterion: Name Equals %NameValue% can be set with ViewParameter.NameValue=Michael . |
Optional parameters for ItemStatusInclude
| Name | Required | Type | Description |
|---|---|---|---|
ItemStatusIncludeAdded |
False | boolean | Yes, No. Include added items. |
ItemStatusIncludeChanged |
False | boolean | Yes, No. Include changed items. |
ItemStatusIncludeUnchanged |
False | boolean | Yes, No. Include unchanged items. |
ItemStatusIncludeDeleted |
False | boolean | Yes, No. Include deleted items. |
Responses
| Name | Type | Description |
|---|---|---|
Result |
string | Success if the operation was successful. |
ItemsDeleted |
numeric | Total number of items deleted. |
Sample request
curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=View.DeleteItems&ViewID=1009'
Sample responses
XML
<?xml version="1.0" encoding="utf-8" ?>
<ViewDeleteItemsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Result>Success</Result>
<ItemsDeleted>67</ItemsDeleted>
</ViewDeleteItemsResponse>
JSON (add &ResponseFormat=JSON)
{
"ItemsDeleted": 67,
"JsonResult": {
"Command": "View.DeleteItems",
"AutoLoggedIn": false,
"WebConsoleKey": "",
"Result": "Success",
"ErrorCode": "",
"ErrorDescription": "",
"ErrorList": [],
"ExecutionTime": {
"Ticks": 0,
"Days": 0,
"Hours": 0,
"Milliseconds": 0,
"Minutes": 0,
"Seconds": 0,
"TotalDays": 0,
"TotalHours": 0,
"TotalMilliseconds": 0,
"TotalMinutes": 0,
"TotalSeconds": 0
}
}
}