GET imcc/v1/workflows/
Get workflow list.
Resource URL
https://{MEDIACONTROLCENTRE_HOST}[:PORT]/imcc/v1/workflows/
Resource Information
| Response formats | XML (default) or JSON |
| Requires authentication? | Yes (user context only) |
| Required scope | createJobs |
Response
Returns list of workflows the user is allowed to use in XML format on success (OR JSON if your standard HTTP Accept header specified application/json). Returns standard error response on failure.
Workflow details:-
<Workflow>
<ID></ID><!-- unique ID of the workflow -->
<Name></Name><!-- workflow name -->
<Description></Description><!-- further description of the workflow -->
<DateCreated></DateCreated><!-- date the workflow was created -->
<UsageType></UsageType><!-- OnIngest (this workflow can be used to ingest media),
Order (this workflow can be used when ordering media),
Task (this workflow performs a task on media as opposed to ingesting it),
GeneralUse (this workflow can be used for both OnIngest and Task actions),
RegenerateKeyImages (this workflow can only be used to regenerate thumbnail and reference images when the key frame of a media object is changed in ImagenWeb) -->
<MediaTypes></MediaTypes><!-- comma separated list of media type(s) which are valid for this Workflow
Valid media types include 'Video', 'Audio', 'Image', 'Stills", 'Thumbnail', 'Subtitles', 'Document', 'HLS' -->
<FileExtensions></FileExtensions><!-- json array string of Media Type => comma separated list of file extensions and mime types valid for this Workflow (if Ingest or GeneralUse) -->
<FieldInputs></FieldInputs><!-- for internal use only -->
<CanClip></CanClip><!-- true if workflow can be used to process clips -->
<ClipOnly></ClipOnly><!-- true if workflow can ONLY be used to process clips -->
</Workflow>
Example Request - XML
curl -i -H "X-Imagen-API-Key: {APPLICATION API KEY}" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-X GET https://{MEDIACONTROLCENTRE_HOST}[:PORT]/imcc/v1/workflows
Example Result - XML
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Workflows>
<Workflow>
<ID>FCEBA309-4BA2-4b78-9A9E-3201353AA53E</ID>
<Name>Ingest Video</Name>
<Description>Produces HLS video rendition, thumbnail stills every 5 seconds as well as a thumbnail and reference image.</Description>
<DatabaseID>2</DatabaseID>
<DateCreated>2014-06-19 09:56:53</DateCreated>
<UsageType>GeneralUse</UsageType>
<MediaTypes>Video</MediaTypes>
<FileExtensions></FileExtensions>
<FieldInputs></FieldInputs>
<CanClip>false</CanClip>
<ClipOnly>false</ClipOnly>
</Workflow>
<Workflow>
<ID>48E2A4A2-2B22-4973-8976-128B39F4EE47</ID>
<Name>Order clip</Name>
<Description>Produces a MOV for your order</Description>
<DatabaseID>2</DatabaseID>
<DateCreated>2014-06-19 09:56:53</DateCreated>
<UsageType>Order</UsageType>
<MediaTypes>Video</MediaTypes>
<FileExtensions></FileExtensions>
<FieldInputs></FieldInputs>
<CanClip>true</CanClip>
<ClipOnly>false</ClipOnly>
</Workflow>
<Workflow>
<ID>09F160E6-23D3-40f6-9DCE-E9354C58A8F2</ID>
<Name>Store Only Image</Name>
<Description>Just store the Image and extract media object metadata where necessary</Description>
<DatabaseID>2</DatabaseID>
<DateCreated>2014-06-19 09:56:53</DateCreated>
<UsageType>OnIngest</UsageType>
<MediaTypes>Image</MediaTypes>
<FileExtensions></FileExtensions>
<FieldInputs></FieldInputs>
<CanClip>false</CanClip>
<ClipOnly>false</ClipOnly>
</Workflow>
<Workflow>
<ID>5039C6BF-2327-4cb2-987B-A295B954579C</ID>
<Name>Store Only Video</Name>
<Description>Just store the Video and extract media object metadata where necessary</Description>
<DatabaseID>2</DatabaseID>
<DateCreated>2014-09-04 12:57:35</DateCreated>
<UsageType>OnIngest</UsageType>
<MediaTypes>Video</MediaTypes>
<FileExtensions></FileExtensions>
<FieldInputs></FieldInputs>
<CanClip>false</CanClip>
<ClipOnly>false</ClipOnly>
</Workflow>
</Workflows>
</Response>
Example Request - JSON
curl -i -H "X-Imagen-API-Key: {APPLICATION API KEY}" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "Accept: application/json" \
-X GET https://{MEDIACONTROLCENTRE_HOST}[:PORT]/imcc/v1/workflows
Example Result - JSON
{
"Workflow": [
{
"ID": "FCEBA309-4BA2-4b78-9A9E-3201353AA53E",
"Name": "Ingest Video",
"Description": "Produces HLS video rendition, thumbnail stills every 5 seconds as well as a thumbnail and reference image.",
"DatabaseID": 2,
"DateCreated": "2014-06-19 09:56:53",
"UsageType": "GeneralUse",
"MediaTypes": "Video",
"FileExtensions": "",
"FieldInputs": "",
"CanClip": false,
"ClipOnly": false
},
{
"ID": "48E2A4A2-2B22-4973-8976-128B39F4EE47",
"Name": "Order clip",
"Description": "Produces a MOV for your order",
"DatabaseID": 2,
"DateCreated": "2014-06-19 09:56:53",
"UsageType": "Order",
"MediaTypes": "Video",
"FileExtensions": "",
"FieldInputs": "",
"CanClip": true,
"ClipOnly": false
},
{
"ID": "09F160E6-23D3-40f6-9DCE-E9354C58A8F2",
"Name": "Store Only Image",
"Description": "Just store the Image and extract media object metadata where necessary",
"DatabaseID": 2,
"DateCreated": "2014-06-19 09:56:53",
"UsageType": "OnIngest",
"MediaTypes": "Image",
"FileExtensions": "",
"FieldInputs": "",
"CanClip": false,
"ClipOnly": false
},
{
"ID": "5039C6BF-2327-4cb2-987B-A295B954579C",
"Name": "Store Only Video",
"Description": "Just store the Video and extract media object metadata where necessary",
"DatabaseID": 2,
"DateCreated": "2014-09-04 12:57:35",
"UsageType": "OnIngest",
"MediaTypes": "Video",
"FileExtensions": "",
"FieldInputs": "",
"CanClip": false,
"ClipOnly": false
}
]
}