REST API

/{version}/saved-queries/{id}/export

The following operations are supported on this resource:

GET

Exports the search results of a saved query that matches the ID provided in the request If no such saved query exist, a 404 HTTP Status will be returned.

Parameters

name description type default
id The id of the saved query you would like to search and export the results from. path
size The size of the search results you would like to export. The size of the export will be capped at a maximum of the value set in the 'clarity.advancedSearch.result.max' property in the property table. query

Output Payload

element produceable content type(s)
(custom)
  • application/csv
description
The system returns a response that includes the CSV results as an attachment.

/{version}/saved-queries/{id}/export

Home

REST Endpoints

XML Data Elements

XML Data Types