Standards and extra support REST interface

RESTful API for the Video, Audio and Image standards

Resource GET /API/v1/standards/aspectratio/

Supported AspectRatio for use in the system.

Response Format:
JSON
Resource URL:
/API/v1/standards/aspectratio/
Schema URL:
/API/v1/standards/aspectratio/schema/

Permission Required:

vidispine

Example response (Status Code 200):

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "height_ratio": 9,
            "id": "4",
            "pixel_type": "square",
            "resource_uri": "/API/v1/standards/aspectratio/4/",
            "width_ratio": 16
        }
    ]
}

Resource GET /API/v1/standards/audiocodec/

Supported Audio Codec for use in the system.

Response Format:
JSON
Resource URL:
/API/v1/standards/audiocodec/
Schema URL:
/API/v1/standards/audiocodec/schema/
Permission Required:
vidispine

Example response (Status Code 200):

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 8
    },
    "objects": [
        {
            "id": "1",
            "name": "aac",
            "resource_uri": "/API/v1/standards/audiocodec/1/"
        },
        {
            "id": "8",
            "name": "aes3",
            "resource_uri": "/API/v1/standards/audiocodec/8/"
        },
        {
            "id": "2",
            "name": "libmp3lame",
            "resource_uri": "/API/v1/standards/audiocodec/2/"
        },
        {
            "id": "3",
            "name": "libvorbis",
            "resource_uri": "/API/v1/standards/audiocodec/3/"
        },
        {
            "id": "4",
            "name": "mp2",
            "resource_uri": "/API/v1/standards/audiocodec/4/"
        },
        {
            "id": "5",
            "name": "pcm_s16le",
            "resource_uri": "/API/v1/standards/audiocodec/5/"
        },
        {
            "id": "6",
            "name": "pcm_s24le",
            "resource_uri": "/API/v1/standards/audiocodec/6/"
        },
        {
            "id": "7",
            "name": "pcm_s32le",
            "resource_uri": "/API/v1/standards/audiocodec/7/"
        }
    ]
}

Resource GET /API/v1/standards/format/

Supported Formats for use in the system.

Response Format:
JSON
Resource URL:
/API/v1/standards/format/
Schema URL:
/API/v1/standards/format/schema/
Permission Required:
vidispine

Example response (Status Code 200):

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 13
    },
    "objects": [
        {
            "id": "1",
            "media_type": "video",
            "name": "mp4",
            "resource_uri": "/API/v1/standards/formats/1/"
        },
        {
            "id": "2",
            "media_type": "audio",
            "name": "mp4",
            "resource_uri": "/API/v1/standards/formats/2/"
        },
        {
            "id": "3",
            "media_type": "audio",
            "name": "mp3",
            "resource_uri": "/API/v1/standards/formats/3/"
        },
        {
            "id": "4",
            "media_type": "video",
            "name": "flv",
            "resource_uri": "/API/v1/standards/formats/4/"
        },
        {
            "id": "5",
            "media_type": "video",
            "name": "3gp",
            "resource_uri": "/API/v1/standards/formats/5/"
        },
        {
            "id": "6",
            "media_type": "image",
            "name": "png",
            "resource_uri": "/API/v1/standards/formats/6/"
        },
        {
            "id": "7",
            "media_type": "image",
            "name": "jpg",
            "resource_uri": "/API/v1/standards/formats/7/"
        },
        {
            "id": "8",
            "media_type": "video",
            "name": "avi",
            "resource_uri": "/API/v1/standards/formats/8/"
        },
        {
            "id": "9",
            "media_type": "video",
            "name": "mov",
            "resource_uri": "/API/v1/standards/formats/9/"
        },
        {
            "id": "10",
            "media_type": "video",
            "name": "mxf",
            "resource_uri": "/API/v1/standards/formats/10/"
        },
        {
            "id": "11",
            "media_type": "video",
            "name": "ogg",
            "resource_uri": "/API/v1/standards/formats/11/"
        },
        {
            "id": "12",
            "media_type": "video",
            "name": "dv",
            "resource_uri": "/API/v1/standards/formats/12/"
        },
        {
            "id": "13",
            "media_type": "video",
            "name": "webm",
            "resource_uri": "/API/v1/standards/formats/13/"
        }
    ]
}

Resource GET /API/v1/standards/resolution/

Supported Resolutions for use in the system.

Response Format:
JSON
Resource URL:
/API/v1/standards/resolution/
Schema URL:
/API/v1/standards/resolution/schema/
Permission Required:
vidispine

Example response (Status Code 200):

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 14
    },
    "objects": [
        {
            "id": "8",
            "name": "1280x720",
            "resource_uri": "/API/v1/standards/resolution/8/"
        },
        {
            "id": "9",
            "name": "1440x1080",
            "resource_uri": "/API/v1/standards/resolution/9/"
        },
        {
            "id": "11",
            "name": "1828x1332",
            "resource_uri": "/API/v1/standards/resolution/11/"
        },
        {
            "id": "10",
            "name": "1920x1080",
            "resource_uri": "/API/v1/standards/resolution/10/"
        },
        {
            "id": "12",
            "name": "2048x1556",
            "resource_uri": "/API/v1/standards/resolution/12/"
        },
        {
            "id": "1",
            "name": "320x240",
            "resource_uri": "/API/v1/standards/resolution/1/"
        },
        {
            "id": "13",
            "name": "3656x2664",
            "resource_uri": "/API/v1/standards/resolution/13/"
        },
        {
            "id": "14",
            "name": "4096x3112",
            "resource_uri": "/API/v1/standards/resolution/14/"
        },
        {
            "id": "2",
            "name": "480x360",
            "resource_uri": "/API/v1/standards/resolution/2/"
        },
        {
            "id": "3",
            "name": "640x360",
            "resource_uri": "/API/v1/standards/resolution/3/"
        },
        {
            "id": "4",
            "name": "720x480",
            "resource_uri": "/API/v1/standards/resolution/4/"
        },
        {
            "id": "5",
            "name": "720x486",
            "resource_uri": "/API/v1/standards/resolution/5/"
        },
        {
            "id": "6",
            "name": "720x576",
            "resource_uri": "/API/v1/standards/resolution/6/"
        },
        {
            "id": "7",
            "name": "960x720",
            "resource_uri": "/API/v1/standards/resolution/7/"
        }
    ]
}

Resource GET /API/v1/standards/standard/

Supported Standard for use in the system. CURRENTLY UNUSED

Response Format:
JSON
Resource URL:
/API/v1/standards/standard/
Schema URL:
/API/v1/standards/standard/schema/
Permission Required:
vidispine

Resource GET /API/v1/standards/videocodec/

Supported VideoCodecs for use in the system.

Response Format:
JSON
Resource URL:
/API/v1/standards/videocodec/
Schema URL:
/API/v1/standards/videocodec/schema/
Permission Required:
vidispine

Example response (Status Code 200):

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 11
    },
    "objects": [
        {
            "id": "4",
            "name": "dvvideo",
            "resource_uri": "/API/v1/standards/videocodec/4/"
        },
        {
            "id": "3",
            "name": "flv",
            "resource_uri": "/API/v1/standards/videocodec/3/"
        },
        {
            "id": "2",
            "name": "h264",
            "resource_uri": "/API/v1/standards/videocodec/2/"
        },
        {
            "id": "5",
            "name": "libtheora",
            "resource_uri": "/API/v1/standards/videocodec/5/"
        },
        {
            "id": "11",
            "name": "libvpx",
            "resource_uri": "/API/v1/standards/videocodec/11/"
        },
        {
            "id": "1",
            "name": "libx64",
            "resource_uri": "/API/v1/standards/videocodec/1/"
        },
        {
            "id": "6",
            "name": "mpeg1video",
            "resource_uri": "/API/v1/standards/videocodec/6/"
        },
        {
            "id": "7",
            "name": "mpeg2video",
            "resource_uri": "/API/v1/standards/videocodec/7/"
        },
        {
            "id": "8",
            "name": "vc1",
            "resource_uri": "/API/v1/standards/videocodec/8/"
        },
        {
            "id": "9",
            "name": "vp6f",
            "resource_uri": "/API/v1/standards/videocodec/9/"
        },
        {
            "id": "10",
            "name": "wmv3",
            "resource_uri": "/API/v1/standards/videocodec/10/"
        }
    ]
}

Resource GET /API/v1/exportlocation/

Export locations on the system.

Response Format:
JSON
Resource URL:
/API/v1/exportlocation/
Schema URL:
/API/v1/exportlocation/schema/
Permission Required:
vidispine
class portal.vidispine.api.AspectRatioResource(api_name=None)
authorized_read_list(object_list, bundle)

Limit this to users with the vidispine or superuser privilege…

class portal.vidispine.api.AudioCodecResource(api_name=None)
authorized_read_list(object_list, bundle)

Limit this to users with the vidispine or superuser privilege…

class portal.vidispine.api.ExportLocationResource(api_name=None)
class portal.vidispine.api.FormatResource(api_name=None)
authorized_read_list(object_list, bundle)

Limit this to users with the vidispine or superuser privilege…

class portal.vidispine.api.ResolutionResource(api_name=None)
authorized_read_list(object_list, bundle)

Limit this to users with the vidispine or superuser privilege…

class portal.vidispine.api.StandardResource(api_name=None)
authorized_read_list(object_list, bundle)

Limit this to users with the vidispine or superuser privilege…

class portal.vidispine.api.VideoCodecResource(api_name=None)
authorized_read_list(object_list, bundle)

Limit this to users with the vidispine or superuser privilege…