API docs by Redocly

ZettaCloud API (1.0.0)

Download OpenAPI specification:Download

Asset

get number of assets associated with the assettype by album Deprecated

GetCountByAssetTypeAndAlbum

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

album
required
string

asset album (base64 encoded)

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get list of asset by corresponding ids, asset ids are in the body as a json array

PostGetAssetsByAssetIDs

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

List of asset ids to return

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
null

Get list of asset by asset types and optional parameters Deprecated

GetAssetsByAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string
Default: 1

asset type id

Responses

Response samples

Content type
application/json
null

Get list of asset by asset types and optional parameters

GetAssetsByAssetTypeandAlbum

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string
album
required
string

Responses

Response samples

Content type
application/json
null

Get list of asset by asset types and optional parameters Deprecated

GetAssetsByAssetTypeandExternId

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

externidtype
required
string

ExternalID type

externidvalue
required
string

ExternalID value

Responses

Response samples

Content type
application/json
null

Get list of asset by corresponding ids, seperated by commas Deprecated

GetAssetsByAssetIDs

Authorizations:
LambdaTokenAuthorizer
path Parameters
ids
required
string

list of asset ids, seperated by commas

Responses

Response samples

Content type
application/json
null

Delete multiple assets by id, seperated by commas

DeleteAssetList

Authorizations:
LambdaTokenAuthorizer
path Parameters
ids
required
string

asset id

Responses

Response samples

Content type
application/json
null

Get list of asset by asset types and optional parameters Deprecated

GetAssetsByAssetTypeAndTitle

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

title
required
string

asset title (base64 encoded)

Responses

Response samples

Content type
application/json
null

Query the asset table with a graphQL query, supported types are assets and assetcount

Graphql

Authorizations:
LambdaTokenAuthorizer

Responses

Response samples

Content type
application/json
null

Get a random sample of assets based on assettypeid

GetSampleAssetsByAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

Responses

Response samples

Content type
application/json
null

Get asset by id

GetAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

will Create or replace an asset.

PutAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset id

Request Body schema: application/json

Will create or replace an asset

OrganizationID
string <guid> ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

asset type

string or null

primary title of asset

string or null

voice talent of asset

string or null

primary artist of asset

string or null

Global Display Title used for export (in band metadata, now playing export) across all stations

string or null

Global Display Artist used for export (in band metadata, now playing export) across all stations

string or null

advertiser name, example: McDonald’s

string or null

album name of asset

string or null

Brand, example: Nescafe

string or null

asset ISRC

string or null

asset ISCI

string or null

Record Label

string or null

Year Associated with the asser

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Comment

string or null

ImageUrl

string or null

Who Created this Asset: (examples: User Account, Music Point Service, Zetta Replication Service, ...)

string or null

Name of the original File, when the latest version of the asset was imported!

string or null

DO NOT USE - OBSOLETED (2020-08-27, Replaced with ReleaseDateTime)

string or null

Release datetime (ISO8601) - Audio can not be played before this datetime

string or null

end datetime (ISO8601) - Audio can not be played after this datetime

string or null

kill datetime (ISO8601) - Audio needs to removed/deleted from the system after this data

string or null

Recorded date - audio was added or modified (ISO8601)

Array of strings or null
  • tags associated with the asset
Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the asset (Depreciated 2019-07-01)

RaptorAssetThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with an asset. Please Use Recommending Naming Convention {Application}_{CustomField}

RaptorPOIMarkup (object) or null

Asset level Point of Interest markup

RaptorPOIPlaybackView (object) or null

Asset calculated Playback Points of Interest

Array of RaptorStationAsset (objects) or null

(READONLY) list of station asset values

RaptorAnalysisData (object) or null

data associated with an asset, when running audio Analysis

MusicPointSongDetail (object) or null

data associated with an asset, when imported from MusicPoint

RaptorAssetFillData (object) or null

Data associated with special asset fill rules

RaptorAssetFTPIngest (object) or null

FTP Ingest asset sub document

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Delete asset by id

DeleteAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset id

Responses

Response samples

Content type
application/json
{ }

Patch an existing asset

PatchAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset id

Request Body schema: application/json

Partial update of an existing asset, only included fields will be updated.

OrganizationID
string <guid> ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

asset type

string or null

primary title of asset

string or null

voice talent of asset

string or null

primary artist of asset

string or null

Global Display Title used for export (in band metadata, now playing export) across all stations

string or null

Global Display Artist used for export (in band metadata, now playing export) across all stations

string or null

advertiser name, example: McDonald’s

string or null

album name of asset

string or null

Brand, example: Nescafe

string or null

asset ISRC

string or null

asset ISCI

string or null

Record Label

string or null

Year Associated with the asser

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Comment

string or null

ImageUrl

string or null

Who Created this Asset: (examples: User Account, Music Point Service, Zetta Replication Service, ...)

string or null

Name of the original File, when the latest version of the asset was imported!

string or null

DO NOT USE - OBSOLETED (2020-08-27, Replaced with ReleaseDateTime)

string or null

Release datetime (ISO8601) - Audio can not be played before this datetime

string or null

end datetime (ISO8601) - Audio can not be played after this datetime

string or null

kill datetime (ISO8601) - Audio needs to removed/deleted from the system after this data

string or null

Recorded date - audio was added or modified (ISO8601)

Array of strings or null
  • tags associated with the asset
Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the asset (Depreciated 2019-07-01)

RaptorAssetThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with an asset. Please Use Recommending Naming Convention {Application}_{CustomField}

RaptorPOIMarkup (object) or null

Asset level Point of Interest markup

RaptorPOIPlaybackView (object) or null

Asset calculated Playback Points of Interest

Array of RaptorStationAsset (objects) or null

(READONLY) list of station asset values

RaptorAnalysisData (object) or null

data associated with an asset, when running audio Analysis

MusicPointSongDetail (object) or null

data associated with an asset, when imported from MusicPoint

RaptorAssetFillData (object) or null

Data associated with special asset fill rules

RaptorAssetFTPIngest (object) or null

FTP Ingest asset sub document

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

get number of assets associated with the assettype by album Deprecated

GetCountByAssetTypeAndExternId

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

externidtype
required
string

matching ExternalID type

externidvalue
required
string

matching ExternalID value

Responses

Response samples

Content type
application/json
null

Gets a list of unique tags and there counts for the passed in asset filter

GetUniqueAssetTags

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Asset search schema to search for assets by

RaptorAsset (object) or null

All passed in fields will be included when searching for mathcing assets

RaptorAsset (object) or null

All fields will be ored together when filtering for assets

Responses

Request samples

Content type
application/json
{
  • "matchAll": {
    },
  • "matchAny": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Create or Patch an asset

AddOrUpdateAsset

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create a new asset under an Organization (based upon AssetTypeID)

OrganizationID
string <guid> ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

asset type

string or null

primary title of asset

string or null

voice talent of asset

string or null

primary artist of asset

string or null

Global Display Title used for export (in band metadata, now playing export) across all stations

string or null

Global Display Artist used for export (in band metadata, now playing export) across all stations

string or null

advertiser name, example: McDonald’s

string or null

album name of asset

string or null

Brand, example: Nescafe

string or null

asset ISRC

string or null

asset ISCI

string or null

Record Label

string or null

Year Associated with the asser

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Comment

string or null

ImageUrl

string or null

Who Created this Asset: (examples: User Account, Music Point Service, Zetta Replication Service, ...)

string or null

Name of the original File, when the latest version of the asset was imported!

string or null

DO NOT USE - OBSOLETED (2020-08-27, Replaced with ReleaseDateTime)

string or null

Release datetime (ISO8601) - Audio can not be played before this datetime

string or null

end datetime (ISO8601) - Audio can not be played after this datetime

string or null

kill datetime (ISO8601) - Audio needs to removed/deleted from the system after this data

string or null

Recorded date - audio was added or modified (ISO8601)

Array of strings or null
  • tags associated with the asset
Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the asset (Depreciated 2019-07-01)

RaptorAssetThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with an asset. Please Use Recommending Naming Convention {Application}_{CustomField}

RaptorPOIMarkup (object) or null

Asset level Point of Interest markup

RaptorPOIPlaybackView (object) or null

Asset calculated Playback Points of Interest

Array of RaptorStationAsset (objects) or null

(READONLY) list of station asset values

RaptorAnalysisData (object) or null

data associated with an asset, when running audio Analysis

MusicPointSongDetail (object) or null

data associated with an asset, when imported from MusicPoint

RaptorAssetFillData (object) or null

Data associated with special asset fill rules

RaptorAssetFTPIngest (object) or null

FTP Ingest asset sub document

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

get assets filtered by asset json passed into the body Deprecated

SearchAsset

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Asset search schema to search for assets by

RaptorAsset (object) or null

All passed in fields will be included when searching for mathcing assets

RaptorAsset (object) or null

All fields will be ored together when filtering for assets

Responses

Request samples

Content type
application/json
{
  • "matchAll": {
    },
  • "matchAny": {
    }
}

Response samples

Content type
application/json
null

Get list of asset by asset types and optional parameters Deprecated

GetAssetsByAssetTypeandArtist

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

artist
required
string

asset Artist (base64 encoded)

Responses

Response samples

Content type
application/json
null

Create new asset

CreateAsset

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create a new asset under an Organization (based upon AssetTypeID)

OrganizationID
string <guid> ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

asset type

string or null

primary title of asset

string or null

voice talent of asset

string or null

primary artist of asset

string or null

Global Display Title used for export (in band metadata, now playing export) across all stations

string or null

Global Display Artist used for export (in band metadata, now playing export) across all stations

string or null

advertiser name, example: McDonald’s

string or null

album name of asset

string or null

Brand, example: Nescafe

string or null

asset ISRC

string or null

asset ISCI

string or null

Record Label

string or null

Year Associated with the asser

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Comment

string or null

ImageUrl

string or null

Who Created this Asset: (examples: User Account, Music Point Service, Zetta Replication Service, ...)

string or null

Name of the original File, when the latest version of the asset was imported!

string or null

DO NOT USE - OBSOLETED (2020-08-27, Replaced with ReleaseDateTime)

string or null

Release datetime (ISO8601) - Audio can not be played before this datetime

string or null

end datetime (ISO8601) - Audio can not be played after this datetime

string or null

kill datetime (ISO8601) - Audio needs to removed/deleted from the system after this data

string or null

Recorded date - audio was added or modified (ISO8601)

Array of strings or null
  • tags associated with the asset
Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the asset (Depreciated 2019-07-01)

RaptorAssetThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with an asset. Please Use Recommending Naming Convention {Application}_{CustomField}

RaptorPOIMarkup (object) or null

Asset level Point of Interest markup

RaptorPOIPlaybackView (object) or null

Asset calculated Playback Points of Interest

Array of RaptorStationAsset (objects) or null

(READONLY) list of station asset values

RaptorAnalysisData (object) or null

data associated with an asset, when running audio Analysis

MusicPointSongDetail (object) or null

data associated with an asset, when imported from MusicPoint

RaptorAssetFillData (object) or null

Data associated with special asset fill rules

RaptorAssetFTPIngest (object) or null

FTP Ingest asset sub document

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Adds tags to an asset if they are not already assigned to asset (case insensitive search)

CreateAssetTag

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string
Request Body schema: application/json

Array of tags to add

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Deletes tags from an asset if they are assigned to the asset (case insensitive search)

DeleteAssetTag

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string
Request Body schema: application/json

Array of tags to delete

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

get number of assets associated with the assettype Deprecated

GetCountByAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

Responses

Response samples

Content type
application/json
0
0

get number of assets associated with the assettype by artist Deprecated

GetCountByAssetTypeAndArtist

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

artist
required
string

asset artist (base64 encoded)

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

get asset count for a filter asset json passed into the body Deprecated

SearchAssetCount

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Asset search schema to search for assets by

RaptorAsset (object) or null

All passed in fields will be included when searching for mathcing assets

RaptorAsset (object) or null

All fields will be ored together when filtering for assets

Responses

Request samples

Content type
application/json
{
  • "matchAll": {
    },
  • "matchAny": {
    }
}

Response samples

Content type
application/json
null

get number of assets associated with the assettype by title Deprecated

GetCountByAssetTypeAndTitle

Authorizations:
LambdaTokenAuthorizer
path Parameters
assettypeid
required
string

asset type id

title
required
string

asset title (base64 encoded)

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

AssetType

Get AssetType by id

GetAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset type id

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update AssetType by id

PutAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset type id

Request Body schema: application/json

id of the asset type

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

EnumAssetTypeClass (integer)
Default: 0

Asset type class

Description
string

asset type description

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

number or null

Order of asset types

string or null

SemanticUI Icon string

string or null

CSS Hexadecimal Color string

Array of SupportedChainTypes (integers) or SupportedChainTypes (null) (SupportedChainTypes)

Chain types that are selectable for this type

EnumAssetTypeRecordable (integer) or null
EnumAutoFades (integer) or null
EnumAutoFadeOtherTypes (integer) or null
number or null

Default kill datetime when assets in this type are created

EnumGSelectorAssetType (integer) or null
RaptorAnalysisSettings (object) or null
RaptorRecordableSettings (object) or null
Array of strings or null

Music Source keys associated with the asset type

Array of RaptorAssetTypeSpecificField (objects) or null

Specific Fields associated with the asset type

boolean or null

When set to true will display TFP Ingest teab in Asset Card for the given AssetType

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetTypeID": "string",
  • "Class": 0,
  • "Description": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "SequenceNumber": 0,
  • "Icon": "string",
  • "Color": "string",
  • "SupportedChainTypes": [
    ],
  • "Recordable": [
    ],
  • "AutoFades": [
    ],
  • "AutoFadeOtherTypes": [
    ],
  • "KillDateTimeOffset": 0,
  • "GSelectorAssetType": [
    ],
  • "AnalysisSettings": {
    },
  • "RecordableSettings": {
    },
  • "MusicSearchSources": [
    ],
  • "SpecificFields": [
    ],
  • "EnableFtpIngest": true
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetTypeID": "string",
  • "Class": 0,
  • "Description": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "SequenceNumber": 0,
  • "Icon": "string",
  • "Color": "string",
  • "SupportedChainTypes": [
    ],
  • "Recordable": [
    ],
  • "AutoFades": [
    ],
  • "AutoFadeOtherTypes": [
    ],
  • "KillDateTimeOffset": 0,
  • "GSelectorAssetType": [
    ],
  • "AnalysisSettings": {
    },
  • "RecordableSettings": {
    },
  • "MusicSearchSources": [
    ],
  • "SpecificFields": [
    ],
  • "EnableFtpIngest": true
}

Delete AssetType by id

DeleteAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset type id

Responses

Response samples

Content type
application/json
{ }

Patch an existing assettype

PatchAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset typeid

Request Body schema: application/json

Partial update of an existing assettype, only included fields will be updated.

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

EnumAssetTypeClass (integer)
Default: 0

Asset type class

Description
string

asset type description

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

number or null

Order of asset types

string or null

SemanticUI Icon string

string or null

CSS Hexadecimal Color string

Array of SupportedChainTypes (integers) or SupportedChainTypes (null) (SupportedChainTypes)

Chain types that are selectable for this type

EnumAssetTypeRecordable (integer) or null
EnumAutoFades (integer) or null
EnumAutoFadeOtherTypes (integer) or null
number or null

Default kill datetime when assets in this type are created

EnumGSelectorAssetType (integer) or null
RaptorAnalysisSettings (object) or null
RaptorRecordableSettings (object) or null
Array of strings or null

Music Source keys associated with the asset type

Array of RaptorAssetTypeSpecificField (objects) or null

Specific Fields associated with the asset type

boolean or null

When set to true will display TFP Ingest teab in Asset Card for the given AssetType

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetTypeID": "string",
  • "Class": 0,
  • "Description": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "SequenceNumber": 0,
  • "Icon": "string",
  • "Color": "string",
  • "SupportedChainTypes": [
    ],
  • "Recordable": [
    ],
  • "AutoFades": [
    ],
  • "AutoFadeOtherTypes": [
    ],
  • "KillDateTimeOffset": 0,
  • "GSelectorAssetType": [
    ],
  • "AnalysisSettings": {
    },
  • "RecordableSettings": {
    },
  • "MusicSearchSources": [
    ],
  • "SpecificFields": [
    ],
  • "EnableFtpIngest": true
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetTypeID": "string",
  • "Class": 0,
  • "Description": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "SequenceNumber": 0,
  • "Icon": "string",
  • "Color": "string",
  • "SupportedChainTypes": [
    ],
  • "Recordable": [
    ],
  • "AutoFades": [
    ],
  • "AutoFadeOtherTypes": [
    ],
  • "KillDateTimeOffset": 0,
  • "GSelectorAssetType": [
    ],
  • "AnalysisSettings": {
    },
  • "RecordableSettings": {
    },
  • "MusicSearchSources": [
    ],
  • "SpecificFields": [
    ],
  • "EnableFtpIngest": true
}

Delete AssetType by json payload

DeleteBulkAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

asset type id

removefile
required
string

remove file parameter

Responses

Response samples

Content type
application/json
{ }

Create a new asset type for a given organization

CreateAssetType

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Asset Type to add to the Organization

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

EnumAssetTypeClass (integer)
Default: 0

Asset type class

Description
string

asset type description

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

number or null

Order of asset types

string or null

SemanticUI Icon string

string or null

CSS Hexadecimal Color string

Array of SupportedChainTypes (integers) or SupportedChainTypes (null) (SupportedChainTypes)

Chain types that are selectable for this type

EnumAssetTypeRecordable (integer) or null
EnumAutoFades (integer) or null
EnumAutoFadeOtherTypes (integer) or null
number or null

Default kill datetime when assets in this type are created

EnumGSelectorAssetType (integer) or null
RaptorAnalysisSettings (object) or null
RaptorRecordableSettings (object) or null
Array of strings or null

Music Source keys associated with the asset type

Array of RaptorAssetTypeSpecificField (objects) or null

Specific Fields associated with the asset type

boolean or null

When set to true will display TFP Ingest teab in Asset Card for the given AssetType

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetTypeID": "string",
  • "Class": 0,
  • "Description": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "SequenceNumber": 0,
  • "Icon": "string",
  • "Color": "string",
  • "SupportedChainTypes": [
    ],
  • "Recordable": [
    ],
  • "AutoFades": [
    ],
  • "AutoFadeOtherTypes": [
    ],
  • "KillDateTimeOffset": 0,
  • "GSelectorAssetType": [
    ],
  • "AnalysisSettings": {
    },
  • "RecordableSettings": {
    },
  • "MusicSearchSources": [
    ],
  • "SpecificFields": [
    ],
  • "EnableFtpIngest": true
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetTypeID": "string",
  • "Class": 0,
  • "Description": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "SequenceNumber": 0,
  • "Icon": "string",
  • "Color": "string",
  • "SupportedChainTypes": [
    ],
  • "Recordable": [
    ],
  • "AutoFades": [
    ],
  • "AutoFadeOtherTypes": [
    ],
  • "KillDateTimeOffset": 0,
  • "GSelectorAssetType": [
    ],
  • "AnalysisSettings": {
    },
  • "RecordableSettings": {
    },
  • "MusicSearchSources": [
    ],
  • "SpecificFields": [
    ],
  • "EnableFtpIngest": true
}

get number of asset types associated with an organization

GetCountByOrganization

Authorizations:
LambdaTokenAuthorizer
path Parameters
organizationid
required
string

id of the organization

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get list of asset types for a specific organization and optional parameters

GetAssetTypesByOrganization

Authorizations:
LambdaTokenAuthorizer
path Parameters
organizationid
required
string

id of the organization

Responses

Response samples

Content type
application/json
null

ChangeSubscriber

Get change subscriber by ID

GetChangeSubscriber

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

ChangeSubscriber ID

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "SubscriberID": "string",
  • "SubscriberName": "string",
  • "LastChangeID": "string",
  • "Subscriptions": [
    ],
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "HistoryLimit": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string"
}

Updates or creates a Subscriber, Requires: ChangeSubscriberID

UpdateChangeSubscriber

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

ChangeSubscriber ID

Request Body schema: application/json

The change Subscriber will be only include all data passed in the update call

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Organization id

SubscriberID
string

Change subscriber id

SubscriberName
string

change subscriber name

string or null

Last Change ID

Array of EnumRaptorChangeType (integers) or null

Change types that the subscriber is interested in

string or null

READONLY, ISODate when register will be removed in not re-registered.

number or null

READONLY, Max history that can be saved

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "SubscriberID": "string",
  • "SubscriberName": "string",
  • "LastChangeID": "string",
  • "Subscriptions": [
    ],
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "HistoryLimit": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "SubscriberID": "string",
  • "SubscriberName": "string",
  • "LastChangeID": "string",
  • "Subscriptions": [
    ],
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "HistoryLimit": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string"
}

Delete change subscriber by id

DeleteChangeSubscriber

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

change subscriber id

Responses

Response samples

Content type
application/json
{ }

Patch an existing change Subscriber, Requires: ChangeSubscriberID

PatchChangeSubscriber

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

Change Subscriber ID

Request Body schema: application/json

The change Subscriber data we wish to patch

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Organization id

SubscriberID
string

Change subscriber id

SubscriberName
string

change subscriber name

string or null

Last Change ID

Array of EnumRaptorChangeType (integers) or null

Change types that the subscriber is interested in

string or null

READONLY, ISODate when register will be removed in not re-registered.

number or null

READONLY, Max history that can be saved

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "SubscriberID": "string",
  • "SubscriberName": "string",
  • "LastChangeID": "string",
  • "Subscriptions": [
    ],
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "HistoryLimit": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "SubscriberID": "string",
  • "SubscriberName": "string",
  • "LastChangeID": "string",
  • "Subscriptions": [
    ],
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "HistoryLimit": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string"
}

Creates a new change for all subscribers. Note: Subscribers are read from the RaptorChangeSubscribers collection for given organization and change type

PostChangesForSubscriber

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Requires RaptorChange

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

ChangeID
string

change id

string or null

subscriber id

string or null

change description

Type
integer (EnumRaptorChangeType)
Enum: 0 1 2

Enum - Change Type

string or null

id for the change type, example assetID, eventID

object or null

data associated with that change type

string or null

Created datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ChangeID": "string",
  • "SubscriberID": "string",
  • "Description": "string",
  • "Type": [
    ],
  • "TypeID": "string",
  • "Data": { },
  • "CreatedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
null

Create new change subcriber, Requires: OrganizationID, SubscriberName

CreateChangeSubscriber

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create new change subscriber Requires: OrganizationID, SubscriberName

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Organization id

SubscriberID
string

Change subscriber id

SubscriberName
string

change subscriber name

string or null

Last Change ID

Array of EnumRaptorChangeType (integers) or null

Change types that the subscriber is interested in

string or null

READONLY, ISODate when register will be removed in not re-registered.

number or null

READONLY, Max history that can be saved

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "SubscriberID": "string",
  • "SubscriberName": "string",
  • "LastChangeID": "string",
  • "Subscriptions": [
    ],
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "HistoryLimit": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "SubscriberID": "string",
  • "SubscriberName": "string",
  • "LastChangeID": "string",
  • "Subscriptions": [
    ],
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "HistoryLimit": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string"
}

ChangeTracking

Returns list of changes for a given subscriber since LastChangeID. LastChangeID updated before this call returns.

GetChangesForSubscriber

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

subscriber id to get the changes for

query Parameters
changesCount
integer
Default: 1000

subscriber id to get the changes for

Responses

Response samples

Content type
application/json
null

ContentManagement

Get queue log file from s3 bucket based on New Relic logs

GetQueueLogFile

Authorizations:
LambdaTokenAuthorizer
query Parameters
containerName
required
string

Name of kubernetes container

startDate
required
string

Initial date filter

endDate
required
string

End date filter

timeseries
required
number

Time series in minutes

Request Body schema: application/json

Get queue logs from new relic

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Get log file from s3 bucket based on New Relic logs

GetLogFile

Authorizations:
LambdaTokenAuthorizer
query Parameters
containerName
required
string

Name of kubernetes container

startDate
required
string

Initial date filter

endDate
required
string

End date filter

fileExtension
required
string

Selected file extension

Request Body schema: application/json

Get logs from new relic

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Get logs count from New Relic

GetLogsCount

Authorizations:
LambdaTokenAuthorizer
query Parameters
containerName
required
string

Name of kubernetes container

startDate
required
string

Initial date filter

endDate
required
string

End date filter

timeseries
required
number

Time series in minutes

Request Body schema: application/json

Get logs from new relic

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Determine whether a file exists in the content management file store

FileExists

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Request Body schema: application/json

Check if a file exist in the content store, by assetid or relative file path

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Save a translation file in the content management file store

SaveTranslationFile

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Request Body schema: application/json

Save a file in the content store, by relative file path

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

List the files in a subdirectory in the organization bucket -- pass the OrgID and Subdir

FindFiles

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Request Body schema: application/json

pass the OrgID and Subdir and optional SearchSubdirs

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
[
  • "string"
]

Returns the file count and number of bytes used

FileStoreInfo

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Responses

Response samples

Content type
application/json
{
  • "FileCount": 0,
  • "StorePath": "string",
  • "StoreSpace": 0,
  • "FreeSpace": 0,
  • "UsedSpace": 0,
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Gets the URL for the desired file

InitializeDownload

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

returnMirrorUrls
boolean
Default: false

return a path to mirror urls

Request Body schema: application/json

Request download by Relative File or Asset ID

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "mirrorUrls": [
    ]
}

Rename a relative file in the content management file store

MoveFile

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Request Body schema: application/json

Request renaming of a file by RelativeFilepath to NewRelativeFilepath (NOTE: AssetID NOT SUPPORTED)

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Retrieve info about a file in the organization bucket -- pass the OrgID and FileName

FileInfo

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Request Body schema: application/json

pass the FileName

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "Filename": "string",
  • "Filesize": 0,
  • "MD5": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Remove a relative file from the content management file store

RemoveFile

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Request Body schema: application/json

Request removal of a file by Relative Filepath (NOTE: AssetID NOT SUPPORTED)

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

initalize an upload by relative file path (Credentials to be uploaded are returned in the response!)

InitializeUpload

Authorizations:
LambdaTokenAuthorizer
query Parameters
region
string

region to use when generating the file path

Request Body schema: application/json

Request uploading of a file by Relative Filepath (NOTE: AssetID NOT SUPPORTED)

string or null

Used for access to organization bucket files..

string or null

Relative File, in the backup content managment folder

string or null

new (renamed) file name, in the backup content managment folder

string or null

asset unique id

Responses

Request samples

Content type
application/json
{
  • "BucketFilepath": "string",
  • "RelativeFilepath": "string",
  • "NewRelativeFilepath": "string",
  • "AssetID": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "fields": {
    }
}

Device

Gets orgnaization ID based on device name and password (not used currently) provided.

Authenticate

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Device ID and Code

id
string

device id

code
string

device code

string or null

device description

string or null

organization to which the user belongs

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "description": "string",
  • "organizationId": "string"
}

Response samples

Content type
application/json
{
  • "deviceId": "string",
  • "id": "string",
  • "organizationId": "string",
  • "status": "string",
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "scope": "string",
  • "redirect_api_url": "string",
  • "redirect_api_key": "string"
}

generate a device startup script for a hardware device

GetEdgeDocker

Authorizations:
LambdaTokenAuthorizer
path Parameters
serialnumber
required
string
query Parameters
tag
string

used to override the ecr tag to use, if not included will the detected device latest..

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Query the Edge Device collection with a graphQL query, supported types are devices and devicecount

GraphQL

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

GraphQL json

query
string

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Gets device based on device id.

GetDevice

Authorizations:
LambdaTokenAuthorizer
path Parameters
deviceid
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "DeviceSerialNumber": "string",
  • "DeviceManufacturer": "Unknown",
  • "DeviceEnabled": true,
  • "DeviceHardwareReport": { },
  • "OrganizationID": "string",
  • "StationID": "string",
  • "PlayerKey": "string",
  • "DeviceOKTAID": "string",
  • "DeviceDescription": "string",
  • "DeviceLocalizeMount": "string",
  • "DeviceCacheMount": "string",
  • "LocalizerConfig": { },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Deletes device

DeleteDevice

Authorizations:
LambdaTokenAuthorizer
path Parameters
deviceid
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Add or Updates device

AddOrUpdateDevice

Authorizations:
LambdaTokenAuthorizer
path Parameters
deviceid
required
string
Request Body schema: application/json

Device to be updated

_id
string

This Object is a Mongo Collection, and required or Mongo Collections

DeviceSerialNumber
string

Unique Key, used to track and identify a specific Edge Hardware Device,this will need to match the playerkey using {manufacture-serialnumber)

DeviceManufacturer
string (EnumEdgeManufacturer)
Enum: "Unknown" "RaspberryPi" "AudioScience" "Barix" "Sound4"

Wellknown Edge Manufacure

DeviceEnabled
boolean
Default: true

Used to enable and disable activation of the Edge Device

null or RaptorEdgeHardwareReport (object)

Stores a common populated hardware report used by Raptor inquery edge hardware

string or null

organization the device is registered too

string or null

station the device is registered too

string or null

The Stations Player this Device is registered too

string or null

Device's OKTA ID (okta user id)

string or null

User friendly description of what the edge device is being used for

string or null

Used to configure an external encrypted audio mount, for localized content

string or null

Used to configure an external encrypted audio mount, for player realtime cache content

null or RaptorLocalizerConfig (object)

Configuration of the localizer running as a side car to this player

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "DeviceSerialNumber": "string",
  • "DeviceManufacturer": "Unknown",
  • "DeviceEnabled": true,
  • "DeviceHardwareReport": { },
  • "OrganizationID": "string",
  • "StationID": "string",
  • "PlayerKey": "string",
  • "DeviceOKTAID": "string",
  • "DeviceDescription": "string",
  • "DeviceLocalizeMount": "string",
  • "DeviceCacheMount": "string",
  • "LocalizerConfig": { },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "DeviceSerialNumber": "string",
  • "DeviceManufacturer": "Unknown",
  • "DeviceEnabled": true,
  • "DeviceHardwareReport": { },
  • "OrganizationID": "string",
  • "StationID": "string",
  • "PlayerKey": "string",
  • "DeviceOKTAID": "string",
  • "DeviceDescription": "string",
  • "DeviceLocalizeMount": "string",
  • "DeviceCacheMount": "string",
  • "LocalizerConfig": { },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

generate a device startup script for a hardware device

GetEdgeEnvironment

Authorizations:
LambdaTokenAuthorizer
path Parameters
serialnumber
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Event

Get a collection of playlist events by ID (separated by commas)

GetEvents

Authorizations:
LambdaTokenAuthorizer
path Parameters
ids
required
string

Responses

Response samples

Content type
application/json
null

Bulk Put playlist events

PutBulkEvent

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Puts events (in bulk) and associates them to a playlist

One of
Array
OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

playlist this event belongs to

EventID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

SequenceNumber
number

order of events in the playlist

EnumEventType (integer) or null

The playlist event type, like: Play Asset, Spot Block, ETM...

string or null

A description summary of what the event is being used for

EnumEventStatusCode (integer) or null

TODO

EnumEventErrorCode (integer) or null

TODO

EnumEventEditCode (integer) or null

TODO

EnumEventETMType (integer) or null

If the Event is and ETM, what type of etm are we [Hard, Soft, Hit, Reset]

EnumEventChainType (integer) or null

The chain type assoiciated with the event, [Segue, Stop, AutoPost ...]

string or null

Time the event started (ISO8601)

string or null

Time the event Stopped (ISO8601)

boolean or null

event was manually skipped by the user

string or null

AssetID to be played

string or null

AssetTypeID to be played. Used when there isn't an AssetID but will be filled by something else later. Like a VoiceTrack

RaptorAsset (object) or null

(READONLY) Asset data if pulled with the event

number or null

second.ms from playlist start event should start

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the playlist event (Depreciated 2019-07-01)

RaptorEventThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a playlist events. Please Use Recommending Naming Convention {Application}_{CustomField}

Array of strings or null

tags associated with the playlist event

number or null

version of the Playlist, used to handle concurrent writes

string or null

Zetta/NexGen comment lite

string or null

Color of event background

RaptorPOIMarkup (object) or null

Used to override POIMarkup at an event level

string or null

playlist for child events

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

EnumTimingType (integer) or null

Is the event stretchable

EnumSplitBehavior (integer)
Default: 0

Split behavior of the event

string or null

event id of previous event, used mainly for Voice Tracks

string or null

event id of next event, used mainly for Voice Tracks

RaptorLinearAdData (object) or null

LinearAdData

NetworkRaptorLinearAdData (object) or null

NetworkLinearAdData

EnumBlockType (integer) or null

BlockType

string or null

Guid of the asset rotation

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null

Bulk Create new playlist events

CreateBulkEvent

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Creates a new events (in bulk) and associates it to a playlist

One of
Array
OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

playlist this event belongs to

EventID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

SequenceNumber
number

order of events in the playlist

EnumEventType (integer) or null

The playlist event type, like: Play Asset, Spot Block, ETM...

string or null

A description summary of what the event is being used for

EnumEventStatusCode (integer) or null

TODO

EnumEventErrorCode (integer) or null

TODO

EnumEventEditCode (integer) or null

TODO

EnumEventETMType (integer) or null

If the Event is and ETM, what type of etm are we [Hard, Soft, Hit, Reset]

EnumEventChainType (integer) or null

The chain type assoiciated with the event, [Segue, Stop, AutoPost ...]

string or null

Time the event started (ISO8601)

string or null

Time the event Stopped (ISO8601)

boolean or null

event was manually skipped by the user

string or null

AssetID to be played

string or null

AssetTypeID to be played. Used when there isn't an AssetID but will be filled by something else later. Like a VoiceTrack

RaptorAsset (object) or null

(READONLY) Asset data if pulled with the event

number or null

second.ms from playlist start event should start

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the playlist event (Depreciated 2019-07-01)

RaptorEventThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a playlist events. Please Use Recommending Naming Convention {Application}_{CustomField}

Array of strings or null

tags associated with the playlist event

number or null

version of the Playlist, used to handle concurrent writes

string or null

Zetta/NexGen comment lite

string or null

Color of event background

RaptorPOIMarkup (object) or null

Used to override POIMarkup at an event level

string or null

playlist for child events

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

EnumTimingType (integer) or null

Is the event stretchable

EnumSplitBehavior (integer)
Default: 0

Split behavior of the event

string or null

event id of previous event, used mainly for Voice Tracks

string or null

event id of next event, used mainly for Voice Tracks

RaptorLinearAdData (object) or null

LinearAdData

NetworkRaptorLinearAdData (object) or null

NetworkLinearAdData

EnumBlockType (integer) or null

BlockType

string or null

Guid of the asset rotation

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null

Buld patch playlist events

PatchBulkEvent

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Patches events (in bulk) and associates them to a playlist

One of
Array
OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

playlist this event belongs to

EventID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

SequenceNumber
number

order of events in the playlist

EnumEventType (integer) or null

The playlist event type, like: Play Asset, Spot Block, ETM...

string or null

A description summary of what the event is being used for

EnumEventStatusCode (integer) or null

TODO

EnumEventErrorCode (integer) or null

TODO

EnumEventEditCode (integer) or null

TODO

EnumEventETMType (integer) or null

If the Event is and ETM, what type of etm are we [Hard, Soft, Hit, Reset]

EnumEventChainType (integer) or null

The chain type assoiciated with the event, [Segue, Stop, AutoPost ...]

string or null

Time the event started (ISO8601)

string or null

Time the event Stopped (ISO8601)

boolean or null

event was manually skipped by the user

string or null

AssetID to be played

string or null

AssetTypeID to be played. Used when there isn't an AssetID but will be filled by something else later. Like a VoiceTrack

RaptorAsset (object) or null

(READONLY) Asset data if pulled with the event

number or null

second.ms from playlist start event should start

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the playlist event (Depreciated 2019-07-01)

RaptorEventThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a playlist events. Please Use Recommending Naming Convention {Application}_{CustomField}

Array of strings or null

tags associated with the playlist event

number or null

version of the Playlist, used to handle concurrent writes

string or null

Zetta/NexGen comment lite

string or null

Color of event background

RaptorPOIMarkup (object) or null

Used to override POIMarkup at an event level

string or null

playlist for child events

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

EnumTimingType (integer) or null

Is the event stretchable

EnumSplitBehavior (integer)
Default: 0

Split behavior of the event

string or null

event id of previous event, used mainly for Voice Tracks

string or null

event id of next event, used mainly for Voice Tracks

RaptorLinearAdData (object) or null

LinearAdData

NetworkRaptorLinearAdData (object) or null

NetworkLinearAdData

EnumBlockType (integer) or null

BlockType

string or null

Guid of the asset rotation

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null

Bulk Delete event by id (separated by commas)

DeleteBulkEvent

Authorizations:
LambdaTokenAuthorizer
path Parameters
ids
required
string
query Parameters
LastModifyDescription
string

Sets the LastModifyDescription field on deleted data sent out to clients

Responses

Response samples

Content type
application/json
{ }

Get a playlist event by ID

GetEvent

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

event ID

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Updates and existing event, Requires: PlaylistID, EventID, EventType and SequenceNumber

UpdateEvent

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string
Request Body schema: application/json

The event will be only include all data passed in the update call

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

playlist this event belongs to

EventID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

SequenceNumber
number

order of events in the playlist

EnumEventType (integer) or null

The playlist event type, like: Play Asset, Spot Block, ETM...

string or null

A description summary of what the event is being used for

EnumEventStatusCode (integer) or null

TODO

EnumEventErrorCode (integer) or null

TODO

EnumEventEditCode (integer) or null

TODO

EnumEventETMType (integer) or null

If the Event is and ETM, what type of etm are we [Hard, Soft, Hit, Reset]

EnumEventChainType (integer) or null

The chain type assoiciated with the event, [Segue, Stop, AutoPost ...]

string or null

Time the event started (ISO8601)

string or null

Time the event Stopped (ISO8601)

boolean or null

event was manually skipped by the user

string or null

AssetID to be played

string or null

AssetTypeID to be played. Used when there isn't an AssetID but will be filled by something else later. Like a VoiceTrack

RaptorAsset (object) or null

(READONLY) Asset data if pulled with the event

number or null

second.ms from playlist start event should start

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the playlist event (Depreciated 2019-07-01)

RaptorEventThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a playlist events. Please Use Recommending Naming Convention {Application}_{CustomField}

Array of strings or null

tags associated with the playlist event

number or null

version of the Playlist, used to handle concurrent writes

string or null

Zetta/NexGen comment lite

string or null

Color of event background

RaptorPOIMarkup (object) or null

Used to override POIMarkup at an event level

string or null

playlist for child events

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

EnumTimingType (integer) or null

Is the event stretchable

EnumSplitBehavior (integer)
Default: 0

Split behavior of the event

string or null

event id of previous event, used mainly for Voice Tracks

string or null

event id of next event, used mainly for Voice Tracks

RaptorLinearAdData (object) or null

LinearAdData

NetworkRaptorLinearAdData (object) or null

NetworkLinearAdData

EnumBlockType (integer) or null

BlockType

string or null

Guid of the asset rotation

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Delete event by id

DeleteEvent

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string
query Parameters
LastModifyDescription
string

Sets the LastModifyDescription field on deleted data sent out to clients

Responses

Response samples

Content type
application/json
{ }

Patch an existing playlist event, Requires: EventID

PatchEvent

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string
Request Body schema: application/json

Patches an an existing asset, only included fields will be updated.

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

playlist this event belongs to

EventID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

SequenceNumber
number

order of events in the playlist

EnumEventType (integer) or null

The playlist event type, like: Play Asset, Spot Block, ETM...

string or null

A description summary of what the event is being used for

EnumEventStatusCode (integer) or null

TODO

EnumEventErrorCode (integer) or null

TODO

EnumEventEditCode (integer) or null

TODO

EnumEventETMType (integer) or null

If the Event is and ETM, what type of etm are we [Hard, Soft, Hit, Reset]

EnumEventChainType (integer) or null

The chain type assoiciated with the event, [Segue, Stop, AutoPost ...]

string or null

Time the event started (ISO8601)

string or null

Time the event Stopped (ISO8601)

boolean or null

event was manually skipped by the user

string or null

AssetID to be played

string or null

AssetTypeID to be played. Used when there isn't an AssetID but will be filled by something else later. Like a VoiceTrack

RaptorAsset (object) or null

(READONLY) Asset data if pulled with the event

number or null

second.ms from playlist start event should start

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the playlist event (Depreciated 2019-07-01)

RaptorEventThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a playlist events. Please Use Recommending Naming Convention {Application}_{CustomField}

Array of strings or null

tags associated with the playlist event

number or null

version of the Playlist, used to handle concurrent writes

string or null

Zetta/NexGen comment lite

string or null

Color of event background

RaptorPOIMarkup (object) or null

Used to override POIMarkup at an event level

string or null

playlist for child events

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

EnumTimingType (integer) or null

Is the event stretchable

EnumSplitBehavior (integer)
Default: 0

Split behavior of the event

string or null

event id of previous event, used mainly for Voice Tracks

string or null

event id of next event, used mainly for Voice Tracks

RaptorLinearAdData (object) or null

LinearAdData

NetworkRaptorLinearAdData (object) or null

NetworkLinearAdData

EnumBlockType (integer) or null

BlockType

string or null

Guid of the asset rotation

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Create new playlist event, Requires: PlaylistID, EventType, SequenceNumber

CreateEvent

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create new playlist event. Requires: PlaylistID, EventType, SequenceNumber

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

playlist this event belongs to

EventID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

SequenceNumber
number

order of events in the playlist

EnumEventType (integer) or null

The playlist event type, like: Play Asset, Spot Block, ETM...

string or null

A description summary of what the event is being used for

EnumEventStatusCode (integer) or null

TODO

EnumEventErrorCode (integer) or null

TODO

EnumEventEditCode (integer) or null

TODO

EnumEventETMType (integer) or null

If the Event is and ETM, what type of etm are we [Hard, Soft, Hit, Reset]

EnumEventChainType (integer) or null

The chain type assoiciated with the event, [Segue, Stop, AutoPost ...]

string or null

Time the event started (ISO8601)

string or null

Time the event Stopped (ISO8601)

boolean or null

event was manually skipped by the user

string or null

AssetID to be played

string or null

AssetTypeID to be played. Used when there isn't an AssetID but will be filled by something else later. Like a VoiceTrack

RaptorAsset (object) or null

(READONLY) Asset data if pulled with the event

number or null

second.ms from playlist start event should start

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the playlist event (Depreciated 2019-07-01)

RaptorEventThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a playlist events. Please Use Recommending Naming Convention {Application}_{CustomField}

Array of strings or null

tags associated with the playlist event

number or null

version of the Playlist, used to handle concurrent writes

string or null

Zetta/NexGen comment lite

string or null

Color of event background

RaptorPOIMarkup (object) or null

Used to override POIMarkup at an event level

string or null

playlist for child events

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Description of who made the last modify

EnumTimingType (integer) or null

Is the event stretchable

EnumSplitBehavior (integer)
Default: 0

Split behavior of the event

string or null

event id of previous event, used mainly for Voice Tracks

string or null

event id of next event, used mainly for Voice Tracks

RaptorLinearAdData (object) or null

LinearAdData

NetworkRaptorLinearAdData (object) or null

NetworkLinearAdData

EnumBlockType (integer) or null

BlockType

string or null

Guid of the asset rotation

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Get a collection of playlist events by ID (separated by commas)

GenerateSequenceNumber

Authorizations:
LambdaTokenAuthorizer
path Parameters
eventID
required
string
afterEvent
required
string
query Parameters
GenerateCount
integer <int32>
Default: 1

how many sequence numbers should we generate, defaults to 1

Responses

Response samples

Content type
application/json
null

Fill

Create new fillrule

CreateFillRule

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create a new fillrule under an Organization

FillRuleKey
string

unique rule key

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id to which the rule belongs (Global Organization Fill Rule)

string or null

Attach a station id if the rule is overriden on a station (Station Override Fill Rule)

integer or null

Max per hour this asset can played as

Array of EnumFillType (strings) or null

Global Selection Order for fill content, spoken word vs music

Array of EnumFillType (strings) or null

Global Placement Order for fill content, spoken word vs music

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "FillRuleKey": "string",
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FrequencyCap": 0,
  • "SelectionOrder": [
    ],
  • "PlacementOrder": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "FillRuleKey": "string",
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FrequencyCap": 0,
  • "SelectionOrder": [
    ],
  • "PlacementOrder": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Create new fillhistory

CreateFillHistory

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create a new fillhistory under an Organization

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

string or null

Fill History instance, belonging to a station

FillHistoryKey
string

unique fill History key

Array of RaptorFillHistoryItem (objects) or null

List of assets and times the assets played

string or null

Fill History at datetime (ISO8601)

string or null

Fill History Created at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Get fillrule by key

GetFillRule

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillrulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "FillRuleKey": "string",
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FrequencyCap": 0,
  • "SelectionOrder": [
    ],
  • "PlacementOrder": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

will Create or replace an fillrule.

PutFillRule

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillrulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Will create or replace an fillrule

FillRuleKey
string

unique rule key

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id to which the rule belongs (Global Organization Fill Rule)

string or null

Attach a station id if the rule is overriden on a station (Station Override Fill Rule)

integer or null

Max per hour this asset can played as

Array of EnumFillType (strings) or null

Global Selection Order for fill content, spoken word vs music

Array of EnumFillType (strings) or null

Global Placement Order for fill content, spoken word vs music

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "FillRuleKey": "string",
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FrequencyCap": 0,
  • "SelectionOrder": [
    ],
  • "PlacementOrder": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "FillRuleKey": "string",
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FrequencyCap": 0,
  • "SelectionOrder": [
    ],
  • "PlacementOrder": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Delete fillrule by fillrulekey

DeleteFillRule

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillrulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{ }

will Create or replace an fillrule.

PutFillRule

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillrulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Partial update of an existing fillrule, only included fields will be updated.

FillRuleKey
string

unique rule key

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id to which the rule belongs (Global Organization Fill Rule)

string or null

Attach a station id if the rule is overriden on a station (Station Override Fill Rule)

integer or null

Max per hour this asset can played as

Array of EnumFillType (strings) or null

Global Selection Order for fill content, spoken word vs music

Array of EnumFillType (strings) or null

Global Placement Order for fill content, spoken word vs music

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "FillRuleKey": "string",
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FrequencyCap": 0,
  • "SelectionOrder": [
    ],
  • "PlacementOrder": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "FillRuleKey": "string",
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FrequencyCap": 0,
  • "SelectionOrder": [
    ],
  • "PlacementOrder": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Get fillhistory by key

GetFillHistory

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillhistorykey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

will Create or replace an fillhistory.

PutFillHistory

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillhistorykey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Will create or replace an fillhistory

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

string or null

Fill History instance, belonging to a station

FillHistoryKey
string

unique fill History key

Array of RaptorFillHistoryItem (objects) or null

List of assets and times the assets played

string or null

Fill History at datetime (ISO8601)

string or null

Fill History Created at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Delete fillhistory by fillhistorykey

DeleteFillHistory

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillhistorykey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Patch an existing fillhistory

PatchFillHistory

Authorizations:
LambdaTokenAuthorizer
path Parameters
fillhistorykey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Will create or replace an fillhistory

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

string or null

Fill History instance, belonging to a station

FillHistoryKey
string

unique fill History key

Array of RaptorFillHistoryItem (objects) or null

List of assets and times the assets played

string or null

Fill History at datetime (ISO8601)

string or null

Fill History Created at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "FillHistoryKey": "string",
  • "FillHistory": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Schedule a new fill content job to run

RunFillContentJob

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Schedule a new fill content job to run

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

string or null

Attach a station id if the rule is overriden on a station (Station Override Fill Rule)

LoadHistoryFromPlaylist
boolean

Load History from Zetta Cloud

IgnoreFillTag
boolean

Load History from Zetta Cloud

DoNotSeparateAssets
boolean

Do not separate assets into music and spoken word

FillJobKey
string

unique UUID to identify the fillJob

FillRuleKey
string

Unique file rule UUID, to identified what fill rule to use

FillHistoryKey
string

Unique file history UUID, identifies what fill history data to use

FillLength
number

Length in seconds on how much total fill content needs to be found

FillStartDateTime
string <date-time>

Fill is schedule to start playing datetime (ISO8601)

Array of strings or null

Asset Tags match ANY of these fill tags, to be included as asset fill content

Array of strings or null

Asset Tags MUST match ALL of these fill tags, to be included as asset fill content

number or null

Length in seconds on how for fill separation tag

FillCallbackUrl
string

POST - (Push) callback url we use to send the Fill playlist to once fill job has finished

VoiceTagResolveData (object) or null

VoiceTagResolveData

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "LoadHistoryFromPlaylist": true,
  • "IgnoreFillTag": true,
  • "DoNotSeparateAssets": true,
  • "FillJobKey": "string",
  • "FillRuleKey": "string",
  • "FillHistoryKey": "string",
  • "FillLength": 0,
  • "FillStartDateTime": "2019-08-24T14:15:22Z",
  • "FillAnyTags": [
    ],
  • "FillAllTags": [
    ],
  • "FillSeparationTagCap": 0,
  • "FillCallbackUrl": "string",
  • "VoiceTagResolveData": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

GSelector

Gets rotation shares

getHourRestrictions

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "Monday": [
    ],
  • "Tuesday": [
    ],
  • "Wednesday": [
    ],
  • "Thursday": [
    ],
  • "Friday": [
    ],
  • "Saturday": [
    ],
  • "Sunday": [
    ]
}

Import Rotation Shares

importRotationShares

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string
assetTypeID
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Rotation Shares wrapped in rotation model

Array of RaptorRotationShares (objects) or null

Responses

Request samples

Content type
application/json
{
  • "shares": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Gets category for given station and asset

getAssetCategory

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

Raptor Station ID

assetID
required
string

Raptor Asset ID

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
"string"

Sets category for given station and asset

setAssetCategory

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

Raptor Station ID

assetID
required
string

Raptor Asset ID

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
"string"

Gets categories for given station and assetType

getCategories

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string
assetTypeID
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
[
  • "string"
]

Gets rotation shares

getRotationShares

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string
assetTypeID
required
string
externalIDWithoutCut
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "shares": [
    ]
}

Import

Used to run or re-run an asset job (import asset, import asset event or re-analyze asset)

ImportRunJob

Authorizations:
LambdaTokenAuthorizer
path Parameters
assetJobKey
required
string

Asset Job Key, use the JobAPI to query available import Jobs

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Create new asset with uploaded audio file (Requires: AssetID, AssetTypeID and audio file to be uploaded from response!) Creates Import Jobs that are replayable!

ImportAsset

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Playlist events with single asset andaudio file to add to the Station/Organization

OrganizationID
string <guid> ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

asset type

string or null

primary title of asset

string or null

voice talent of asset

string or null

primary artist of asset

string or null

Global Display Title used for export (in band metadata, now playing export) across all stations

string or null

Global Display Artist used for export (in band metadata, now playing export) across all stations

string or null

advertiser name, example: McDonald’s

string or null

album name of asset

string or null

Brand, example: Nescafe

string or null

asset ISRC

string or null

asset ISCI

string or null

Record Label

string or null

Year Associated with the asser

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Comment

string or null

ImageUrl

string or null

Who Created this Asset: (examples: User Account, Music Point Service, Zetta Replication Service, ...)

string or null

Name of the original File, when the latest version of the asset was imported!

string or null

DO NOT USE - OBSOLETED (2020-08-27, Replaced with ReleaseDateTime)

string or null

Release datetime (ISO8601) - Audio can not be played before this datetime

string or null

end datetime (ISO8601) - Audio can not be played after this datetime

string or null

kill datetime (ISO8601) - Audio needs to removed/deleted from the system after this data

string or null

Recorded date - audio was added or modified (ISO8601)

Array of strings or null
  • tags associated with the asset
Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the asset (Depreciated 2019-07-01)

RaptorAssetThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with an asset. Please Use Recommending Naming Convention {Application}_{CustomField}

RaptorPOIMarkup (object) or null

Asset level Point of Interest markup

RaptorPOIPlaybackView (object) or null

Asset calculated Playback Points of Interest

Array of RaptorStationAsset (objects) or null

(READONLY) list of station asset values

RaptorAnalysisData (object) or null

data associated with an asset, when running audio Analysis

MusicPointSongDetail (object) or null

data associated with an asset, when imported from MusicPoint

RaptorAssetFillData (object) or null

Data associated with special asset fill rules

RaptorAssetFTPIngest (object) or null

FTP Ingest asset sub document

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Response samples

Content type
application/json
{
  • "jobkey": "string",
  • "url": "string",
  • "fields": {
    }
}

Create new asset and attach it to a playlist, primary use is to add voice tracks (Requires: PlaylistID, EventID, AssetID, AssetTypeID and audio file to be uploaded from response!) Creates Import Jobs that are replayable!

ImportAssetEvent

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create Playlist Event and Asset (and Asset Audio), Attaching them to the existing playlist

OrganizationID
string <guid> ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

AssetTypeID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

asset type

string or null

primary title of asset

string or null

voice talent of asset

string or null

primary artist of asset

string or null

Global Display Title used for export (in band metadata, now playing export) across all stations

string or null

Global Display Artist used for export (in band metadata, now playing export) across all stations

string or null

advertiser name, example: McDonald’s

string or null

album name of asset

string or null

Brand, example: Nescafe

string or null

asset ISRC

string or null

asset ISCI

string or null

Record Label

string or null

Year Associated with the asser

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

Comment

string or null

ImageUrl

string or null

Who Created this Asset: (examples: User Account, Music Point Service, Zetta Replication Service, ...)

string or null

Name of the original File, when the latest version of the asset was imported!

string or null

DO NOT USE - OBSOLETED (2020-08-27, Replaced with ReleaseDateTime)

string or null

Release datetime (ISO8601) - Audio can not be played before this datetime

string or null

end datetime (ISO8601) - Audio can not be played after this datetime

string or null

kill datetime (ISO8601) - Audio needs to removed/deleted from the system after this data

string or null

Recorded date - audio was added or modified (ISO8601)

Array of strings or null
  • tags associated with the asset
Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

External ids associated with the asset (Depreciated 2019-07-01)

RaptorAssetThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with an asset. Please Use Recommending Naming Convention {Application}_{CustomField}

RaptorPOIMarkup (object) or null

Asset level Point of Interest markup

RaptorPOIPlaybackView (object) or null

Asset calculated Playback Points of Interest

Array of RaptorStationAsset (objects) or null

(READONLY) list of station asset values

RaptorAnalysisData (object) or null

data associated with an asset, when running audio Analysis

MusicPointSongDetail (object) or null

data associated with an asset, when imported from MusicPoint

RaptorAssetFillData (object) or null

Data associated with special asset fill rules

RaptorAssetFTPIngest (object) or null

FTP Ingest asset sub document

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Title": "string",
  • "Voice": "string",
  • "Artist": "string",
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "Advertiser": "string",
  • "Album": "string",
  • "Brand": "string",
  • "ISRC": "string",
  • "ISCI": "string",
  • "Label": "string",
  • "Year": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Comment": "string",
  • "ImageUrl": "string",
  • "CreatedBy": "string",
  • "OriginalFileName": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "ReleaseDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "RecordedDate": "2019-08-24T14:15:22Z",
  • "Tags": [
    ],
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "POIMarkup": {
    },
  • "POIPlaybackView": {
    },
  • "StationAssets": [
    ],
  • "AnalysisData": {
    },
  • "MusicPointData": {
    },
  • "FillData": {
    },
  • "FTPIngest": {
    }
}

Response samples

Content type
application/json
{
  • "jobkey": "string",
  • "url": "string",
  • "fields": {
    }
}

Jobs

Returns an existing job to a 'Ready' State, then re-runs thejob!

ReplayJob

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobkey
required
string
query Parameters
ecrimage
string

used to override the ecr image to use, if not included will use latest..

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Get list of jobs by jobkeys, jobkeys ids are in the body as a json array

GetJobsByList

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

List of jobs to return

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
null

Get list of jobs by jobkeys, jobkeys ids are in the body as a json array

DeleteJobsByList

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

List of jobs to return

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
null

get number of jobs associated with the jobtype

GetJobCountByJobType

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobtype
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get job schedule by key

GetSchedule

Authorizations:
LambdaTokenAuthorizer
path Parameters
schedulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

will Create or replace a job schedule

PutSchedule

Authorizations:
LambdaTokenAuthorizer
path Parameters
schedulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Will create or replace a job schedule

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

ScheduleKey
string

unique schedule key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

ScheduleTitle
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job

Enabled
boolean

Used to enable or disable this ducking setting.

string or null

CRON representation of the schedule for the job, https://www.freebsd.org/cgi/man.cgi?crontab(5)

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

integer or null

Maximum number

string or null

Date to Enable the Job Schedule

string or null

Date to end the Job Schedule

string or null

Date after which this job schedule should be removed

integer or null

How many instances of this job have been scheduled

string or null

Job Created at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Delete job schedule by schedulekey

DeleteSchedule

Authorizations:
LambdaTokenAuthorizer
path Parameters
schedulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{ }

Patch an existing job schedule

PatchSchedule

Authorizations:
LambdaTokenAuthorizer
path Parameters
schedulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Partial update of an existing job schedule, only included fields will be updated.

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

ScheduleKey
string

unique schedule key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

ScheduleTitle
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job

Enabled
boolean

Used to enable or disable this ducking setting.

string or null

CRON representation of the schedule for the job, https://www.freebsd.org/cgi/man.cgi?crontab(5)

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

integer or null

Maximum number

string or null

Date to Enable the Job Schedule

string or null

Date to end the Job Schedule

string or null

Date after which this job schedule should be removed

integer or null

How many instances of this job have been scheduled

string or null

Job Created at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Create or Patch an job

AddOrUpdateJob

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create a new job under an Organization (based upon JobType)

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

JobKey
string

unique job key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

JobName
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job running

EnumJobStatus (string)

The current status of a scheduled job

string or null

kubernetes job name, pattern = rcs-job-{operation}-{JobName}

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

RaptorMessageResponse (object) or null

job result data, depends on job type (generally result data from running the job, json)

string or null

command line arguements associated with the scheduled job

string or null

Region where the job belongs

integer or null

Number of times the job has ran or attempted to run

string or null

POST - (Push) callback url we use to return datae to once the job has finished

string or null

if this job was scheduled, then this would link us back to schedule record

string or null

Job Created at datetime (ISO8601)

string or null

Job Scheduled at datetime (ISO8601)

string or null

Job Running at datetime (ISO8601)

string or null

Job Completed at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Used to Query jobs older than X minutes, support querying by job status

GetJobsOlderThan

Authorizations:
LambdaTokenAuthorizer
query Parameters
minutes
integer <int32>
Default: 1440

Jobs that have COMPLETED after his number of minutes can be deleted (default one day)

jobStatus
string
Default: "Completed"

The status of a job (Created, Scheduled, Running, Completed, Modified, Error)

jobType
string

The type of a job

pageNum
integer <int32>
Default: 1

page number to start gathering data from

itemsPerPage
integer <int23>
Default: 20

number of items per page to query

totalPages
integer <int32>
Default: 1

total number of pages to query

sortField
string
Default: "JobKey"

Field use to order the page

sortOrder
string
Default: "asc"

sort asc or desc

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{ }

Used to Delete jobs older than X minutes, support querying by job status

DeleteJobsOlderThan

Authorizations:
LambdaTokenAuthorizer
query Parameters
minutes
integer <int32>
Default: 1440

Jobs that have COMPLETED after his number of minutes can be deleted (default one day)

jobStatus
string
Default: "Completed"

The status of a job (Created, Scheduled, Running, Completed, Modified, Error)

jobType
string

The type of a job

pageNum
integer <int32>
Default: 1

page number to start gathering data from

itemsPerPage
integer <int23>
Default: 20

number of items per page to query

totalPages
integer <int32>
Default: 1

total number of pages to query

sortField
string
Default: "JobKey"

Field use to order the page

sortOrder
string
Default: "asc"

sort asc or desc

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
null

Query the job schedule collection with a graphQL query, supported types are jobschedules and schedulejobcount

GraphqlSchedule

Authorizations:
LambdaTokenAuthorizer
query Parameters
ScheduleJobType
string

Schedule JobType to filter on, this can be in the body but this will be more efficient

header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

GraphQL json

query
string

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
null

Create new job

CreateJob

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create a new job under an Organization

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

JobKey
string

unique job key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

JobName
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job running

EnumJobStatus (string)

The current status of a scheduled job

string or null

kubernetes job name, pattern = rcs-job-{operation}-{JobName}

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

RaptorMessageResponse (object) or null

job result data, depends on job type (generally result data from running the job, json)

string or null

command line arguements associated with the scheduled job

string or null

Region where the job belongs

integer or null

Number of times the job has ran or attempted to run

string or null

POST - (Push) callback url we use to return datae to once the job has finished

string or null

if this job was scheduled, then this would link us back to schedule record

string or null

Job Created at datetime (ISO8601)

string or null

Job Scheduled at datetime (ISO8601)

string or null

Job Running at datetime (ISO8601)

string or null

Job Completed at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Create and run a new job

CreateAndRunJob

Authorizations:
LambdaTokenAuthorizer
query Parameters
ecrimage
string

used to override the ecr image to use, if not included will use latest..

header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create and run a job request under an Organization

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

JobKey
string

unique job key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

JobName
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job running

EnumJobStatus (string)

The current status of a scheduled job

string or null

kubernetes job name, pattern = rcs-job-{operation}-{JobName}

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

RaptorMessageResponse (object) or null

job result data, depends on job type (generally result data from running the job, json)

string or null

command line arguements associated with the scheduled job

string or null

Region where the job belongs

integer or null

Number of times the job has ran or attempted to run

string or null

POST - (Push) callback url we use to return datae to once the job has finished

string or null

if this job was scheduled, then this would link us back to schedule record

string or null

Job Created at datetime (ISO8601)

string or null

Job Scheduled at datetime (ISO8601)

string or null

Job Running at datetime (ISO8601)

string or null

Job Completed at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Create new job schedule

CreateSchedule

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create a new job under an Organization

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

ScheduleKey
string

unique schedule key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

ScheduleTitle
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job

Enabled
boolean

Used to enable or disable this ducking setting.

string or null

CRON representation of the schedule for the job, https://www.freebsd.org/cgi/man.cgi?crontab(5)

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

integer or null

Maximum number

string or null

Date to Enable the Job Schedule

string or null

Date to end the Job Schedule

string or null

Date after which this job schedule should be removed

integer or null

How many instances of this job have been scheduled

string or null

Job Created at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Query the job table with a graphQL query, supported types are jobs and jobcount

Graphql

Authorizations:
LambdaTokenAuthorizer
query Parameters
JobType
string

JobType to filter on, this can be in the body but this will be more efficient

header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

GraphQL json

query
string

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
null

Create and run a new job

CreateAndRunJobInstanceFromSchedule

Authorizations:
LambdaTokenAuthorizer
path Parameters
schedulekey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Create or Patch an job schedule

AddOrUpdateSchedule

Authorizations:
LambdaTokenAuthorizer
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Create a new job schedule under an Organization (based upon JobType)

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

ScheduleKey
string

unique schedule key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

ScheduleTitle
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job

Enabled
boolean

Used to enable or disable this ducking setting.

string or null

CRON representation of the schedule for the job, https://www.freebsd.org/cgi/man.cgi?crontab(5)

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

integer or null

Maximum number

string or null

Date to Enable the Job Schedule

string or null

Date to end the Job Schedule

string or null

Date after which this job schedule should be removed

integer or null

How many instances of this job have been scheduled

string or null

Job Created at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Get list of Job by Job types and optional parameters

GetJobsByJobType

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobtype
required
string
query Parameters
pageNum
integer <int32>
Default: 1

page number to start gathering data from

itemsPerPage
integer <int23>
Default: 20

number of items per page to query

totalPages
integer <int32>
Default: 1

total number of pages to query

sortField
string
Default: "JobKey"

Field use to order the page

sortOrder
string
Default: "asc"

sort asc or desc

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "ScheduleKey": "string",
  • "ScheduleTitle": "string",
  • "ScheduleJobType": "Invalid",
  • "Enabled": true,
  • "CronSchedule": "string",
  • "Description": "string",
  • "ScheduleJobData": { },
  • "MaxCount": 0,
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "KillDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledJobsCount": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Get job by key

GetJob

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobkey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

will Create or replace an job.

PutJob

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobkey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Will create or replace an job

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

JobKey
string

unique job key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

JobName
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job running

EnumJobStatus (string)

The current status of a scheduled job

string or null

kubernetes job name, pattern = rcs-job-{operation}-{JobName}

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

RaptorMessageResponse (object) or null

job result data, depends on job type (generally result data from running the job, json)

string or null

command line arguements associated with the scheduled job

string or null

Region where the job belongs

integer or null

Number of times the job has ran or attempted to run

string or null

POST - (Push) callback url we use to return datae to once the job has finished

string or null

if this job was scheduled, then this would link us back to schedule record

string or null

Job Created at datetime (ISO8601)

string or null

Job Scheduled at datetime (ISO8601)

string or null

Job Running at datetime (ISO8601)

string or null

Job Completed at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Delete job by jobkey

DeleteJob

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobkey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{ }

Patch an existing job

PatchJob

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobkey
required
string
header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

Partial update of an existing job, only included fields will be updated.

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

JobKey
string

unique job key using pattern recommended pattern: {awsguid}({orgguid}){trackingguid}.{operation}

JobName
string

Job Name is to group and track similar job request, ( example Asset Jobs are using AssetIDs... )

EnumJobType (string)

Enumeration describing the type of job running

EnumJobStatus (string)

The current status of a scheduled job

string or null

kubernetes job name, pattern = rcs-job-{operation}-{JobName}

string or null

job description

object or null

job request data, depends on job type (generally request data need to run the job, json)

RaptorMessageResponse (object) or null

job result data, depends on job type (generally result data from running the job, json)

string or null

command line arguements associated with the scheduled job

string or null

Region where the job belongs

integer or null

Number of times the job has ran or attempted to run

string or null

POST - (Push) callback url we use to return datae to once the job has finished

string or null

if this job was scheduled, then this would link us back to schedule record

string or null

Job Created at datetime (ISO8601)

string or null

Job Scheduled at datetime (ISO8601)

string or null

Job Running at datetime (ISO8601)

string or null

Job Completed at datetime (ISO8601)

string or null

Job Modified at datetime (ISO8601)

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Can be used to run 'Ready' Jobs.

RunJob

Authorizations:
LambdaTokenAuthorizer
path Parameters
jobkey
required
string
query Parameters
ecrimage
string

used to override the ecrimage to use, if not included will use latest..

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "JobKey": "string",
  • "JobName": "string",
  • "JobType": "Invalid",
  • "JobStatus": "Invalid",
  • "KubeJob": "string",
  • "Description": "string",
  • "JobRequestData": { },
  • "JobResultData": {
    },
  • "Arguments": "string",
  • "JobCluster": "string",
  • "JobRunCount": 0,
  • "JobCallbackUrl": "string",
  • "ScheduleKey": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledDateTime": "2019-08-24T14:15:22Z",
  • "RunningDateTime": "2019-08-24T14:15:22Z",
  • "CompletedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Used to get a job count for jobs older than X minutes, support querying by job status

CountJobsOlderThan

Authorizations:
LambdaTokenAuthorizer
query Parameters
minutes
integer <int32>
Default: 1440

Jobs that have COMPLETED after his number of minutes can be deleted (default one day)

jobStatus
string
Default: "Completed"

The status of a job (Created, Scheduled, Running, Completed, Modified, Error)

jobType
string

The type of a job

header Parameters
z-cloud-org-id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Organization

Get all internal roles

GetInternalRoles

Authorizations:
LambdaTokenAuthorizer

Responses

Response samples

Content type
application/json
{ }

Get all flat file templates

GetAllFlatFileTemplates

Authorizations:
LambdaTokenAuthorizer
path Parameters
flatFileType
required
string

Flat File Type - see enum EnumFlatFileType in schema

query Parameters
includeContent
boolean
Default: false

Should include template contents, defaults to FALSE

Responses

Response samples

Content type
application/json
null

Get all organizations

GetAllOrganizations

Authorizations:
LambdaTokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Get flat file template by name

GetFlatFileTemplate

Authorizations:
LambdaTokenAuthorizer
path Parameters
flatFileType
required
string

Flat File Type - see enum EnumFlatFileType in schema

name
required
string

Flat File Template Name

Responses

Response samples

Content type
application/json
null

Get a organization by ID

GetOrganization

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization ID

query Parameters
IncludeStations
boolean
Default: true

Should the get org call return the org's station list, defaults to TRUE

Includelanguages
boolean
Default: false

Should the get org call return the org's languages list, defaults to FALSE

IncludeLayouts
boolean
Default: false

Should the get org call return the org's layouts list, defaults to FALSE

IncludeDomainSuffix
boolean
Default: false

Should the get org call return the org's dommain suffix from Security Api

Responses

Response samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Updates and existing organization, Requires: OrgId, OrgName

UpdateOrganization

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

Request Body schema: application/json

The organization will be only include all data passed in the update call

OrgID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

OrgName
string

organization name

SecurityOrgId
string

Organization's id at the Security API

Array of RaptorStation (objects) or null

(READONLY ARRAY) Optionally Stations can be returned when getting an organization, NOTE: stations are not stored within the organization

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

RaptorCluster (object) (Cluster)

Configure primary, secondary (optional) and current cluster

RaptorMusicSource (object) or Music Source (null) (Music Source)

[OBSOLETE] Listing for Music Source

RaptorMusicSourceDictionary (object) or Music Sources (null) (Music Sources)

A Dictionary of music sources configuration, Dictionary Key is the MusicSource Key

RaptorOKTAInfo (object) or group OKTA info (null) (group OKTA info)

group OKTA info

Current Storage (number) or Current Storage (null) (Current Storage)

Current Total S3 Bucket Storage for Organization

Storage Count (number) or Storage Count (null) (Storage Count)

Current Total S3 Objects for Organization

Storage Threshold (number) or Storage Threshold (null) (Storage Threshold)

Organization storage threshold Alert

Online Channel Licenses (number) or Online Channel Licenses (null) (Online Channel Licenses)

Organization online channel licenses

null or RaptorLayoutDictionary (object)

A Dictionary of all public layouts for the organzization, NOTE: layouts are not stored within the organization

Responses

Request samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Response samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Delete organization by id

DeleteOrganization

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

Responses

Response samples

Content type
application/json
{ }

patches an existing organization, Requires: OrgId

PatchOrganization

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

Request Body schema: application/json

The organization will be only include all data passed in the update call

OrgID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

OrgName
string

organization name

SecurityOrgId
string

Organization's id at the Security API

Array of RaptorStation (objects) or null

(READONLY ARRAY) Optionally Stations can be returned when getting an organization, NOTE: stations are not stored within the organization

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

RaptorCluster (object) (Cluster)

Configure primary, secondary (optional) and current cluster

RaptorMusicSource (object) or Music Source (null) (Music Source)

[OBSOLETE] Listing for Music Source

RaptorMusicSourceDictionary (object) or Music Sources (null) (Music Sources)

A Dictionary of music sources configuration, Dictionary Key is the MusicSource Key

RaptorOKTAInfo (object) or group OKTA info (null) (group OKTA info)

group OKTA info

Current Storage (number) or Current Storage (null) (Current Storage)

Current Total S3 Bucket Storage for Organization

Storage Count (number) or Storage Count (null) (Storage Count)

Current Total S3 Objects for Organization

Storage Threshold (number) or Storage Threshold (null) (Storage Threshold)

Organization storage threshold Alert

Online Channel Licenses (number) or Online Channel Licenses (null) (Online Channel Licenses)

Organization online channel licenses

null or RaptorLayoutDictionary (object)

A Dictionary of all public layouts for the organzization, NOTE: layouts are not stored within the organization

Responses

Request samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Response samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Get layout by id

GetLayout

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

layoutid
required
string

layout id

Responses

Response samples

Content type
application/json
{
  • "LayoutID": "string",
  • "OrganizationID": "string",
  • "LayoutName": "string",
  • "Public": true,
  • "Locked": true,
  • "State": "string",
  • "Modules": { },
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Update an existing layout, or add a new one if the layout not found by LayoutID, Requires: LayoutID, LayoutName, OrganizationID

UpdateLayout

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

layoutid
required
string

layout id

Request Body schema: application/json

Will update ALL fields for an existing layout, missing fields will be reset to NULL!

LayoutID
required
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Unique ID (Guid)

OrganizationID
required
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

LayoutName
required
string

Layout name

boolean or null

Is this a public layout. NOTE: will always be 'true' for layouts saved to the DB.

boolean or null

Is the layout locked

string or null

Serialized JSON representing the dock-spawn-ts state of the layout

null or RaptorLayoutModuleDictionary (object)

A Dictionary of the layout modules. NOTE: modules are stored within the layout

ModifiedDateTime
string <date-time>

The last layout's date and time updated

Responses

Request samples

Content type
application/json
{
  • "LayoutID": "string",
  • "OrganizationID": "string",
  • "LayoutName": "string",
  • "Public": true,
  • "Locked": true,
  • "State": "string",
  • "Modules": { },
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "LayoutID": "string",
  • "OrganizationID": "string",
  • "LayoutName": "string",
  • "Public": true,
  • "Locked": true,
  • "State": "string",
  • "Modules": { },
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Delete layout by id

DeleteLayout

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

layoutid
required
string

layout id

Responses

Response samples

Content type
application/json
{ }

Patches an existing layout, Requires: OrganizationID, LayoutID

PatchLayout

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

layoutid
required
string

layout id

Request Body schema: application/json

The layout can only include the fields that need to be updated

LayoutID
required
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Unique ID (Guid)

OrganizationID
required
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

LayoutName
required
string

Layout name

boolean or null

Is this a public layout. NOTE: will always be 'true' for layouts saved to the DB.

boolean or null

Is the layout locked

string or null

Serialized JSON representing the dock-spawn-ts state of the layout

null or RaptorLayoutModuleDictionary (object)

A Dictionary of the layout modules. NOTE: modules are stored within the layout

ModifiedDateTime
string <date-time>

The last layout's date and time updated

Responses

Request samples

Content type
application/json
{
  • "LayoutID": "string",
  • "OrganizationID": "string",
  • "LayoutName": "string",
  • "Public": true,
  • "Locked": true,
  • "State": "string",
  • "Modules": { },
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "LayoutID": "string",
  • "OrganizationID": "string",
  • "LayoutName": "string",
  • "Public": true,
  • "Locked": true,
  • "State": "string",
  • "Modules": { },
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Get a dictionary of layouts by organizationid

GetOrganizationLayouts

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Add/Update an organization language, Requires: OrgId, locale

SaveLanguage

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

locale
required
string

locale

Request Body schema: application/json

The organization and locale be include data passed in the update call

object

Represents the object that contains each Zetta Cloud's label translated

Responses

Request samples

Content type
application/json
{
  • "catalog": {
    }
}

Response samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Remove organization language, Requires: OrgId, locale

RemoveLanguage

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

locale
required
string

locale

Responses

Response samples

Content type
application/json
{
  • "OrgID": "string",
  • "OrgName": "string",
  • "SecurityOrgId": "string",
  • "Stations": [
    ],
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "MusicSource": {
    },
  • "MusicSourceDictionary": {
    },
  • "okta": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "Layouts": { }
}

Create new organization, Requires: OrgName

CreateOrganization

Authorizations:
LambdaTokenAuthorizer
query Parameters
inhibitAssetTypes
boolean
Default: false

Inhibits the creation of the pre-canned asset types, mostly because Zetta likes to do it for itself.

Request Body schema: application/json

Create new organization. Requires: OrgName

SecurityOrgId
required
string

Organization's id at the Security API

OrgID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

OrgName
required
string

organization name

string or null

Created datetime (ISO8601)

ZettaCluster (object) (Cluster)

Configure primary, secondary (optional) and current cluster

Current Storage (number) or Current Storage (null) (Current Storage)

Current Total S3 Bucket Storage for Organization

Storage Count (number) or Storage Count (null) (Storage Count)

Current Total S3 Objects for Organization

Storage Threshold (number) or Storage Threshold (null) (Storage Threshold)

Organization storage threshold Alert

Online Channel Licenses (number) or Online Channel Licenses (null) (Online Channel Licenses)

Organization online channel licenses

Created by (string) or Created by (null) (Created by)

User created new organization

Modified by (string) or Modified by (null) (Modified by)

User updated an organization

Responses

Request samples

Content type
application/json
{
  • "SecurityOrgId": "string",
  • "OrgID": "string",
  • "OrgName": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "CreatedBy": "string",
  • "ModifiedBy": "string"
}

Response samples

Content type
application/json
{
  • "SecurityId": "string",
  • "Id": "string",
  • "Name": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "Cluster": {
    },
  • "CurrentStorage": 0,
  • "StorageCount": 0,
  • "StorageThreshold": 0,
  • "OnlineChannelLicenses": 0,
  • "CreatedBy": "string",
  • "ModifiedBy": "string"
}

Create new layout, Requires: LayoutID, LayoutName

CreateLayout

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

organization id

Request Body schema: application/json

Create new organization. Requires: LayoutID, LayoutName

LayoutID
required
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Unique ID (Guid)

OrganizationID
required
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

LayoutName
required
string

Layout name

boolean or null

Is this a public layout. NOTE: will always be 'true' for layouts saved to the DB.

boolean or null

Is the layout locked

string or null

Serialized JSON representing the dock-spawn-ts state of the layout

null or RaptorLayoutModuleDictionary (object)

A Dictionary of the layout modules. NOTE: modules are stored within the layout

ModifiedDateTime
string <date-time>

The last layout's date and time updated

Responses

Request samples

Content type
application/json
{
  • "LayoutID": "string",
  • "OrganizationID": "string",
  • "LayoutName": "string",
  • "Public": true,
  • "Locked": true,
  • "State": "string",
  • "Modules": { },
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "LayoutID": "string",
  • "OrganizationID": "string",
  • "LayoutName": "string",
  • "Public": true,
  • "Locked": true,
  • "State": "string",
  • "Modules": { },
  • "ModifiedDateTime": "2019-08-24T14:15:22Z"
}

Playlist

Sync a station log to a past event, required fields: stationID, startPlaylistID, startMinSequenceNumber, endPlaylistID, endMaxSequenceNumber, lastModifyDescription, statusCode, errorCode

SyncToPastEvent

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Sync a station log to a past event, all Params required

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Station ID, to perform the Sync To Event On

StartPlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Playlist ID, Where to synchronize To (Target Event Playlist)

StartMinSequenceNumber
number

Sequence Number synchronizing to (Target Event Sequence Number)

EndPlaylistStartTime
string <date-time>

Synchronization time From (present time) (DateTime) in Zulu UTC

MinHardTime
string <date-time>

reset any hardtime event after this time (DateTime) in Zulu UTC, (normally current time stamp)

LastModifyDescription
string

Explanation of why we are performing the synchronization

EnumEventStatusCode (integer) or null

The Status code to set all synchronized event too

EnumEventErrorCode (integer) or null

The Error code to set all synchronized event too

Responses

Request samples

Content type
application/json
{
  • "StationID": "string",
  • "StartPlaylistID": "string",
  • "StartMinSequenceNumber": 0,
  • "EndPlaylistStartTime": "2019-08-24T14:15:22Z",
  • "MinHardTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ]
}

Response samples

Content type
application/json
{
  • "UpdateCount": 0,
  • "ErrorCount": 0
}

Sequencer only used to get the startup location in the log

GetLastEtmEvent

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

stationid to search for a playlist

minPlaylistStart
required
string

Minimum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

maxPlaylistStart
required
string

Maximum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Sequencer only used to get the startup location in the log

GetLastEtmEvent

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

stationid to search for a playlist

minPlaylistStart
required
string

Minimum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

maxPlaylistStart
required
string

Maximum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Get playlists by StationID and PlaylistTypeID

GetPlaylistByPlaylistType

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationid
required
string

stationid to search for a playlist

playlisttype
required
string

playlist type to search for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sequencer only, used to load the next x number of events from the database

GetNextPlaylistEvents

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

stationid to search for a playlist

minPlaylistStart
required
string

Minimum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

maxPlaylistStart
required
string

Maximum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

minEventSequenceNumber
required
string

Minimum sequence number to start looking from

count
required
string

Number of events to send back"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sequencer only, used to load the next x number of events from the database

GetNextPlaylistEvents

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

stationid to search for a playlist

minPlaylistStart
required
string

Minimum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

maxPlaylistStart
required
string

Maximum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

minEventSequenceNumber
required
string

Minimum sequence number to start looking from

count
required
string

Number of events to send back"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new playlist event, Requires: StationID, Title

createPlaylist

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create new playlist Requires: StationID, Title

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

EnumPlaylistType (integer) or null

type of playlist

Priority
number

relative priority of playlist

number or null

number of rows in the playlist (Hot Keys Playlist Type)

number or null

number of columns in the playlist (Hot Keys Playlist Type)

Title
string

title of playlist

number or null

Playlist TargetLength in seconds.ms

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

stationID who owns the playlist

EnumPlaylistState (integer) or null

Current state of this playlist

string or null

When the Playlist is Scheduled to Start datetime (ISO8601)

string or null

When the Playlist is Scheduled to End datetime

string or null

When the Playlist is Scheduled to Start datetime (ISO8601)

string or null

When the Playlist is Scheduled to End datetime

Array of strings or null

playlist triggers

Array of strings or null

tags associated with the station

Array of strings or null

List of playlist IDs who are copies of this playlist

Array of RaptorEvent (objects) or null

(READONLY ARRAY) - details of the list of events in the playlist

object (RaptorETMWindow)

Used to determine accuracy of an ETM Window

number or null

Sequence number of the current hotline in this playlist

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

Show (object) or null

Show

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "PlaylistType": [
    ],
  • "Priority": 0,
  • "Rows": 0,
  • "Columns": 0,
  • "Title": "string",
  • "TargetLength": 0,
  • "StationID": "string",
  • "State": [
    ],
  • "ScheduledStartDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledEndDateTime": "2019-08-24T14:15:22Z",
  • "ActualStartDateTime": "2019-08-24T14:15:22Z",
  • "ActualEndDateTime": "2019-08-24T14:15:22Z",
  • "Triggers": [
    ],
  • "Tags": [
    ],
  • "Duplicates": [
    ],
  • "Events": [
    ],
  • "ETMWindow": {
    },
  • "HotlineSequence": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Show": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "PlaylistType": [
    ],
  • "Priority": 0,
  • "Rows": 0,
  • "Columns": 0,
  • "Title": "string",
  • "TargetLength": 0,
  • "StationID": "string",
  • "State": [
    ],
  • "ScheduledStartDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledEndDateTime": "2019-08-24T14:15:22Z",
  • "ActualStartDateTime": "2019-08-24T14:15:22Z",
  • "ActualEndDateTime": "2019-08-24T14:15:22Z",
  • "Triggers": [
    ],
  • "Tags": [
    ],
  • "Duplicates": [
    ],
  • "Events": [
    ],
  • "ETMWindow": {
    },
  • "HotlineSequence": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Show": {
    }
}

Returns the prior etm event from the passed in blockEventID

GetSplitEtm

Authorizations:
LambdaTokenAuthorizer
path Parameters
blockEventID
required
string

Block event EventID

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Sync a station log to a future event, required fields: stationID, startPlaylistID, startMinSequenceNumber, endPlaylistID, endMaxSequenceNumber, lastModifyDescription, statusCode, errorCode

SyncToFutureEvent

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Sync a station log to a future event, all Params required

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Station ID, to perform the Sync To Event On

StartPlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Playlist ID, Where to synchronize To (Target Event Playlist)

StartMinSequenceNumber
number

Sequence Number synchronizing to (Target Event Sequence Number)

EndPlaylistStartTime
string <date-time>

Synchronization time From (present time) (DateTime) in Zulu UTC

MinHardTime
string <date-time>

reset any hardtime event after this time (DateTime) in Zulu UTC, (normally current time stamp)

LastModifyDescription
string

Explanation of why we are performing the synchronization

EnumEventStatusCode (integer) or null

The Status code to set all synchronized event too

EnumEventErrorCode (integer) or null

The Error code to set all synchronized event too

Responses

Request samples

Content type
application/json
{
  • "StationID": "string",
  • "StartPlaylistID": "string",
  • "StartMinSequenceNumber": 0,
  • "EndPlaylistStartTime": "2019-08-24T14:15:22Z",
  • "MinHardTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ]
}

Response samples

Content type
application/json
{
  • "UpdateCount": 0,
  • "ErrorCount": 0
}

Query the playlist table with a graphQL query

GraphQL

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Query the playlist table with a graphQL query

query
string

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets an array of playlists between the passed in dates

GetPlaylistBySchedule

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationid
required
string

StationID

start
required
string

Start date as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ

end
required
string

End date as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ

query Parameters
ReturnChildEvents
boolean
Default: true

Used to identify if the call should return all the events in the playlist

PlaylistType
integer
Default: 1

If Set the playlists will be filtered to this type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets an array of playlists between the passed in dates

GetPlaylistBySchedule

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationid
required
string

StationID

start
required
string

Start date as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ

end
required
string

End date as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ

query Parameters
ReturnChildEvents
boolean
Default: true

Used to identify if the call should return all the events in the playlist

PlaylistType
integer
Default: 1

If Set the playlists will be filtered to this type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query the asset or event table with a graphQL query, supported types are events

EventAssetSearch

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

stationid to search for a playlist

minPlaylistStart
required
string

Minimum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

maxPlaylistStart
required
string

Maximum date to start looking for an etm event as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

Request Body schema: application/json

GraphQL json

query
string

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get a playlist by ID

GetPlaylist

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

Playlist ID

query Parameters
ReturnChildEvents
boolean
Default: true

Used to identify if the call should return all the events in the playlist

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates or creates a playlist, Requires: PlaylistID, StationID, Title

UpdatePlaylist

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

Playlist ID

Request Body schema: application/json

The playlist will be only include all data passed in the update call

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

EnumPlaylistType (integer) or null

type of playlist

Priority
number

relative priority of playlist

number or null

number of rows in the playlist (Hot Keys Playlist Type)

number or null

number of columns in the playlist (Hot Keys Playlist Type)

Title
string

title of playlist

number or null

Playlist TargetLength in seconds.ms

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

stationID who owns the playlist

EnumPlaylistState (integer) or null

Current state of this playlist

string or null

When the Playlist is Scheduled to Start datetime (ISO8601)

string or null

When the Playlist is Scheduled to End datetime

string or null

When the Playlist is Scheduled to Start datetime (ISO8601)

string or null

When the Playlist is Scheduled to End datetime

Array of strings or null

playlist triggers

Array of strings or null

tags associated with the station

Array of strings or null

List of playlist IDs who are copies of this playlist

Array of RaptorEvent (objects) or null

(READONLY ARRAY) - details of the list of events in the playlist

object (RaptorETMWindow)

Used to determine accuracy of an ETM Window

number or null

Sequence number of the current hotline in this playlist

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

Show (object) or null

Show

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "PlaylistType": [
    ],
  • "Priority": 0,
  • "Rows": 0,
  • "Columns": 0,
  • "Title": "string",
  • "TargetLength": 0,
  • "StationID": "string",
  • "State": [
    ],
  • "ScheduledStartDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledEndDateTime": "2019-08-24T14:15:22Z",
  • "ActualStartDateTime": "2019-08-24T14:15:22Z",
  • "ActualEndDateTime": "2019-08-24T14:15:22Z",
  • "Triggers": [
    ],
  • "Tags": [
    ],
  • "Duplicates": [
    ],
  • "Events": [
    ],
  • "ETMWindow": {
    },
  • "HotlineSequence": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Show": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "PlaylistType": [
    ],
  • "Priority": 0,
  • "Rows": 0,
  • "Columns": 0,
  • "Title": "string",
  • "TargetLength": 0,
  • "StationID": "string",
  • "State": [
    ],
  • "ScheduledStartDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledEndDateTime": "2019-08-24T14:15:22Z",
  • "ActualStartDateTime": "2019-08-24T14:15:22Z",
  • "ActualEndDateTime": "2019-08-24T14:15:22Z",
  • "Triggers": [
    ],
  • "Tags": [
    ],
  • "Duplicates": [
    ],
  • "Events": [
    ],
  • "ETMWindow": {
    },
  • "HotlineSequence": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Show": {
    }
}

Delete playlist by id

DeletePlaylist

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

playlist id

Responses

Response samples

Content type
application/json
{ }

Patch an existing playlist, Requires: PlaylistID

PatchPlaylist

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

Playlist ID

Request Body schema: application/json

The playlist data we wish to patch

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

PlaylistID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

EnumPlaylistType (integer) or null

type of playlist

Priority
number

relative priority of playlist

number or null

number of rows in the playlist (Hot Keys Playlist Type)

number or null

number of columns in the playlist (Hot Keys Playlist Type)

Title
string

title of playlist

number or null

Playlist TargetLength in seconds.ms

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

stationID who owns the playlist

EnumPlaylistState (integer) or null

Current state of this playlist

string or null

When the Playlist is Scheduled to Start datetime (ISO8601)

string or null

When the Playlist is Scheduled to End datetime

string or null

When the Playlist is Scheduled to Start datetime (ISO8601)

string or null

When the Playlist is Scheduled to End datetime

Array of strings or null

playlist triggers

Array of strings or null

tags associated with the station

Array of strings or null

List of playlist IDs who are copies of this playlist

Array of RaptorEvent (objects) or null

(READONLY ARRAY) - details of the list of events in the playlist

object (RaptorETMWindow)

Used to determine accuracy of an ETM Window

number or null

Sequence number of the current hotline in this playlist

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

Show (object) or null

Show

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "PlaylistType": [
    ],
  • "Priority": 0,
  • "Rows": 0,
  • "Columns": 0,
  • "Title": "string",
  • "TargetLength": 0,
  • "StationID": "string",
  • "State": [
    ],
  • "ScheduledStartDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledEndDateTime": "2019-08-24T14:15:22Z",
  • "ActualStartDateTime": "2019-08-24T14:15:22Z",
  • "ActualEndDateTime": "2019-08-24T14:15:22Z",
  • "Triggers": [
    ],
  • "Tags": [
    ],
  • "Duplicates": [
    ],
  • "Events": [
    ],
  • "ETMWindow": {
    },
  • "HotlineSequence": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Show": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "PlaylistType": [
    ],
  • "Priority": 0,
  • "Rows": 0,
  • "Columns": 0,
  • "Title": "string",
  • "TargetLength": 0,
  • "StationID": "string",
  • "State": [
    ],
  • "ScheduledStartDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledEndDateTime": "2019-08-24T14:15:22Z",
  • "ActualStartDateTime": "2019-08-24T14:15:22Z",
  • "ActualEndDateTime": "2019-08-24T14:15:22Z",
  • "Triggers": [
    ],
  • "Tags": [
    ],
  • "Duplicates": [
    ],
  • "Events": [
    ],
  • "ETMWindow": {
    },
  • "HotlineSequence": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Show": {
    }
}

Returns the next spot block after the passed in etm time

GetSplitSpotBlock

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

stationid to search for a playlist

etmTime
required
string

ETM datetime as ISO 8601 (ZULU) "yyyy-MM-ddTHH:mm:ss.fffZ"

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "EventID": "string",
  • "SequenceNumber": 0,
  • "EventType": [
    ],
  • "Description": "string",
  • "StatusCode": [
    ],
  • "ErrorCode": [
    ],
  • "EditCode": [
    ],
  • "EtmType": [
    ],
  • "Chain": [
    ],
  • "AirStartDateTime": "2019-08-24T14:15:22Z",
  • "AirStopDateTime": "2019-08-24T14:15:22Z",
  • "Skipped": true,
  • "AssetID": "string",
  • "AssetTypeID": "string",
  • "Asset": {
    },
  • "HardTime": 0,
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": [
    ],
  • "Version": 0,
  • "Note": "string",
  • "Color": "string",
  • "OverridePOIMarkup": {
    },
  • "ChildPlaylistID": "string",
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "LastModifyDescription": "string",
  • "TimingType": [
    ],
  • "OverrideSplitBehavior": 0,
  • "PreviousEventID": "string",
  • "NextEventID": "string",
  • "LinearAdData": {
    },
  • "NetworkLinearAdData": {
    },
  • "BlockType": [
    ],
  • "AssetRotationID": "string"
}

Proxy

CORS Support

CORS Support

path Parameters
proxy
required
string

Responses

Reports

getReportsByTimeRange

getReportsByTimeRange

Authorizations:
LambdaTokenAuthorizer
path Parameters
start
required
string
end
required
string

Responses

Response samples

Content type
application/json
[
  • { }
]

Spotblock Playlist

Get playlists by StationID and PlaylistTypeID

GetPlaylistByPlaylistType

Authorizations:
LambdaTokenAuthorizer
path Parameters
eventId
required
string

Spotblock Event ID

query Parameters
returnTrafficPlaylist
boolean
Default: true

Should the traffic event be returned under the traffic playlist or the child playlist, used by the sequencer

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "PlaylistID": "string",
  • "PlaylistType": [
    ],
  • "Priority": 0,
  • "Rows": 0,
  • "Columns": 0,
  • "Title": "string",
  • "TargetLength": 0,
  • "StationID": "string",
  • "State": [
    ],
  • "ScheduledStartDateTime": "2019-08-24T14:15:22Z",
  • "ScheduledEndDateTime": "2019-08-24T14:15:22Z",
  • "ActualStartDateTime": "2019-08-24T14:15:22Z",
  • "ActualEndDateTime": "2019-08-24T14:15:22Z",
  • "Triggers": [
    ],
  • "Tags": [
    ],
  • "Duplicates": [
    ],
  • "Events": [
    ],
  • "ETMWindow": {
    },
  • "HotlineSequence": 0,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Show": {
    }
}

Station

Deploy Station containers and services

LaunchStation

Authorizations:
LambdaTokenAuthorizer
path Parameters
orgId
required
string

organization id

stationId
required
string

station id

query Parameters
dryRun
boolean
Default: true

allow launch to run through validation check and call the k8s deploy service with dry run only

playerVersion
string
Default: "latest"

version of the player to deploy

sequencerVersion
string
Default: "latest"

version of the sequencer to deploy

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

generate a device startup script for a hardware device

GetEdgeDocker

Authorizations:
LambdaTokenAuthorizer
path Parameters
serialnumber
required
string

serial number of hardware device generate a device startup script for

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Deploy split receiver by station id

UpdateSplitReceiverDeployment

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

station id

query Parameters
dryRun
boolean
Default: true

allow launch to run through validation check and call the jenkins job with dry run only

version
string
Default: "latest"

version deploy

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get an array of stations by organizationid

GetStationByOrganization

Authorizations:
LambdaTokenAuthorizer
path Parameters
organizationid
required
string

organization id

Responses

Response samples

Content type
application/json
null

Deploy Station(s) by organization or station using wild card *

UpdateStationDeployment

Authorizations:
LambdaTokenAuthorizer
path Parameters
orgId
required
string

organization id (* = all/any organizations)

stationId
required
string

station id (* = all/any station)

query Parameters
dryRun
boolean
Default: true

allow launch to run through validation check and call the deployment job with dry run only

playerVersion
string
Default: "latest"

version of the player to deploy

sequencerVersion
string
Default: "latest"

version of the sequencer to deploy

tag
string

Deployment Tag

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update station status by stationid

UpdateStationStatus

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

station id

status
required
string

The new station status, (Enums: #/definitions/EnumStationConfigStatus)

Responses

Response samples

Content type
application/json
{ }

Query the station table with a graphQL query

graphQL query

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

GraphQL json

query
string

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
null

Get docker information for a player

Get Docker

Authorizations:
LambdaTokenAuthorizer
path Parameters
serialnumber
required
string

serial number of hardware device generate a device startup script for

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get station by id

Get Station

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

station id

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "StationName": "string",
  • "ConstantName": "string",
  • "StationCallLetters": "string",
  • "StationDescription": "string",
  • "StationTimeZone": "string",
  • "StationStatus": [
    ],
  • "Cluster": {
    },
  • "Mixers": [
    ],
  • "PlayerDictionary": { },
  • "GPIODeviceDictionary": { },
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": {
    },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Paused": true,
  • "StationMode": [
    ],
  • "AvailableModes": [
    ],
  • "FillHistoryLength": 1200,
  • "Traffic": {
    },
  • "Billboards": [
    ],
  • "AutoFade": [
    ],
  • "FadeLength": 0,
  • "NormalizationTarget": 0,
  • "BedDuckingLevel": 0,
  • "ZettaSplitReceiver": [
    ],
  • "SplitMasterStationID": "string",
  • "OverrideSequencerSettings": { },
  • "OverrideAssetTypeSettings": { },
  • "NielsenConfig": { },
  • "LastModifyDescription": "string",
  • "SoftEtmEarlyWindow": 0,
  • "SoftEtmLateWindow": 0,
  • "GSelectorSettings": {
    },
  • "MaxStretchPercent": 0,
  • "MaxSqueezePercent": 0,
  • "ApplyStretchSqueezeWithinSoftETMWindow": true,
  • "EmergencyPlaylistID": "string",
  • "EtmFillTags": [
    ],
  • "BlockFillTags": [
    ],
  • "Market": "string",
  • "StreamID": "string",
  • "OutputIcyTitleTemplate": "string",
  • "OutputIcyURLTemplate": "string",
  • "LinearAdsEnabled": true,
  • "SpotAssetType": true,
  • "EASTestAssetID": "string",
  • "ConnectedSplitStations": [
    ]
}

Will update ALL fields for an existing station, missing fields will be reset to NULL!

Put Station

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

station id

Request Body schema: application/json

Will update ALL fields for an existing station, missing fields will be reset to NULL!

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

StationName
string

Station name

ConstantName
string

Immutable human-readable identifier

StationCallLetters
string

Station Call Letters

StationDescription
string

Description for the station

string or null

station time zone in UTC with offset

EnumStationConfigStatus (integer) or null

station status

RaptorCluster (object) (Cluster)

Configure primary, secondary (optional) and current cluster

Array of RaptorPlayerMixerConfig (objects) or null

(OBSOLETE 2020-03-01) Configuration of multiple playback mixer (a collection input and output) devices being used by the raptor player

null or RaptorPlayerConfigDictionary (object)

A Dictionary of all players, being used by the Raptor Player, Dictionary Key is the Player Key

null or RaptorGPIODeviceDictionary (object)

A Configuration Dictionary of all gpio devices, being used by this station

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

external ids associated with a stations (Depreciated 2019-07-01)

RaptorStationThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a stations, Please Use Recommending Naming Convention {Application}_{CustomField}

object or null

tags associated with the station

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

boolean or null

is Station in Paused State?

EnumSequencerMode (integer) or null

Current station mode

Array of EnumSequencerMode (integers) or null

Modes Available in the GUI for this station

number or null
Default: 1200

Length of history fetched for fill

RaptorStationTrafficConfig (object) or null

Traffic config

Array of RaptorStationBillboardConfig (objects) or null

Billboard outputs

EnumSequencerAutoFade (integer) or null

Is auto fade at segue enabled for this station

number or null

Length of auto fade

number or null

Length of auto fade

number or null

Ducking Level for Beds

EnumZettaSplitReceiver (integer) or null

Should we start a tcp listener to receive split command from zetta

string or null

stationID of the split master

RaptorOverrideDictionary (object) or null

Override dictionary used to define Custom sequencer configuration that might be overwritten on a station

null or RaptorOverrideAssetTypeDictionary (object)

Asset Type Settings

null or RaptorNielsenConfig (object)

Raptor Nielsen Config

string or null

Description of who made the last modify

number or null

Allow future events to start if within this window

number or null

Allow to skip events beyond of this window

RaptorGSelectorSettings (object) or null

Raptor GSelector Settings

number or null
number or null
boolean or null
string or null

EmergencyPlaylistID

Array of strings or null

EtmFillTags

Array of strings or null

BlockFillTags

string or null

Market

string or null

StreamID

string or null

Stores a template, InBandMetadata for publishing IcyTitle, Disable InbandMetadata by setting OutputIcyTitleTemplate and OutputIcyTitleTemplate to Null or empty!

string or null

Stores a template, InBandMetadata for publishing IcyUrl, Disable InbandMetadata by setting OutputIcyTitleTemplate and OutputIcyTitleTemplate to Null or empty!

boolean or null
boolean or null
string or null

EASTestAssetID

Array of strings or null

Split Stations subscribed to this station

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "StationName": "string",
  • "ConstantName": "string",
  • "StationCallLetters": "string",
  • "StationDescription": "string",
  • "StationTimeZone": "string",
  • "StationStatus": [
    ],
  • "Cluster": {
    },
  • "Mixers": [
    ],
  • "PlayerDictionary": { },
  • "GPIODeviceDictionary": { },
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": {
    },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Paused": true,
  • "StationMode": [
    ],
  • "AvailableModes": [
    ],
  • "FillHistoryLength": 1200,
  • "Traffic": {
    },
  • "Billboards": [
    ],
  • "AutoFade": [
    ],
  • "FadeLength": 0,
  • "NormalizationTarget": 0,
  • "BedDuckingLevel": 0,
  • "ZettaSplitReceiver": [
    ],
  • "SplitMasterStationID": "string",
  • "OverrideSequencerSettings": { },
  • "OverrideAssetTypeSettings": { },
  • "NielsenConfig": { },
  • "LastModifyDescription": "string",
  • "SoftEtmEarlyWindow": 0,
  • "SoftEtmLateWindow": 0,
  • "GSelectorSettings": {
    },
  • "MaxStretchPercent": 0,
  • "MaxSqueezePercent": 0,
  • "ApplyStretchSqueezeWithinSoftETMWindow": true,
  • "EmergencyPlaylistID": "string",
  • "EtmFillTags": [
    ],
  • "BlockFillTags": [
    ],
  • "Market": "string",
  • "StreamID": "string",
  • "OutputIcyTitleTemplate": "string",
  • "OutputIcyURLTemplate": "string",
  • "LinearAdsEnabled": true,
  • "SpotAssetType": true,
  • "EASTestAssetID": "string",
  • "ConnectedSplitStations": [
    ]
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "StationName": "string",
  • "ConstantName": "string",
  • "StationCallLetters": "string",
  • "StationDescription": "string",
  • "StationTimeZone": "string",
  • "StationStatus": [
    ],
  • "Cluster": {
    },
  • "Mixers": [
    ],
  • "PlayerDictionary": { },
  • "GPIODeviceDictionary": { },
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": {
    },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Paused": true,
  • "StationMode": [
    ],
  • "AvailableModes": [
    ],
  • "FillHistoryLength": 1200,
  • "Traffic": {
    },
  • "Billboards": [
    ],
  • "AutoFade": [
    ],
  • "FadeLength": 0,
  • "NormalizationTarget": 0,
  • "BedDuckingLevel": 0,
  • "ZettaSplitReceiver": [
    ],
  • "SplitMasterStationID": "string",
  • "OverrideSequencerSettings": { },
  • "OverrideAssetTypeSettings": { },
  • "NielsenConfig": { },
  • "LastModifyDescription": "string",
  • "SoftEtmEarlyWindow": 0,
  • "SoftEtmLateWindow": 0,
  • "GSelectorSettings": {
    },
  • "MaxStretchPercent": 0,
  • "MaxSqueezePercent": 0,
  • "ApplyStretchSqueezeWithinSoftETMWindow": true,
  • "EmergencyPlaylistID": "string",
  • "EtmFillTags": [
    ],
  • "BlockFillTags": [
    ],
  • "Market": "string",
  • "StreamID": "string",
  • "OutputIcyTitleTemplate": "string",
  • "OutputIcyURLTemplate": "string",
  • "LinearAdsEnabled": true,
  • "SpotAssetType": true,
  • "EASTestAssetID": "string",
  • "ConnectedSplitStations": [
    ]
}

delete the station

Delete Station

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

station id

Responses

Response samples

Content type
application/json
{ }

update the station

Patch Station

Authorizations:
LambdaTokenAuthorizer
path Parameters
id
required
string

station id

Request Body schema: application/json

Will patch included fields on the station

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

StationName
string

Station name

ConstantName
string

Immutable human-readable identifier

StationCallLetters
string

Station Call Letters

StationDescription
string

Description for the station

string or null

station time zone in UTC with offset

EnumStationConfigStatus (integer) or null

station status

RaptorCluster (object) (Cluster)

Configure primary, secondary (optional) and current cluster

Array of RaptorPlayerMixerConfig (objects) or null

(OBSOLETE 2020-03-01) Configuration of multiple playback mixer (a collection input and output) devices being used by the raptor player

null or RaptorPlayerConfigDictionary (object)

A Dictionary of all players, being used by the Raptor Player, Dictionary Key is the Player Key

null or RaptorGPIODeviceDictionary (object)

A Configuration Dictionary of all gpio devices, being used by this station

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

external ids associated with a stations (Depreciated 2019-07-01)

RaptorStationThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a stations, Please Use Recommending Naming Convention {Application}_{CustomField}

object or null

tags associated with the station

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

boolean or null

is Station in Paused State?

EnumSequencerMode (integer) or null

Current station mode

Array of EnumSequencerMode (integers) or null

Modes Available in the GUI for this station

number or null
Default: 1200

Length of history fetched for fill

RaptorStationTrafficConfig (object) or null

Traffic config

Array of RaptorStationBillboardConfig (objects) or null

Billboard outputs

EnumSequencerAutoFade (integer) or null

Is auto fade at segue enabled for this station

number or null

Length of auto fade

number or null

Length of auto fade

number or null

Ducking Level for Beds

EnumZettaSplitReceiver (integer) or null

Should we start a tcp listener to receive split command from zetta

string or null

stationID of the split master

RaptorOverrideDictionary (object) or null

Override dictionary used to define Custom sequencer configuration that might be overwritten on a station

null or RaptorOverrideAssetTypeDictionary (object)

Asset Type Settings

null or RaptorNielsenConfig (object)

Raptor Nielsen Config

string or null

Description of who made the last modify

number or null

Allow future events to start if within this window

number or null

Allow to skip events beyond of this window

RaptorGSelectorSettings (object) or null

Raptor GSelector Settings

number or null
number or null
boolean or null
string or null

EmergencyPlaylistID

Array of strings or null

EtmFillTags

Array of strings or null

BlockFillTags

string or null

Market

string or null

StreamID

string or null

Stores a template, InBandMetadata for publishing IcyTitle, Disable InbandMetadata by setting OutputIcyTitleTemplate and OutputIcyTitleTemplate to Null or empty!

string or null

Stores a template, InBandMetadata for publishing IcyUrl, Disable InbandMetadata by setting OutputIcyTitleTemplate and OutputIcyTitleTemplate to Null or empty!

boolean or null
boolean or null
string or null

EASTestAssetID

Array of strings or null

Split Stations subscribed to this station

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "StationName": "string",
  • "ConstantName": "string",
  • "StationCallLetters": "string",
  • "StationDescription": "string",
  • "StationTimeZone": "string",
  • "StationStatus": [
    ],
  • "Cluster": {
    },
  • "Mixers": [
    ],
  • "PlayerDictionary": { },
  • "GPIODeviceDictionary": { },
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": {
    },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Paused": true,
  • "StationMode": [
    ],
  • "AvailableModes": [
    ],
  • "FillHistoryLength": 1200,
  • "Traffic": {
    },
  • "Billboards": [
    ],
  • "AutoFade": [
    ],
  • "FadeLength": 0,
  • "NormalizationTarget": 0,
  • "BedDuckingLevel": 0,
  • "ZettaSplitReceiver": [
    ],
  • "SplitMasterStationID": "string",
  • "OverrideSequencerSettings": { },
  • "OverrideAssetTypeSettings": { },
  • "NielsenConfig": { },
  • "LastModifyDescription": "string",
  • "SoftEtmEarlyWindow": 0,
  • "SoftEtmLateWindow": 0,
  • "GSelectorSettings": {
    },
  • "MaxStretchPercent": 0,
  • "MaxSqueezePercent": 0,
  • "ApplyStretchSqueezeWithinSoftETMWindow": true,
  • "EmergencyPlaylistID": "string",
  • "EtmFillTags": [
    ],
  • "BlockFillTags": [
    ],
  • "Market": "string",
  • "StreamID": "string",
  • "OutputIcyTitleTemplate": "string",
  • "OutputIcyURLTemplate": "string",
  • "LinearAdsEnabled": true,
  • "SpotAssetType": true,
  • "EASTestAssetID": "string",
  • "ConnectedSplitStations": [
    ]
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "StationName": "string",
  • "ConstantName": "string",
  • "StationCallLetters": "string",
  • "StationDescription": "string",
  • "StationTimeZone": "string",
  • "StationStatus": [
    ],
  • "Cluster": {
    },
  • "Mixers": [
    ],
  • "PlayerDictionary": { },
  • "GPIODeviceDictionary": { },
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": {
    },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Paused": true,
  • "StationMode": [
    ],
  • "AvailableModes": [
    ],
  • "FillHistoryLength": 1200,
  • "Traffic": {
    },
  • "Billboards": [
    ],
  • "AutoFade": [
    ],
  • "FadeLength": 0,
  • "NormalizationTarget": 0,
  • "BedDuckingLevel": 0,
  • "ZettaSplitReceiver": [
    ],
  • "SplitMasterStationID": "string",
  • "OverrideSequencerSettings": { },
  • "OverrideAssetTypeSettings": { },
  • "NielsenConfig": { },
  • "LastModifyDescription": "string",
  • "SoftEtmEarlyWindow": 0,
  • "SoftEtmLateWindow": 0,
  • "GSelectorSettings": {
    },
  • "MaxStretchPercent": 0,
  • "MaxSqueezePercent": 0,
  • "ApplyStretchSqueezeWithinSoftETMWindow": true,
  • "EmergencyPlaylistID": "string",
  • "EtmFillTags": [
    ],
  • "BlockFillTags": [
    ],
  • "Market": "string",
  • "StreamID": "string",
  • "OutputIcyTitleTemplate": "string",
  • "OutputIcyURLTemplate": "string",
  • "LinearAdsEnabled": true,
  • "SpotAssetType": true,
  • "EASTestAssetID": "string",
  • "ConnectedSplitStations": [
    ]
}

Get the edge environment info

Tear down split receiver

Authorizations:
LambdaTokenAuthorizer
path Parameters
serialnumber
required
string

serial number of hardware device generate a device startup script

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Stop deployment of a split receiver

Tear down split receiver

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

station id

query Parameters
dryRun
boolean
Default: true

allow launch to run through validation check and call the deployment job with dry run only

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Stop deployment of a station, go OFF-AIR

Tear down Station

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationId
required
string

station id

query Parameters
dryRun
boolean
Default: true

allow launch to run through validation check and call the jenkins job with dry run only

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Create new station, Requires: StationName, StationTimeZone, OrganizationID, StationStatus

Create Station

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create new station, Requires: StationName, StationTimeZone, OrganizationID, StationStatus

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

unique id

StationName
string

Station name

ConstantName
string

Immutable human-readable identifier

StationCallLetters
string

Station Call Letters

StationDescription
string

Description for the station

string or null

station time zone in UTC with offset

EnumStationConfigStatus (integer) or null

station status

RaptorCluster (object) (Cluster)

Configure primary, secondary (optional) and current cluster

Array of RaptorPlayerMixerConfig (objects) or null

(OBSOLETE 2020-03-01) Configuration of multiple playback mixer (a collection input and output) devices being used by the raptor player

null or RaptorPlayerConfigDictionary (object)

A Dictionary of all players, being used by the Raptor Player, Dictionary Key is the Player Key

null or RaptorGPIODeviceDictionary (object)

A Configuration Dictionary of all gpio devices, being used by this station

Array of RaptorTypeValuePair (Depreciated 2019-07-01) (objects) or null

external ids associated with a stations (Depreciated 2019-07-01)

RaptorStationThirdPartyReferences (object) or null

Stores Third Party Ids, used for referencing third party systems, associated with a stations, Please Use Recommending Naming Convention {Application}_{CustomField}

object or null

tags associated with the station

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

boolean or null

is Station in Paused State?

EnumSequencerMode (integer) or null

Current station mode

Array of EnumSequencerMode (integers) or null

Modes Available in the GUI for this station

number or null
Default: 1200

Length of history fetched for fill

RaptorStationTrafficConfig (object) or null

Traffic config

Array of RaptorStationBillboardConfig (objects) or null

Billboard outputs

EnumSequencerAutoFade (integer) or null

Is auto fade at segue enabled for this station

number or null

Length of auto fade

number or null

Length of auto fade

number or null

Ducking Level for Beds

EnumZettaSplitReceiver (integer) or null

Should we start a tcp listener to receive split command from zetta

string or null

stationID of the split master

RaptorOverrideDictionary (object) or null

Override dictionary used to define Custom sequencer configuration that might be overwritten on a station

null or RaptorOverrideAssetTypeDictionary (object)

Asset Type Settings

null or RaptorNielsenConfig (object)

Raptor Nielsen Config

string or null

Description of who made the last modify

number or null

Allow future events to start if within this window

number or null

Allow to skip events beyond of this window

RaptorGSelectorSettings (object) or null

Raptor GSelector Settings

number or null
number or null
boolean or null
string or null

EmergencyPlaylistID

Array of strings or null

EtmFillTags

Array of strings or null

BlockFillTags

string or null

Market

string or null

StreamID

string or null

Stores a template, InBandMetadata for publishing IcyTitle, Disable InbandMetadata by setting OutputIcyTitleTemplate and OutputIcyTitleTemplate to Null or empty!

string or null

Stores a template, InBandMetadata for publishing IcyUrl, Disable InbandMetadata by setting OutputIcyTitleTemplate and OutputIcyTitleTemplate to Null or empty!

boolean or null
boolean or null
string or null

EASTestAssetID

Array of strings or null

Split Stations subscribed to this station

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "StationName": "string",
  • "ConstantName": "string",
  • "StationCallLetters": "string",
  • "StationDescription": "string",
  • "StationTimeZone": "string",
  • "StationStatus": [
    ],
  • "Cluster": {
    },
  • "Mixers": [
    ],
  • "PlayerDictionary": { },
  • "GPIODeviceDictionary": { },
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": {
    },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Paused": true,
  • "StationMode": [
    ],
  • "AvailableModes": [
    ],
  • "FillHistoryLength": 1200,
  • "Traffic": {
    },
  • "Billboards": [
    ],
  • "AutoFade": [
    ],
  • "FadeLength": 0,
  • "NormalizationTarget": 0,
  • "BedDuckingLevel": 0,
  • "ZettaSplitReceiver": [
    ],
  • "SplitMasterStationID": "string",
  • "OverrideSequencerSettings": { },
  • "OverrideAssetTypeSettings": { },
  • "NielsenConfig": { },
  • "LastModifyDescription": "string",
  • "SoftEtmEarlyWindow": 0,
  • "SoftEtmLateWindow": 0,
  • "GSelectorSettings": {
    },
  • "MaxStretchPercent": 0,
  • "MaxSqueezePercent": 0,
  • "ApplyStretchSqueezeWithinSoftETMWindow": true,
  • "EmergencyPlaylistID": "string",
  • "EtmFillTags": [
    ],
  • "BlockFillTags": [
    ],
  • "Market": "string",
  • "StreamID": "string",
  • "OutputIcyTitleTemplate": "string",
  • "OutputIcyURLTemplate": "string",
  • "LinearAdsEnabled": true,
  • "SpotAssetType": true,
  • "EASTestAssetID": "string",
  • "ConnectedSplitStations": [
    ]
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "StationID": "string",
  • "StationName": "string",
  • "ConstantName": "string",
  • "StationCallLetters": "string",
  • "StationDescription": "string",
  • "StationTimeZone": "string",
  • "StationStatus": [
    ],
  • "Cluster": {
    },
  • "Mixers": [
    ],
  • "PlayerDictionary": { },
  • "GPIODeviceDictionary": { },
  • "ExternalIDs": [
    ],
  • "ThirdPartyIDs": {
    },
  • "Tags": {
    },
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "Paused": true,
  • "StationMode": [
    ],
  • "AvailableModes": [
    ],
  • "FillHistoryLength": 1200,
  • "Traffic": {
    },
  • "Billboards": [
    ],
  • "AutoFade": [
    ],
  • "FadeLength": 0,
  • "NormalizationTarget": 0,
  • "BedDuckingLevel": 0,
  • "ZettaSplitReceiver": [
    ],
  • "SplitMasterStationID": "string",
  • "OverrideSequencerSettings": { },
  • "OverrideAssetTypeSettings": { },
  • "NielsenConfig": { },
  • "LastModifyDescription": "string",
  • "SoftEtmEarlyWindow": 0,
  • "SoftEtmLateWindow": 0,
  • "GSelectorSettings": {
    },
  • "MaxStretchPercent": 0,
  • "MaxSqueezePercent": 0,
  • "ApplyStretchSqueezeWithinSoftETMWindow": true,
  • "EmergencyPlaylistID": "string",
  • "EtmFillTags": [
    ],
  • "BlockFillTags": [
    ],
  • "Market": "string",
  • "StreamID": "string",
  • "OutputIcyTitleTemplate": "string",
  • "OutputIcyURLTemplate": "string",
  • "LinearAdsEnabled": true,
  • "SpotAssetType": true,
  • "EASTestAssetID": "string",
  • "ConnectedSplitStations": [
    ]
}

StationAsset

Patches or create an array of station assets

AddOrUpdateStationAsset

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Array of station assets

Array
OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

AssetID

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

StationID

boolean or null

primary title of asset

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

start datetime (ISO8601)

string or null

end datetime (ISO8601)

string or null

asset type

EnumSplitBehavior (integer)
Default: 0

Split behavior of the asset

string or null

Title used for export (in band metadata, now playing export)

string or null

Artist used for export (in band metadata, now playing export)

HourRestriction (object) or null

HourRestriction

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

get assets by active/inactive assets for an assettypeid

GetStationAssetByAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string
assetTypeID
required
string
query Parameters
active
boolean
Default: true

filter by active or not

pageNum
integer <int32>
Default: 1

page number to start gathering data from

itemsPerPage
integer <int23>
Default: 20

number of items per page to query

totalPages
integer <int32>
Default: 1

total number of pages to query

sortField
string
Default: "Title"

Field use to order the page

sortOrder
string
Default: "asc"

sort asc or desc

Responses

Response samples

Content type
application/json
null

Query the asset table with a graphQL query, supported types are assets and assetcount multiline testing { test } another

Graphql

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string
query Parameters
active
boolean
Default: true

filter by active or not

AssetTypeID
string

AssetTypeID to filter on, this can be in the body but this will be more efficient

Responses

Response samples

Content type
application/json
null

Activate a list of assetIDs on all passed in stationIDs, creates record if it doesn't exist

Activate

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationIDs
required
string
assetIDs
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new StationAsset

CreateStationAsset

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create new StationAsset

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

AssetID

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

StationID

boolean or null

primary title of asset

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

start datetime (ISO8601)

string or null

end datetime (ISO8601)

string or null

asset type

EnumSplitBehavior (integer)
Default: 0

Split behavior of the asset

string or null

Title used for export (in band metadata, now playing export)

string or null

Artist used for export (in band metadata, now playing export)

HourRestriction (object) or null

HourRestriction

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Get a collection of station assets by ID (separated by commas)

GetStationAssetList

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

assetIDs
required
string

assetIDs (separated by commas)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bulk Delete event by id (separated by commas)

DeleteStationAssetList

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

assetIDs
required
string

List of event IDs (separated by commas)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a StationAsset

GetStationAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationsID

assetID
required
string

assetID

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Updates or creates a station asset entry

PutStationAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

assetID
required
string

assetID

Request Body schema: application/json

StationAsset data to update or create

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

AssetID

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

StationID

boolean or null

primary title of asset

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

start datetime (ISO8601)

string or null

end datetime (ISO8601)

string or null

asset type

EnumSplitBehavior (integer)
Default: 0

Split behavior of the asset

string or null

Title used for export (in band metadata, now playing export)

string or null

Artist used for export (in band metadata, now playing export)

HourRestriction (object) or null

HourRestriction

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Delete event by id

DeleteStationAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

assetID
required
string

assetID

Responses

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Patch an existing playlist event, Requires: EventID

PatchStationAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

assetID
required
string

assetID

Request Body schema: application/json

Patches an existing StationAsset, only included fields will be updated.

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

AssetID

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

StationID

boolean or null

primary title of asset

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

start datetime (ISO8601)

string or null

end datetime (ISO8601)

string or null

asset type

EnumSplitBehavior (integer)
Default: 0

Split behavior of the asset

string or null

Title used for export (in band metadata, now playing export)

string or null

Artist used for export (in band metadata, now playing export)

HourRestriction (object) or null

HourRestriction

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Get a collection of assets with the station id, station id is passed in the path, asset ids are a list in the body

GetAssetStationAssetList

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

header Parameters
z-cloud-org-id
required
string

organization id

Request Body schema: application/json

List of asset ids to return

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
null

Get a collection of assets with the station id, station id is passed in the path, asset ids are a list in the body

SearchAssetCount

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

Request Body schema: application/json

List of asset ids to return

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
null

Deactivate a list of assetIDs on all passed in stationIDs, creates record if it doesn't exist

Deactivate

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationIDs
required
string

stationIDs (separated by commas)

assetIDs
required
string

assetIDs (separated by commas)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PatchStations

Bulk update StationAsset on many stations, Requires: assetID

Authorizations:
LambdaTokenAuthorizer
path Parameters
assetID
required
string

assetID

Request Body schema: application/json

Patches an existing StationAsset, only included fields will be updated.

OrganizationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

organization id

AssetID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

AssetID

StationID
string <guid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

StationID

boolean or null

primary title of asset

string or null

Created datetime (ISO8601)

string or null

Last modified datetime (ISO8601)

string or null

start datetime (ISO8601)

string or null

end datetime (ISO8601)

string or null

asset type

EnumSplitBehavior (integer)
Default: 0

Split behavior of the asset

string or null

Title used for export (in band metadata, now playing export)

string or null

Artist used for export (in band metadata, now playing export)

HourRestriction (object) or null

HourRestriction

Responses

Request samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Response samples

Content type
application/json
{
  • "OrganizationID": "string",
  • "AssetID": "string",
  • "StationID": "string",
  • "Active": true,
  • "CreatedDateTime": "2019-08-24T14:15:22Z",
  • "ModifiedDateTime": "2019-08-24T14:15:22Z",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "AssetTypeID": "string",
  • "SplitBehavior": 0,
  • "DisplayTitle": "string",
  • "DisplayArtist": "string",
  • "HourRestriction": {
    }
}

Get a collection of station assets by ID (separated by commas), returns a list of all stations

GetStationAssetListAllStations

Authorizations:
LambdaTokenAuthorizer
path Parameters
assetIDs
required
string

assetIDs (separated by commas)

query Parameters
active
boolean
Default: true

filter by active or not

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get the count of active/inactive assets for an assettypeid

GetStationAssetCountByAssetType

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

assetTypeID
required
string

assetTypeID

query Parameters
active
boolean
Default: true

filter by active or not

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

get assets by active assets for a filter asset json passed into the body

SearchAsset

Authorizations:
LambdaTokenAuthorizer
path Parameters
stationID
required
string

stationID

query Parameters
pageNum
integer <int32>
Default: 1

page number to start gathering data from

itemsPerPage
integer <int23>
Default: 20

number of items per page to query

totalPages
integer <int32>
Default: 1

total number of pages to query

sortField
string
Default: "Title"

Field use to order the page

sortOrder
string
Default: "asc"

sort asc or desc

Request Body schema: application/json

Asset search schema to search for assets by

RaptorAsset (object) or null

All passed in fields will be included when searching for mathcing assets

RaptorAsset (object) or null

All fields will be ored together when filtering for assets

Responses

Request samples

Content type
application/json
{
  • "matchAll": {
    },
  • "matchAny": {
    }
}

Response samples

Content type
application/json
null

User

Gets users for an organization

List Organization Users

Authorizations:
LambdaTokenAuthorizer
path Parameters
organizationId
required
string

Organization scope for the list of users received

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "enabled": true,
  • "organizationId": "string",
  • "internalIdentityProviderId": "string"
}

Creates a new user

CreateUser

Authorizations:
LambdaTokenAuthorizer
Request Body schema: application/json

Create new user. Requires: login

login
required
string <email>

login (email)

firstName
required
string

user's first name

lastName
required
string

user's last name

email
required
string <email>

user's email (usually same as login)

organizationId
required
string

organization to which the user belongs

enabled
required
boolean

user is enabled

roles
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "login": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "user@example.com",
  • "organizationId": "string",
  • "enabled": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "organizationId": "string",
  • "enabled": true,
  • "internalIdentityProviderId": "string",
  • "roles": [
    ]
}

Gets orgnaization ID based on user name and password (not used currently) provided.

Authenticate

Request Body schema: application/json

Credentials

userName
string

user name

password
string

password

Responses

Request samples

Content type
application/json
{
  • "userName": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Gets user based on user login.

GetUser

Authorizations:
LambdaTokenAuthorizer
path Parameters
login
required
string

user login

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "organizationId": "string",
  • "enabled": true,
  • "internalIdentityProviderId": "string",
  • "roles": [
    ]
}

Updates user

UpdateUser

Authorizations:
LambdaTokenAuthorizer
path Parameters
login
required
string

User login to be updated

Request Body schema: application/json

User to be updated

firstName
required
string

user's first name

lastName
required
string

user's last name

email
required
string <email>

user's email (usually same as login)

organizationId
required
string

organization to which the user belongs

enabled
required
boolean

user is enabled

roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "user@example.com",
  • "organizationId": "string",
  • "enabled": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "organizationId": "string",
  • "enabled": true,
  • "internalIdentityProviderId": "string",
  • "roles": [
    ]
}

Deletes user

DeleteUser

Authorizations:
LambdaTokenAuthorizer
path Parameters
login
required
string

Login from the user to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get current user based on access token

GetCurrentUser

Authorizations:
LambdaTokenAuthorizer

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "login": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "user@example.com",
  • "organizationIds": [
    ],
  • "providerIds": [
    ],
  • "currentOrganizationId": "string",
  • "organization": {
    },
  • "resources": [
    ]
}

Gets layouts for user id

GetUserLayouts

Authorizations:
LambdaTokenAuthorizer
path Parameters
userId
required
string

Security API user id

Responses

Response samples

Content type
application/json
{
  • "layouts": "string"
}

Sets layouts for user id

SetUserLayout

Authorizations:
LambdaTokenAuthorizer
path Parameters
userId
required
string

Security API user id

Request Body schema: application/json

Set new user's layout

layouts
required
string

user's profile layout in jwt token format string

Responses

Request samples

Content type
application/json
{
  • "layouts": "string"
}

Response samples

Content type
application/json
{
  • "layouts": "string"
}

Gets profile's locale for user id

GetUserLocale

Authorizations:
LambdaTokenAuthorizer
path Parameters
userId
required
string

Security API user id

Responses

Response samples

Content type
application/json
{
  • "locale": "string"
}

Sets locale for user id

SetUserLocale

Authorizations:
LambdaTokenAuthorizer
path Parameters
userId
required
string

Security api user id

Request Body schema: application/json

Set new user's locale

locale
required
string

user's profile locale value

Responses

Request samples

Content type
application/json
{
  • "locale": "string"
}

Response samples

Content type
application/json
{
  • "locale": "string"
}