Templates

All template endpoints operate in the same way, the only difference being the entity type name, or char type, in the URL (see Char types). The main list endpoint provides general information about the available templates. For more detailed information on specific templates, including their fields and relationships, you can add the template ID to the URL. To get even more specific details, such as date alerts, conditional fields, parent group, pick list reference, and system indicators, you can append the label of a field to the URL. Refer to the examples below for more information.

Get template list

GEThttps://ris.rightsline.com/v4/[char type]-templates

Retrieve high level details about the number of templates for a given entity type.

Headers

NameValue

x-api-key

Your company's API key.

Authorization

Authentication token.

Response

{
    "templates": [
        {
            "templateId": 14,
            "templateName": "Bundle/Pack",
            "templateGroupId": 2,
            "templateGroupName": "Collection",
            "systemIndicatorId": 0,
            "processId": 4,
            "processName": "Catalog Workflow"
        },
        {
            "templateId": 12,
            "templateName": "Series",
            "templateGroupId": 1,
            "templateGroupName": "Property",
            "systemIndicatorId": 0,
            "processId": 4,
            "processName": "Catalog Workflow"
        }
    ]
}

Get template details

GEThttps://ris.rightsline.com/v4/[char type]-templates/[template ID]

Retrieve specific details for a given template

Response

{
    "fields": [
        {
            "fieldName": "Template",
            "fieldDescription": "Template",
            "label": "entity_template",
            "required": true,
            "maxLength": 1000,
            "editable": false,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 3,
            "groupName": "System",
            "listOfValues": [],
            "systemIndicatorId": -1
        },
        {
            "fieldName": "Title",
            "fieldDescription": "Catalog Name",
            "label": "entity_title",
            "required": true,
            "maxLength": 500,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 1,
            "groupName": "Overview",
            "listOfValues": [],
            "systemIndicatorId": -1
        },
        {
            "fieldName": "MPAA Rating",
            "fieldDescription": "MPAA Rating",
            "label": "mpaa_rating",
            "required": false,
            "maxLength": 500,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 1,
            "groupId": 4,
            "groupName": "Details",
            "listOfValues": [
                {
                    "id": 1,
                    "label": "G",
                    "childValues": []
                },
                {
                    "id": 2,
                    "label": "PG",
                    "childValues": []
                },
                {
                    "id": 3,
                    "label": "PG-13",
                    "childValues": []
                },
                {
                    "id": 4,
                    "label": "R",
                    "childValues": []
                },
                {
                    "id": 5,
                    "label": "NC-17",
                    "childValues": []
                }
            ],
            "systemIndicatorId": 0
        },
        {
            "fieldName": "Status",
            "fieldDescription": "Status",
            "label": "entity_status",
            "required": false,
            "maxLength": 1000,
            "editable": false,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 2,
            "groupId": 3,
            "groupName": "System",
            "listOfValues": [],
            "systemIndicatorId": -1
        },
        {
            "fieldName": "Salesforce ID",
            "fieldDescription": "",
            "label": "id_salesforce",
            "required": false,
            "maxLength": 18,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 2,
            "groupId": 1,
            "groupName": "Overview",
            "listOfValues": [],
            "systemIndicatorId": 0
        },
        {
            "fieldName": "Runtime",
            "fieldDescription": "",
            "label": "runtime",
            "required": false,
            "maxLength": 10000,
            "editable": true,
            "dataType": "SMPTETimeCode",
            "allowMultiple": false,
            "sequenceNumber": 2,
            "groupId": 4,
            "groupName": "Details",
            "listOfValues": [],
            "systemIndicatorId": 0
        },
        {
            "fieldName": "Revision ID",
            "fieldDescription": "Revision ID",
            "label": "entity_revision_id",
            "required": true,
            "maxLength": 50,
            "editable": false,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 3,
            "groupId": 3,
            "groupName": "System",
            "listOfValues": [],
            "systemIndicatorId": -1
        },
        {
            "fieldName": "Catalog ID",
            "fieldDescription": "ID",
            "label": "entity_id",
            "required": true,
            "maxLength": 10,
            "editable": false,
            "dataType": "Number",
            "allowMultiple": false,
            "sequenceNumber": 3,
            "groupId": 1,
            "groupName": "Overview",
            "listOfValues": [],
            "systemIndicatorId": -1
        },
        {
            "fieldName": "Release Date",
            "fieldDescription": "",
            "label": "initial_air_date",
            "required": false,
            "maxLength": 10000,
            "editable": true,
            "dataType": "Date_US",
            "allowMultiple": false,
            "sequenceNumber": 3,
            "groupId": 4,
            "groupName": "Details",
            "listOfValues": [],
            "systemIndicatorId": 0
        },
        {
            "fieldName": "EIDR",
            "fieldDescription": "EIDR",
            "label": "eidr",
            "required": false,
            "maxLength": 36,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 4,
            "groupId": 1,
            "groupName": "Overview",
            "listOfValues": [],
            "systemIndicatorId": 0
        },
        {
            "fieldName": "M6 Field",
            "fieldDescription": "",
            "label": "m6_field",
            "required": false,
            "maxLength": 10000,
            "editable": true,
            "dataType": "Date_US",
            "allowMultiple": false,
            "sequenceNumber": 4,
            "groupId": 4,
            "groupName": "Details",
            "listOfValues": [],
            "systemIndicatorId": 0
        },
        {
            "fieldName": "Legal Title Name",
            "fieldDescription": "",
            "label": "description",
            "required": false,
            "maxLength": 10000,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": false,
            "sequenceNumber": 5,
            "groupId": 1,
            "groupName": "Overview",
            "listOfValues": [],
            "systemIndicatorId": 0
        },
        {
            "fieldName": "AKA",
            "fieldDescription": "AKA",
            "label": "aka",
            "required": false,
            "maxLength": 250,
            "editable": true,
            "dataType": "AlphaNumericText",
            "allowMultiple": true,
            "sequenceNumber": 6,
            "groupId": 1,
            "groupName": "Overview",
            "listOfValues": [],
            "systemIndicatorId": 0
        }
    ],
    "templateId": 1,
    "templateName": "Feature",
    "templateGroupId": 1,
    "templateGroupName": "Property",
    "systemIndicatorId": 0,
    "processId": 5,
    "processName": "Catalog Workflow",
    "parentRelationships": [
        {
            "charTypeID": 1,
            "templateID": 16,
            "templateName": "Collection",
            "relRecTypeID": 2,
            "relRecTypeDescription": "Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 9,
            "templateName": "Licensed Rights In",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 2,
            "templateName": "Rights Out",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 4,
            "templateName": "Option Out",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 6,
            "templateName": "Blackout",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 8,
            "templateName": "Restriction",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 5,
            "templateName": "Holdback",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 15,
            "templateName": "Clearance",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 16,
            "templateName": "Content Restriction",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 17,
            "templateName": "Carve Out",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 4,
            "templateID": 9,
            "templateName": "Acquisition",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 4,
            "templateID": 10,
            "templateName": "Exhibit",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 15,
            "templateName": "Payment Schedule",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 24,
            "templateName": "Deliverables Tracker",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 26,
            "templateName": "Delivery of Catalog Items",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 28,
            "templateName": "Marketing & Promotional Rights",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 29,
            "templateName": "Options",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 31,
            "templateName": "Negotiation Rights",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 32,
            "templateName": "Allocation",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 33,
            "templateName": "Amortization",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 38,
            "templateName": "Bonuses",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 34,
            "templateName": "License Fee (Originals)",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 35,
            "templateName": "Budget Approval (Residuals)",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 42,
            "templateName": "Breakage",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 43,
            "templateName": "Step Up Pricing",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 44,
            "templateName": "Pricing",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 46,
            "templateName": "Journal Entry Log",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 49,
            "templateName": "Delivery",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 5,
            "templateID": 51,
            "templateName": "Cost of Sale",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 10,
            "templateID": 47,
            "templateName": "Sub-Allocation",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 15,
            "templateID": 1,
            "templateName": "Delivery In",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 15,
            "templateID": 2,
            "templateName": "Delivery Out",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 15,
            "templateID": 3,
            "templateName": "Lab Access",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 15,
            "templateID": 4,
            "templateName": "Lab Order",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 15,
            "templateID": 5,
            "templateName": "Loan Out",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        }
    ],
    "childRelationships": [
        {
            "charTypeID": 3,
            "templateID": 1,
            "templateName": "Rights In",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 2,
            "templateName": "Rights Out",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 8,
            "templateName": "Restriction",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 15,
            "templateName": "Clearance",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 3,
            "templateID": 16,
            "templateName": "Content Restriction",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 14,
            "templateID": 3,
            "templateName": "Catalog Upload",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        },
        {
            "charTypeID": 14,
            "templateID": 8,
            "templateName": "System Generated Document",
            "relRecTypeID": 1,
            "relRecTypeDescription": "Non Rights Relevant"
        }
    ],
    "partyRelationships": []
}

Get template field details

GET/[char type]/templates/[template ID]/[field label]

Retrieve specific details for a given template's specific field

Response

{
    "fieldName": "MPAA Rating",
    "fieldDescription": "MPAA Rating",
    "label": "mpaa_rating",
    "required": false,
    "maxLength": 500,
    "editable": true,
    "dataType": "AlphaNumericText",
    "allowMultiple": false,
    "sequenceNumber": 1,
    "groupId": 4,
    "groupName": "Details",
    "pickListId": "d97833a3-77be-eb11-9472-0af1f058195a",
    "pickListName": "Ratings - MPAA",
    "listOfValues": [
        {
            "id": 1,
            "label": "G",
            "childValues": []
        },
        {
            "id": 2,
            "label": "PG",
            "childValues": []
        },
        {
            "id": 3,
            "label": "PG-13",
            "childValues": []
        },
        {
            "id": 4,
            "label": "R",
            "childValues": []
        },
        {
            "id": 5,
            "label": "NC-17",
            "childValues": []
        }
    ],
    "systemIndicatorId": 0,
    "dateAlerts": [],
    "conditionalField": {
        "triggerLabel": "genre",
        "triggerValue": "2"
    }
}

Last updated