getObjects


Description

Gets a list of objects

Example request

https://www.rundowncreator.com/channel4news/API.php
     ?APIKey=edharken
     &APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A
     &Action=getObjects

Example response

[
    {
        "ObjectID": 1,
        "Type": "cg",
        "RawData": "<cg id=\"1\" template=\"talent\" line1=\"Ron Burgundy\">",
        "Payload": {
            "id": "1",
            "template": "talent",
            "line1": "Ron Burgundy"
        },
        "RundownID": 1,
        "RowID": 2,
        "Position": {
            "inRundown": 10,
            "inScript": 1
        },
        "Status": "Not Ready"
    },
    {
        "ObjectID": 2,
        "Type": "cg",
        "RawData": "<cg id=\"2\" template=\"1line\" line1=\"La Jolla\">",
        "Payload": {
            "id": "2",
            "template": "1line",
            "line1": "La Jolla"
        },
        "RundownID": 1,
        "RowID": 3,
        "Position": {
            "inRundown": 20,
            "inScript": 1
        },
        "Status": "Not Ready"
    },
    {
        "ObjectID": 3,
        "Type": "cg",
        "RawData": "<cg id=\"3\" template=\"2line\" line1=\"William Lansdowne\" line2=\"San Diego Police Chief\">",
        "Payload": {
            "id": "3",
            "template": "2line",
            "line1": "William Lansdowne",
            "line2": "San Diego Police Chief"
        },
        "RundownID": 1,
        "RowID": 3,
        "Position": {
            "inRundown": 20,
            "inScript": 2
        },
        "Status": "Not Ready"
    }
]

Required parameters

None

Optional parameters

ObjectID integer if set, only the object with the ObjectID specified will be returned
Type string if set, only objects of the Type specified will be returned
RundownID integer if set, only objects in the rundown with the RundownID specified will be returned
RowID integer if set, only objects in the row with the RowID specified will be returned
Status string if set, only objects with the Status specified will be returned. Possible values include Ready, Not Ready, and Played
GetTimestamps boolean if set to true, the dates/times that the object was created and last modified will be included in the response returned in the DateCreated and DateModified fields. If set to false, they will not. Defaults to false
OrderBy string if set, the results in the response returned will be ordered by the field specified. Possible values include ObjectID, Type, RundownID, RowID, Position and Status. Defaults to ObjectID
Descending boolean if set to true, the results in the response returned will be sorted in descending order. Defaults to false

Returns

ObjectID integer the object's unique ID
DateCreated integer the date/time that the object was created. Only returned if GetTimestamps is set to true
DateModified integer the date/time that the object was last modified. Only returned if GetTimestamps is set to true
Type string the object's type
RawData string the object's code
Payload object the object's attributes
RundownID integer the unique ID of the rundown the object is in
RowID integer the unique ID of the row the object is in
Position.inRundown integer the position in the rundown of the row that the object is in
Position.inScript integer the position of the object in the script
Status string the object's status. Possible values include Ready, Not Ready, and Played

Notes

If you're trying to generate a playlist of objects (like CGs, graphics, audio clips, or video clips) in a rundown or row, you might want to use the getRows method with the GetObjects parameter set to true, because getRows will return row data like page numbers and story slugs