Server API - Get Preset Data

Last Updated: Dec 16, 2014 03:22PM PST
Get preset data by preset name or Unique ID, and returns with the content type based on format, such as 'xml' (default), 'raw', or 'spfx'.
 
Base URI /api/presets/{name}/?format={format}
Protocol HTTP
HTTP Method GET
Response Formats Preset Data (XML or Raw)
Help URL /api/presets/help/operations/GetPresetData
Authentication: None


Common Parameters
Name Required Description
name Yes Unique preset ID or preset name. For best results, use the unique preset ID whenever possible.
format No The format for the returned data:
  • xml(default): If you leave off format, or supply format=xml, the response type will be text/xml
  • spfx: if format=spfx, the preset will be returned as a .spfx file with a content disposition of preset-name.spfx and a content type of text/xml
  • raw: If format=raw, the preset will be returned as an ordinary byte stream.


Request Data Fields
None


Response Data Fields
The response is returned as a stream with Content-Type of text/xml and Content-disposition set based on the format parameter, or as raw data. It is up to the caller to process the Preset XML data.


Example cURL call:
curl -H "Accept: application/xml" -H "x-Authorization: Basic YWRtaW46YWRtaW4="
http://<host>/api/presets/0a6b0bc0-ac07-4fd5-9766-dd75e2a2bb7d/?format=xml
squeezesupport@sorensonmedia.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete