Server API - Get Preset List

Last Updated: Dec 16, 2014 03:22PM PST
Returns a collection of preset meta-data (descriptive information) about presets in the Squeeze Server preset library. The actual preset data is not returned.
 
Base URI /api/presets/info/?filter={filter}&sortby={sortby}&unpub={unpublished}
Protocol HTTP
HTTP Method GET
Response Formats XML, JSON
Help URL /api/presets/help/operations/GetLocalCollection


Common Parameters
Name Required Description
filter No Restrict results to presets that produce output files with the desired extension(s) and match given workflow(s), if any. For example, filter=ext=mp4,ext=mov,workflow=%Adaptive% will return all presets that produce mp4 or mov files, and whose workflow has Adaptive in the name. To return all presets, do not supply a filter parameter. Both ext and workflow filter parameters can be specified as a string matching pattern. String pattern syntax is documented at http://msdn.microsoft.com/en-us/library/ms179859.aspx.
sortby No Sorting for the results. By default, results are sorted by the preset name in ascending order. The syntax for the sort is: fieldname[order] where fieldname must be a valid field from the results, and order must be asc (ascending) or desc (descending).
unpublished No Indicate to return both published and unpublished presets. By default or if unpublished is false, only published presets will be returned. unpublished=true will return both published and unpublished presets.


Response Data Fields
Name Data Type Required Description
PresetInfoList Element Yes Top level container for the list of preset information (XML)
PresetInfo Element No Container of preset information, if any
Created DateTime Yes Date the preset was created (GMT)
Description String Yes The description pulled from the preset data, if any
Extension String Yes The default file extension the preset will produce (ie: mov, flv, mp4). Note that a preset may produce a different file type in some cases.
Id Guid Yes Unique ID for the new preset
Modified DateTime Yes The date and time the preset was last modified
Name String Yes The preset name extracted from the preset XML data
Published Boolean Yes Indicates if the preset is published (publicly available) or not published (not publicly available )
Uri String Yes The URL for the preset. Squeeze Server and other clients can request the preset data with this URL.
Workflow String Yes The workflow string for the preset. Extracted from the preset data if present.


Example cURL call:
curl -H "Accept: application/xml" -H "x-Authorization: Basic YWRtaW46YWRtaW4="
http:///api/presets/info/
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