Description
Allows users to export a view.
URL parameters
URL parameter ordering
The URL parameters below are listed in the order they should be entered in the API URL.
| Name | Required | Type | Description |
|---|---|---|---|
ViewID |
True | numeric | Unique identifier of the view. |
FileFormat |
False | string | CSV, TSV, XML, JSON, and XLSX. Default is CSV. |
CollectionID |
False | numeric | Unique identifier of the collection. REQUIRED if the view is a shared view in an agent group. |
ViewParameter.JobID |
False | string | The JobID that you want the items pulled from. |
ViewParameter.<ParameterName> |
False | string | Used for dynamic view criteria. E.g. criterion:Name Equals %NameValue% can be set with ViewParameter.NameValue=Michael. |
ItemStatusInclueColumn |
False | boolean | Yes, No – Yes to include the column in the data file. Default is No. See additional options below. |
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. |
ItemStatusIncludeChangeMarkup |
False | boolean | Yes, No. Include a column with the changed markup. |
Responses
Automatically download the file for the selected view.
Sample request
curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=View.Export&ViewID=153888