Overview

This command is used to retrieve information about the contents saved into the MMS repository.

URI

catramms/v1/mediaItems/[:mediaItemKey]/?[:start]&[:rows]&[:contentType]&[:startIngestionDate]&[:endIngestionDate]

Method

POST

URL Params

Required

None

Optional

Payload Data

See the JSON format of the command it is ingesting

Success Response

Code

200 OK ### Content The API returns information about the contents satisfying the conditions identified by the URL parameters.

{
    "requestParameters" : 
    {
        "rows" : 10,
        "start" : 0
    },
    "response" : 
    {
        "mediaItems" : 
        [
            {
                "contentType" : "Video",
                "endPublishing" : "2028-06-05T12:31:07Z",
                "ingester" : null,
                "ingestionDate" : "2018-06-08T12:31:07Z",
                "keywords" : null,
                "mediaItemKey" : 8,
                "physicalPaths" : 
                [
                    {
                        "creationDate" : "2018-06-08T12:31:07Z",
                        "encodingProfileKey" : null,
                        "physicalPathKey" : 35,
                        "sizeInBytes" : 60974821
                    },
                    {
                        "creationDate" : "2018-06-08T12:32:18Z",
                        "encodingProfileKey" : 7,
                        "physicalPathKey" : 36,
                        "sizeInBytes" : 14748930
                    },
                    {
                        "creationDate" : "2018-06-08T12:42:30Z",
                        "encodingProfileKey" : 8,
                        "physicalPathKey" : 37,
                        "sizeInBytes" : 27487750
                    },
                    {
                        "creationDate" : "2018-06-08T12:45:29Z",
                        "encodingProfileKey" : 9,
                        "physicalPathKey" : 38,
                        "sizeInBytes" : 27491833
                    },
                    {
                        "creationDate" : "2018-06-08T12:51:54Z",
                        "encodingProfileKey" : 10,
                        "physicalPathKey" : 39,
                        "sizeInBytes" : 19282793
                    }
                ],
                "providerName" : "default",
                "retentionInMinutes" : 60,
                "startPublishing" : "2018-06-08T12:31:07Z",
                "title" : "My Title of the video content",
                "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
                }
            }
        ],
        "numFound" : 1
    }
}

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/mediaItems?start=0&rows=1&contentType=video&startIngestionDate=2018-04-26T07:19:11Z&endIngestionDate=2018-04-26T07:20:11Z"

or

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