Server API - Get Preset Info by Workflow

Last Updated: Dec 16, 2014 03:23PM PST
Returns a collection of preset meta-data (descriptive information) about presets in the Squeeze Server preset library based on the workflow pattern. The actual preset data is not returned. You can specify as much or as little of a workflow string as you wish. For example, if you specify just the workflow /web/ then information about all web presets will be returned. If you specify the root workflow and a sub category, such as /web/flash 8/ then all presets that have a workflow that starts with /web/flash 8/ will be returned, such as /web/flash 8/streaming/ and /web/flash 8/progressive/.

Base URI /api/presets/info/workflow/{workflow}/?unpub={unpublished}
/api/presets/info/workflow/{workflow}/{subcategory}//?unpub={unpublished}
/api/presets/info/workflow/{workflow}/{subcategory}/{subsub}//?unpub={unpublished}
/api/presets/info/workflow/{workflow}/{subcategory}/{subsub}/{subsubsub}/?unpub={
unpublished}
Protocol HTTP
HTTP Method GET
Response
Formats
XML, JSON
Help URL /api/presets/help/operations/GetLocalCollectionByMatching4Strings

Common Parameters
Name Required Description
workflow Yes The root workflow to return
subcategory No workflow sub-category to match
subsub No Next level in the workflow hierarchy.
subsubsub No Next level in the workflow hierarchy.
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.

Request Data Fields
None

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 yet)
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 “Accetp: application/xml” –H “x-Authorization: Basic YWRtaW46YWRtaW4” –X GET
http://<host>/api/presets/info/workflow/<workflowString>/
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