Retrieve inventory template

Get inventory template

GET https://ris.rightsline.com/v4/inventory-templates/:id

This endpoint allows you to retrieve an inventory template.

Path Parameters

Name	Type	Description
id	number	Template ID.

Headers

Name	Type	Description
x-api-key	string	Your company's API key.
Authentication	string	Authentication token.

200 Template successfully retrieved.

{
    "fields": [
        {
            "fieldName": "Inventory Template",
            "label": "entity_template",
            "required": true,
            "maxLength": 1000,
            "editable": false,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 8,
            "listOfValues": []
        },
        {
            "fieldName": "Inventory Item Name",
            "label": "entity_title",
            "required": true,
            "maxLength": 500,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 3,
            "listOfValues": []
        },
        {
            "fieldName": " File Format Type",
            "label": "file_format_type",
            "required": false,
            "maxLength": 100,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 15,
            "listOfValues": [
                {
                    "id": 1,
                    "label": "SD",
                    "childValues": []
                },
                {
                    "id": 2,
                    "label": "HD",
                    "childValues": []
                },
                {
                    "id": 3,
                    "label": "UHD",
                    "childValues": []
                }
            ]
        },
        {
            "fieldName": " Audio Bitrate Kbps",
            "label": "audio_bitrate_kbps",
            "required": false,
            "maxLength": 100,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 13,
            "listOfValues": [
                {
                    "id": 1,
                    "label": "your label here",
                    "childValues": []
                },
                {
                    "id": 3,
                    "label": "320",
                    "childValues": []
                },
                {
                    "id": 2,
                    "label": "96",
                    "childValues": []
                },
                {
                    "id": 5,
                    "label": "320kbps",
                    "childValues": []
                },
                {
                    "id": 6,
                    "label": "JRNEWbitrate",
                    "childValues": []
                }
            ]
        }
    ],
    "templateId": 6,
    "templateName": "Digital Media",
    "systemIndicatorId": 0,
    "processId": 16,
    "processName": "Inventory Workflow",
    "parentRelationships": [
        {
            "charTypeID": 1,
            "templateID": 12,
            "templateName": "Series",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 1,
            "templateID": 1,
            "templateName": "Feature",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        }
    ],
    "childRelationships": [
        {
            "charTypeID": 1,
            "templateID": 1,
            "templateName": "Feature",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 1,
            "templateID": 25,
            "templateName": "Version",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        }
    ],
    "partyRelationships": [
        {
            "partyID": 14,
            "partyName": "Department",
            "partyGroup": {
                "partyGroupID": 0
            },
            "sequenceNumber": 1,
            "isPrimary": false,
            "allowMultiple": true,
            "required": true,
            "systemIndicatorID": 0,
            "allowedTemplates": [
                {
                    "templateId": 1,
                    "templateName": "Person",
                    "systemIndicatorId": 0,
                    "processId": 0
                },
                {
                    "templateId": 2,
                    "templateName": "Company",
                    "systemIndicatorId": 0,
                    "processId": 0
                },
                {
                    "templateId": 4,
                    "templateName": "Corporate",
                    "systemIndicatorId": 0,
                    "processId": 0
                }
            ]
        }
    ]
}

404: Not Found Template not found.

{
    "message": "Resource Not Found"
}