View details on the jobs currently running
Resource URL
https://{MEDIACONTROLCENTRE_HOST}[:PORT]/imcc/v1/job/list
Response formats | XML, JSON |
Requires authentication? | Yes |
Required scope(s) | managejobs |
π‘Pro tip: Gets job list. You can get active or failed jobs or both. This endpoint will only return jobs that Imagen is currently processing or has recently processed.
Parameters
There are no parameters for this call
Example REST request
https://{MEDIACONTROLCENTRE_HOST-FQDN}:83/imcc/v1/job/list
Example Response
Returns success or an error response on failure.
Response on success
{
"totalActiveJobs": "65",
"timeLimit": 1649344307,
"refreshTime": 1649344335,
"Resources": [
{
"Resource": "CIS_GraphicsMagickElement",
"Name": "Image Converter",
"NumActive": "2",
"NumQueued": "63"
},
{
"Resource": "CIS_RetrieveMedia",
"Name": "Media Retriever",
"NumActive": "0",
"NumQueued": "0"
},
{
"Resource": "CIS_TranscoderElement",
"Name": "Transcoder",
"NumActive": "0",
"NumQueued": "0"
},
{
"Resource": "StorageQueue",
"Name": "Stores",
"NumActive": "0",
"NumQueued": "0"
}
],
"Jobs_0": [
{
"ID": "76C97A88-FD41-4149-BBA7-774EDEB43E6B",
"SchemaID": "3A2CF2CF-027A-43e7-9AD9-CAB4DD0FBC1D",
"SchemaName": "Ingest Image",
"UserID": "4",
"UserEmail": "superadmin@imagenevp.com",
"JobName": "Upload Job",
"TotalProgress": 31.666667,
"StartTime": "2022-04-07T15:12:15",
"LastChangedTime": "2022-04-07T15:12:15",
"State": 5,
"CurrentElement": "Image Converter",
"Progress": 0,
"DescriptiveProgress": "Waiting for Resource",
"RetryCount": 0,
"CanRetryNow": false,
"GlobalInput": [
{
"ID": 1,
"Name": "Record ID",
"Type": "Int",
"SubType": "Record_ID",
"Value": "81"
},
{
"ID": 2,
"Name": "Media ID",
"Type": "Int",
"SubType": "Media_ID",
"Value": "125"
}
]
}
"Jobs_1": []
}
Response when no jobs are running
{
"totalActiveJobs": "0",
"timeLimit": 0,
"refreshTime": 1649345396,
"Resources": [
{
"Resource": "CIS_GraphicsMagickElement",
"Name": "Image Converter",
"NumActive": "0",
"NumQueued": "0"
},
{
"Resource": "CIS_RetrieveMedia",
"Name": "Media Retriever",
"NumActive": "0",
"NumQueued": "0"
},
{
"Resource": "CIS_TranscoderElement",
"Name": "Transcoder",
"NumActive": "0",
"NumQueued": "0"
},
{
"Resource": "StorageQueue",
"Name": "Stores",
"NumActive": "0",
"NumQueued": "0"
}
],
"Jobs_0": [],
"Jobs_1": []
}
Response on failure
Standard failure response