Overview

The following commands are used to retrieve information about the ingestions.

URI

Method

GET

URL Params

Required

None

Optional

Payload Data

None

Success Response

Code

200 OK

Content

The API returns the identifiers (Keys), labels and the Status about every task of the 'workflow' identified by the IngestionRootKey parameter. Here follows a sample:

{
    "requestParameters" : 
    {
        "ingestionRootKey" : 304,
        "rows" : 10,
        "start" : 0
    },
    "response" : 
    {
        "numFound" : 1,
        "workflows" : 
        [
            {
                "ingestionRootKey" : 304,
                "label" : "1",
                "tasks" : 
                [
                    {
                        "downloadingProgress" : 100,
                        "endIngestion" : "2018-06-09T15:47:37Z",
                        "errorMessage" : null,
                        "ingestionJobKey" : 1143,
                        "ingestionType" : "Add-Content",
                        "label" : "My video",
                        "mediaItemKey" : 14,
                        "physicalPathKey" : null,
                        "startIngestion" : "2018-06-09T15:47:30Z",
                        "status" : "End_TaskSuccess",
                        "uploadingProgress" : null,
                        "videoDetails" : 
                        {
                            "audioBitRate" : 254857,
                            "audioChannels" : 2,
                            "audioCodecName" : "aac",
                            "audioSampleRate" : 48000,
                            "bitRate" : 3711950,
                            "durationInMilliSeconds" : 131000,
                            "videoAvgFrameRate" : "25/1",
                            "videoBitRate" : 3332779,
                            "videoCodecName" : "h264",
                            "videoHeight" : 720,
                            "videoProfile" : "High",
                            "videoWidth" : 1280
                        }
                    },
                    {
                        "endIngestion" : "2018-06-09T15:47:41Z",
                        "errorMessage" : null,
                        "ingestionJobKey" : 1145,
                        "ingestionType" : "Email-Notification",
                        "label" : "",
                        "mediaItemKey" : null,
                        "physicalPathKey" : null,
                        "startIngestion" : "2018-06-09T15:47:30Z",
                        "status" : "End_TaskSuccess"
                    },
                    {
                        "encoding" : 
                        {
                            "encodingFailuresNumber" : 0,
                            "encodingJobEnd" : "2018-06-09T15:51:09Z",
                            "encodingJobStart" : "2018-06-09T15:47:43Z",
                            "encodingProgress" : 100,
                            "encodingStatus" : "End_ProcessedSuccessful",
                            "parameters" : 
                            {
                                "encodingProfileKey" : 17,
                                "sourcePhysicalPathKey" : 80
                            },
                            "type" : "EncodeVideoAudio"
                        },
                        "endIngestion" : "2018-06-09T15:51:09Z",
                        "errorMessage" : null,
                        "ingestionJobKey" : 1144,
                        "ingestionType" : "Encode",
                        "label" : "my label",
                        "mediaItemKey" : 14,
                        "physicalPathKey" : 81,
                        "startIngestion" : "2018-06-09T15:47:30Z",
                        "status" : "End_TaskSuccess",
                        "videoDetails" : 
                        {
                            "audioBitRate" : 163408,
                            "audioChannels" : 2,
                            "audioCodecName" : "aac",
                            "audioSampleRate" : 48000,
                            "bitRate" : 4192079,
                            "durationInMilliSeconds" : 131000,
                            "videoAvgFrameRate" : "30/1",
                            "videoBitRate" : 4020958,
                            "videoCodecName" : "h264",
                            "videoHeight" : 1080,
                            "videoProfile" : "Main",
                            "videoWidth" : 1920
                        }
                    }
                ]
            }
        ]
    }
}

Error Response

See Common Error Responses

Sample Call

Assuming: * UserKey: 5 * APIKey: SU1.8ZO1O2zVeBMNv9lzZ0whABXSAdjWrR~rpcnI5eaHNO2gysrNdAv8BNoWZB1eLP

curl -k -v -u 5:SU1.8ZO1O2zVeBMNv9lzZ0whABXSAdjWrR~rpcnI5eaHNO2gysrNdAv8BNoWZB1eLP https://mms-api.catrasoft.cloud/catramms/v1/ingestionsRoot/304