Server API - Get Preset Info

Last Updated: Dec 16, 2014 03:22PM PST
Get location information and description for the named preset.
 
Base URI /api/presets/info/{name}/?unpub={unpublished}
Protocol HTTP
HTTP Method GET
Response Formats XML, JSON
Help URL /api/presets/help/operations/GetPresetInfo


Common Parameters
Name Required Value and Notes
Name Yes Name or unique ID of the preset. Unique Preset ID is preferred.
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
PresetInfo Element Yes Container for preset information data.
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 Published 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://<host>/api/presets/info/<Preset_GUID>/
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