The Three Layers


Asset Management Layer

This is where all the digital and physical assets are managed, including all of their technical metadata (such as timecodes, file sizes, video codecs, audio codecs, etc.) as well as their editorial metadata. From an asset perspective, it knows where the assets are based on locations (and so can resolve path information) – and also contains information about any video proxies available. In addition to this, it also has a fully configurable hierarchical schema – allowing for configurable hierarchies on a per client basis (bearing in mind the Cubix stack is entirely multi-tenanted). The concept is that a hierarchy can be created (e.g. an episodic hierarchy would be normally 3 tiers – Product / Series / Episode) – and then metadata fields can be configured off the different tiers.

With the schema created, Mezzanine Files are then tagged under the final tier of the schema. Daughter files are associated with the mezzanine file, and so as such follow with the mezzanine file as it is tagged. Ancillary Files (e.g. images, subtitles, PDF, office documents, etc.) can be associated at any tier of the hierarchy and as such are inheritable down the nodes. The mezzanine file then inherits the metadata as soon as it is tagged – making it possible to have asynchronous workflows between media and metadata.

The metadata schema is configurable based around the Tiers of the hierarchy – with fields definable at each layer. These metadata fields can be strings, date ranges, key value pairs (e.g. actor name and character name), tables, dropdowns and more. The fields can also be offered in multiple languages. The metadata then by default inherits down the hierarchy – so that when an asset is tagged under the final tier – it effectively “looks up” through the hierarchy to see all the metadata relevant to them. A key benefit to this system is that metadata is only entered once – something which provides dividends when working with products that have 100s of episodes. Metadata can also override – so at a lower level, if a value needs to be overridden for that specific node and any subsequent child nodes – it can be. The hierarchies in Cubix are defined on a client basis – as they relate to the media. The associated metadata is created on a company basis – which means different companies (and the users therein) working with the content can see different schemas or scopes of schema. This provides natural flexibility for limiting what companies can see what metadata.



Orchestration Layer

This layer is where action take place with the different devices that Cubix supports (e.g. transcoders, storage devices, file based QC engines, etc.). The “node” based approach is that for every device we are controlling – a “harness” runs connecting in to the core system (either direct to the DB or via web service) and polls for jobs to complete. By design this layer has no decision logic – it simply looks for jobs, executes them – reporting back the progress of the job, as well as any errors and metadata. These jobs relate normally to an asset or set of assets, but there is no direct visibility given to these jobs via the API.



Automation Layer

In Cubix, we finally then have the orchestration layer, the element of Cubix that works with the asset management layer and other sources to drives actions within the automation layer to occur. We have two elements to the Orchestration layer – the first is “Media Rules”, and the second is “Taskflow”. Media Rules – are based around short process chains (e.g. if this, do that) – and allow for the system to be configured with the “common sense” of the facility. So knowing automatically when to archive a file, create a proxy, etc. This means that in any workflow design, these steps can be assumed rather than stated implicitly within the workflow. Taskflow – is our BPM system, in which tasks are spawned and then pass down fully configurable journeys. These journeys can then drive a wide range of activities, working with all of the automation layer, but also human stages such as QC and metadata capture, and then notifications, etc. Validation points can also be configured as part of the journey to check assets or metadata against configured rules. A task can contain as much payload data as required, and often makes reference to assets, the metadata schema and the automation jobs that it has requested. The task itself often contains payload data that are only used in a “pass-thru” sense (e.g. data that needs to be queried externally, but is not used as part of the taskflow itself). Via the API we provide access to the taskflow layer, but not the media rules layer.

Authentication Method


The API follows the same authentication methods as the Cubix portals, and so a set of valid authorised credentials are required to work with the API.

No calls can made to an action without proper authentication, you can use the username and password parameters for authentication.

Usage


The Cubix REST API supports JSON requests, and can return either JSON or XML responses

Questions


If you have any questions or need support involving the REST API, please contact support@ortana.tv for assistance.

About

GET - about
Gets information about the current version of Cubix API
GET http://< cubix-api-url>/api/1/about/
Example: http://< cubix-api-url>/1/about/

Sample: <ArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <KeyValueOfstringstring> <Key>Version</Key> <Value>v 1.0.10</Value> </KeyValueOfstringstring> <KeyValueOfstringstring> <Key>Company</Key> <Value>Ortana Media Group.</Value> </KeyValueOfstringstring> <KeyValueOfstringstring> <Key>Copyright</Key> <Value>© 2019 - Ortana Media Group.</Value> </KeyValueOfstringstring> </ArrayOfKeyValueOfstringstring>
Sample: { "Version": “v 1.0.10", "Company": “Ortana Media Group.", "Copyright": "© 2016 - Ortana Media Group" }

Dictionary of string [key] and string [value]

Ancillary File

GET Ancillary File by (id)
Actions used for accessing Ancillary File data within Cubix
GET http://< cubix-api-url>/1/AncillaryFile/id
id Integer The identifier of the file
Example: http://< cubix-api-url>/1/AncillaryFile/5

Sample: <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> http://localhost:36945/Ancillaries/golf-bay.png </string>
Sample: "\\\\10.10.1.1\\demo\\NL1\\golf-bay.png"
Name Description Type Information
Id integer Required
GET Ancillary File by - By (id) (width) (height) (format)
Formats the image (the id) by the width and height provided. The images is then converted to the format required.
GET http://< cubix-api-url>/api/AncillaryFile/{id}/{width}/{height}/{format}
id Integer The identifier of the image
width Integer The width of the image
height Integer The height of the image
format Integer The new format of the image
Example: http://< cubix-api-url>/1/AncillaryFile/355/10/10/jpg

Sample: <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> http://localhost:36945/Ancillaries/golf-bay.jpg </string>
Sample: "http://localhost:36945/Ancillaries/golf-bay.jpg"
Name Description Type Information
Id integer Required
width integer Required
height integer Required
format integer Required

Item

GET Item - by (id) - more accurate when returning responses in JSON formats
Gets an asset from Cubix and Returns a single object with all available data
GET http://< cubix-api-url>/api/1/Item/{id}
id Integer The KVID of the clip
Example: http://< cubix-api-url>/1/item/569

Sample: <Item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringanyType> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value /> </d2p1:KeyValueOfstringanyType> <d2p1:KeyValueOfstringanyType> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value /> </d2p1:KeyValueOfstringanyType> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Item>
Sample: { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": { "sample string 1": {}, "sample string 3": {} }, "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] }
Name Description Type Information
id integer None
Title string None
Duration string None
InPoint string None
OuPoint string None
SeriesID integer None
SeriesName integer None
SeriesName string None
EpisodeID integer None
EpisodeName string None
PaerntID integer None
ParentName string None
Siblings Collection of integer None
Children Collection of integer None
Thumbnail string None
Proxies Collection of string None
Metadata Dictionary of string [key] and Object [value] None
AssociatedFiles Collection of AssociatedFiles None
GET Item - by (id) - more accurate when returning responses in XML formats
Gets an asset from Cubix and Returns a single object with all available data
GET http://< cubix-api-url>/api/1/Item/{id}
id Integer The KVID of the clip
Example: 'http://< cubix-api-url>/1/item/569'

Sample: <Items xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata> <Metadata> <metadata_key>sample string 1</metadata_key> <metadata_value>sample string 2</metadata_value> </Metadata> <Metadata> <metadata_key>sample string 1</metadata_key> <metadata_value>sample string 2</metadata_value> </Metadata> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Items>
Sample: { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": [ { "metadata_key": "sample string 1", "metadata_value": "sample string 2" }, { "metadata_key": "sample string 1", "metadata_value": "sample string 2" } ], "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] }
Name Description Type Information
id integer None
Title string None
Duration string None
InPoint string None
OutPoint string None
SeriesId integer None
SeriesName string None
EpisodeId integer None
EpisodeName string None
ParentID integer None
ParentName string None
Siblings Collection of integer None
Children Collection of integer None
Thumbnail string None
Proxies Collection of string None
Metadata Dictionary of string [key] and Object [value] None
AssociatedFiles Collection of AssociatedFiles None

Items

GET Items - all
Used to retrieve Item collections from Cubix and get all available objects. Only core details are populated
GET http://< cubix-api-url>/api/1/Items/
No Parameters
Example: http://< cubix-api-url>/1/Items/9

Sample: <ArrayOfItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <Item> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Item> <Item> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Item> </ArrayOfItem>
Sample: [ { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": { "sample string 1": {}, "sample string 3": {} }, "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] }, { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": { "sample string 1": {}, "sample string 3": {} }, "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] } ]
Name Description Type Information
id integer None
Title string None
Duration string None
InPoint string None
OuPoint string None
SeriesID integer None
SeriesName string None
EpisodeID integer None
EpisodeName string None
ParentID integer None
ParentName string None
Siblings Collection of integer None
Children Collection of integer None
Thumbnail string None
Proxies Collection of string None
Metadata Dictionary of string [key] and Object [value] None
AssociatedFiles Collection of AssociatedFiles None
GET Items by (Title)
Gets an Item by its Title. Returns the required Item, or null, if not available
GET http://< cubix-api-url>/api/1/Items/{title}
title string The Title of the Item to retrieve
Example: http://< cubix-api-url>/1/Items/SAB_TV

Sample: <ArrayOfItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <Item> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Item> <Item> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Item> </ArrayOfItem>
Sample: [ { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": { "sample string 1": {}, "sample string 3": {} }, "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] }, { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": { "sample string 1": {}, "sample string 3": {} }, "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] } ]
Name Description Type Information
id integer None
Title string None
Duration string None
InPoint string None
OutPoint string None
SeriesId integer None
SeriesName string None
EpisodeId integer None
EpisodeName string None
ParentID integer None
ParentName string None
Siblings Collection of integer None
Children Collection of integer None
Thumbnail string None
Proxies Collection of string None
Metadata Dictionary of string [key] and Object [value] None
AssociatedFiles Collection of AssociatedFiles None
GET items by (level)
Gets all Item objects belonging to requested level. Returns a collection of Item objects pertaining to the specified level
GET http://< cubix-api-url>/api/1/Items/{level}
level String The level of the expected Items (episode, series or product)
Example: http://< cubix-api-url>/1/items/product

Sample: <ArrayOfItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <Item> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Item> <Item> <AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> <AssociatedFiles> <FileExtension>sample string 5</FileExtension> <Filename>sample string 2</Filename> <Id>1</Id> <Language>sample string 4</Language> <Type>sample string 3</Type> <UNCPath>sample string 6</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Children> <Duration>sample string 3</Duration> <EpisodeId>1</EpisodeId> <EpisodeName>sample string 7</EpisodeName> <Id>1</Id> <InPoint>sample string 4</InPoint> <Metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Metadata> <OutPoint>sample string 5</OutPoint> <ParentID>1</ParentID> <ParentName>sample string 8</ParentName> <Proxies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Proxies> <SeriesId>1</SeriesId> <SeriesName>sample string 6</SeriesName> <Siblings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Siblings> <Thumbnail>sample string 9</Thumbnail> <Title>sample string 2</Title> </Item> </ArrayOfItem>
Sample: [ { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": { "sample string 1": {}, "sample string 3": {} }, "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] }, { "Id": 1, "Title": "sample string 2", "Duration": "sample string 3", "InPoint": "sample string 4", "OutPoint": "sample string 5", "SeriesId": 1, "SeriesName": "sample string 6", "EpisodeId": 1, "EpisodeName": "sample string 7", "ParentID": 1, "ParentName": "sample string 8", "Siblings": [ 1, 2 ], "Children": [ 1, 2 ], "Thumbnail": "sample string 9", "Proxies": [ "sample string 1", "sample string 2" ], "Metadata": { "sample string 1": {}, "sample string 3": {} }, "AssociatedFiles": [ { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" }, { "Id": 1, "Filename": "sample string 2", "Type": "sample string 3", "Language": "sample string 4", "FileExtension": "sample string 5", "UNCPath": "sample string 6" } ] } ]
Name Description Type Information
id integer None
Title string None
Duration string None
InPoint string None
OutPoint string None
SeriesId integer None
SeriesName string None
EpisodeId integer None
EpisodeName string None
ParentID integer None
ParentName string None
Siblings Collection of integer None
Children Collection of integer None
Thumbnail string None
Proxies Collection of string None
Metadata Dictionary of string [key] and Object [value] None
AssociatedFiles Collection of AssociatedFiles None
POST Items
Allows you to search on as many task data items as you wish to return a list of items. Multiple body values are accepted. Returns a collection of items objects
POST http://< cubix-api-url>/api/1/Items/search
metadataField Collection of strings expected to put field names in array format["ChannelName"]
metdataOperator Collection of strings expected to put field names in array format["="]
metadataValue Collection of strings expected to put field names in array format ["Endemol"]
output_MetadataField Collection of strings expected to put field names in array format ["James"]
Example: Request URL:http://< cubix-api-url>/1/Items/search Body Parameters: {"MetadataField":["ChannelName"] , "MetdataOperator":["="] ,"MetadataValue":["Endemol"],"Output_MetadataField":["Test"] }

Sample: <Search xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataField> <MetadataValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataValue> <MetdataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetdataOperator> <Output_MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_MetadataField> <Output_TaskData_Name xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_TaskData_Name> <TaskDataName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataName> <TaskDataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataOperator> <Taskdata_Value xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Taskdata_Value> </Search>
Sample: { "TaskDataName": [ "sample string 1", "sample string 2" ], "TaskDataOperator": [ "sample string 1", "sample string 2" ], "Taskdata_Value": [ "sample string 1", "sample string 2" ], "Output_TaskData_Name": [ "sample string 1", "sample string 2" ], "MetadataField": [ "sample string 1", "sample string 2" ], "MetdataOperator": [ "sample string 1", "sample string 2" ], "MetadataValue": [ "sample string 1", "sample string 2" ], "Output_MetadataField": [ "sample string 1", "sample string 2" ] }
...
Name Description Type Information

Metadata

GET Metadata - by (key) (value) (level) (fullitems)
Gets all KVIDs for Item objects with the matching parameters or full item description if fullItems is set to true. Returns a List of KVIDs if fullItems parameter is set to false or list of items if fullItems parameter is set to true
GET http://< cubix-api-url>/api/1/metadata/{key}/{value}/{level}/{fullItems}
key String The key of the metadata item required
value String The value stored in the named metadata item is required
level Integer The level (Product = 1, Series = 2 or Episode = 3) that the item is attached to is required
fullitems Boolean Boolean value true = all values associated with items, false = only IDs
Example: http://< cubix-api-url>/1/metadata/Channel Name/Endemol/3/true

Sample: ...
Sample: [ { "Id": 569, "Title": "BB8", "Duration": "00:00:02:16", "InPoint": "00:00:00:00", "OutPoint": "00:00:02:16", "SeriesId": null, "SeriesName": null, "EpisodeId": 569, "EpisodeName": "BB8", "ParentID": 528, "ParentName": null, "Siblings": [], "Children": null, "Thumbnail": "4047.png", "Proxies": [ "http://cubix.loftlondon.co.uk/proxies/D5845C3E-B36C-4FFC-8FDE-9E8B360D7716.MP4" ], "Metadata": { "Channel Name": "Endemol" }, "AssociatedFiles": [ { "Id": 468, "Filename": "MXF_with_Duration_v2.MXF", "Type": "Master (original)", "Language": "", "FileExtension": "MXF", "UNCPath": "\\\\10.10.14.20\\inside_media_demo_media\\NL1\\VIA-27.MXF" } ] } ]
Name Description Type Information
id integer None
Title string None
Duration string None
InPoint string None
OuPoint string None
SeriesID integer None
SeriesName string None
EpisodeID integer None
EpisodeName string None
ParentID integer None
ParentName string None
Siblings Collection of integer None
Children Collection of integer None
Thumbnail string None
Proxies Collection of string None
Metadata Dictionary of string [key] and Object [value] None
AssociatedFiles Collection of AssociatedFiles None
GET Metadata - by (Key)
Gets the options available to a metadata item. Used for items where a dropdown list may occur. All options available to a metadata item
GET http://< cubix-api-url>/api/1/metadata/{key}
key String The key of the metadata item required
Example: http://< cubix-api-url>/1/metadata/ChannelName

Sample: ...
Sample: [ " DEMO1", " DEMO2", " DEMO3" ]
Name Description Type Information
GET Metadata- by (Key) (Level)
Get all values for metadata key at a specific level (Product = 1, Series = 2, Episode = 3). Return Collection of key/value pairs where the key is item id and value is the associated value
GET http://< cubix-api-url>/api/1/Metadata/{key}/{level}
key String The key of the metadata item
level Integer The level (Product = 1, Series = 2 or Episode = 3) that the item is attached to
Example: http://< cubix-api-url>/1/metadata/ChannelName/3

Sample: ...
Sample: { "1220": "Discovery", "1263": "Discovery", "1306": "Discovery", "1349": "Discovery" }
...
Metadata by (Key) (Value)
Get all options that depend on a metadata key and its possible value. A typical use case could be where a metadata key depends on the value stored in another metadata item. Return a collection of values that relate to the key and it's corresponding value
GET http://< cubix-api-url>/api/1/Metadata/{key}/{value}
key String The key of the metadata item
value string The value stored in the key.
Example: http://< cubix-api-url>/1/ChannelName/Endemol

Sample: ...
Sample: { "1220": "Discovery", "1263": "Discovery", "1306": "Discovery", "1349": "Discovery" }
...

Taskflow

GET Tasks - by (taskid)
Used to retrieve Taskflow collections from Cubix. Returns all task data associated, or null, if not available
GET http://< cubix-api-url>/api/1/Task/{TaskId}
task_id Integer The keyword used to search by
Example: http://< cubix-api-url>/1/Task/1

Sample: <ArrayOftaskflow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <taskflow> <AssignedTo>1</AssignedTo> <FullName>sample string 13</FullName> <LastUpdated>sample string 8</LastUpdated> <PortalID>4</PortalID> <RequiredDate>sample string 7</RequiredDate> <StartDate>sample string 6</StartDate> <SystemOnly>true</SystemOnly> <TST_Id>5</TST_Id> <TST_Name>sample string 9</TST_Name> <TaskDataID>14</TaskDataID> <TaskData_Index>11</TaskData_Index> <TaskData_Name>sample string 10</TaskData_Name> <TaskData_Value>sample string 12</TaskData_Value> <TaskID>2</TaskID> <TaskflowID>3</TaskflowID> </taskflow> <taskflow> <AssignedTo>1</AssignedTo> <FullName>sample string 13</FullName> <LastUpdated>sample string 8</LastUpdated> <PortalID>4</PortalID> <RequiredDate>sample string 7</RequiredDate> <StartDate>sample string 6</StartDate> <SystemOnly>true</SystemOnly> <TST_Id>5</TST_Id> <TST_Name>sample string 9</TST_Name> <TaskDataID>14</TaskDataID> <TaskData_Index>11</TaskData_Index> <TaskData_Name>sample string 10</TaskData_Name> <TaskData_Value>sample string 12</TaskData_Value> <TaskID>2</TaskID> <TaskflowID>3</TaskflowID> </taskflow> </ArrayOftaskflow>
Sample: [ { "Taskflow_name": "sample string 1", "TaskID": 2, "TaskflowID": 3, "PortalID": 4, "TST_Id": 5, "AssignedTo": 1, "StartDate": "sample string 6", "RequiredDate": "sample string 7", "LastUpdated": "sample string 8", "TST_Name": "sample string 9", "TaskData_Name": "sample string 10", "TaskData_Index": 11, "TaskData_Value": "sample string 12", "FullName": "sample string 13", "TaskDataID": 14, "SystemOnly": true }, { "Taskflow_name": "sample string 1", "TaskID": 2, "TaskflowID": 3, "PortalID": 4, "TST_Id": 5, "AssignedTo": 1, "StartDate": "sample string 6", "RequiredDate": "sample string 7", "LastUpdated": "sample string 8", "TST_Name": "sample string 9", "TaskData_Name": "sample string 10", "TaskData_Index": 11, "TaskData_Value": "sample string 12", "FullName": "sample string 13", "TaskDataID": 14, "SystemOnly": true } ]
Name Description Type Information
Taskflow_name string None
TaskID integer None
TaskflowID integer None
PortalID integer None
TST_Id integer None
AssignedTo integer None
StartDate string None
RequiredDate string None
LastUpdated string None
TST_Name string None
TaskData_Name string None
TaskData_Index integer None
TaskData_Value string None
FullName string None
TaskDataID integer None
SystemOnly boolean None
POST Task - more accurate when returning responses in JSON formats
Used to retrieve Taskflow collections from Cubix. Gets taskflow filter by using a generic filter Multiple values are accepted
POST http://< cubix-api-url>/api/1/Task/
TaskDataName String expected to put field names in array format["ChannelName"]
TaskDataOperator String expected to put operators in array format["="]
Taskdata_Value Integer expected to put values in array format ["Endemol"]
Output_TaskData_Name String expected to put output fields in array format ["James"]
Example: Request URL: http://< cubix-api-url>/1/Task/ Body Parameter : {"TaskDataName":["Metadata Capture & Publish","FLE_ID"] , "TaskDataOperator":["=","=","="] ,"Taskdata_Value":["Proxy_OGV_JOB_ID","100"] ,"Output_TaskData_Name":[] }

Sample: <Search xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataField> <MetadataValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataValue> <MetdataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetdataOperator> <Output_MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_MetadataField> <Output_TaskData_Name xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_TaskData_Name> <TaskDataName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataName> <TaskDataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataOperator> <Taskdata_Value xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Taskdata_Value> </Search>
Sample: [ { "TaskDataName": [ "sample string 1", "sample string 2" ], "TaskDataOperator": [ "sample string 1", "sample string 2" ], "Taskdata_Value": [ "sample string 1", "sample string 2" ], "Output_TaskData_Name": [ "sample string 1", "sample string 2" ], "MetadataField": [ "sample string 1", "sample string 2" ], "MetdataOperator": [ "sample string 1", "sample string 2" ], "MetadataValue": [ "sample string 1", "sample string 2" ], "Output_MetadataField": [ "sample string 1", "sample string 2" ] } ]
Name Description Type Information
TaskDataName Collection of string None
TaskDataOperator Collection of string None
Taskdata_Value Collection of string None
Output_TaskData_Name Collection of string None
MetadataField Collection of string None
MetdataOperator Collection of string None
MetadataValue Collection of string None
Output_MetadataField Collection of string None
POST Task/CreateTask by (TaskFlowID) (TaskTitle) (TaskNote) (StartDate) (RequiredDate) (FLE_ID)
Create a new Task
POST http://< cubix-api-url>/api/1/Task/CreateTask
TaskFlowID Integer
TaskTitle String
TaskNote String
StartDate String
RequiredDate String
FLE_ID Integer
Example: Request URL: http://< cubix-api-url>/1/Task/CreateTask Body Parameter : {"TaskFlowID":123 , "TaskTitle":"ABC" ,"TaskNote":"Test" ,"StartDate":"YYYY-MM-DD","RequiredDate":"YYYY-MM-DD" ,"FLE_ID":123}

Sample: <Search xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataField> <MetadataValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataValue> <MetdataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetdataOperator> <Output_MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_MetadataField> <Output_TaskData_Name xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_TaskData_Name> <TaskDataName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataName> <TaskDataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataOperator> <Taskdata_Value xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Taskdata_Value> </Search>
Sample: [ { "TaskDataName": [ "sample string 1", "sample string 2" ], "TaskDataOperator": [ "sample string 1", "sample string 2" ], "Taskdata_Value": [ "sample string 1", "sample string 2" ], "Output_TaskData_Name": [ "sample string 1", "sample string 2" ], "MetadataField": [ "sample string 1", "sample string 2" ], "MetdataOperator": [ "sample string 1", "sample string 2" ], "MetadataValue": [ "sample string 1", "sample string 2" ], "Output_MetadataField": [ "sample string 1", "sample string 2" ] } ]
Name Description Type Information
TaskDataName Collection of string None
TaskDataOperator Collection of string None
Taskdata_Value Collection of string None
Output_TaskData_Name Collection of string None
MetadataField Collection of string None
MetdataOperator Collection of string None
MetadataValue Collection of string None
Output_MetadataField Collection of string None
POST Task/DeleteTask - by (TaskID) (TaskData_Name) (TaskData_Index)
Remove Task Data
POST http://< cubix-api-url>/api/1/Task/DeleteTask
TaskID Integer
TaskData_Name string
TaskData_Index Integer
Example: Request URL: http://< cubix-api-url>/1/Task/DeleteTask Body Parameter : {"TaskID":123 , "TaskData_Name":"Name" ,"TaskData_Index":0}

Sample: <Search xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataField> <MetadataValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataValue> <MetdataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetdataOperator> <Output_MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_MetadataField> <Output_TaskData_Name xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_TaskData_Name> <TaskDataName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataName> <TaskDataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataOperator> <Taskdata_Value xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Taskdata_Value> </Search>
Sample: [ { "TaskDataName": [ "sample string 1", "sample string 2" ], "TaskDataOperator": [ "sample string 1", "sample string 2" ], "Taskdata_Value": [ "sample string 1", "sample string 2" ], "Output_TaskData_Name": [ "sample string 1", "sample string 2" ], "MetadataField": [ "sample string 1", "sample string 2" ], "MetdataOperator": [ "sample string 1", "sample string 2" ], "MetadataValue": [ "sample string 1", "sample string 2" ], "Output_MetadataField": [ "sample string 1", "sample string 2" ] }
Name Description Type Information
TaskDataName Collection of string None
TaskDataOperator Collection of string None
Taskdata_Value Collection of string None
Output_TaskData_Name Collection of string None
MetadataField Collection of string None
MetdataOperator Collection of string None
MetadataValue Collection of string None
Output_MetadataField Collection of string None
POST Task/AddEditTask by (TaskID) (TaskData_Name) (TaskData_Value) (mode) (TaskData_Index)
Used to Add or Edit Task Data
POST http://< cubix-api-url>/api/1/Task/AddEditTask
TaskID Integer
TaskData_Name string
TaskData_Value Integer
mode Integer
TaskData_Index Integer
Example: Request URL: http://< cubix-api-url>/1/Task/AddEditTask Mode = 1 (Add Data) Mode = 0 (Edit Data) We only use TaskData_Index value if we need to Edit TaskData. Example Bellow: Body Parameter for Add Data : {"TaskID":123, "TaskData_Name":"Name","TaskData_Value":123, "mode":1 } Body Parameter for Edit Data : {"TaskID":123, "TaskData_Name":"Name","TaskData_Value":123, "mode":0, "TaskData_Index":0 }

Sample: <Search xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataField> <MetadataValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataValue> <MetdataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetdataOperator> <Output_MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_MetadataField> <Output_TaskData_Name xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_TaskData_Name> <TaskDataName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataName> <TaskDataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataOperator> <Taskdata_Value xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Taskdata_Value> </Search>
Sample: [ { "TaskDataName": [ "sample string 1", "sample string 2" ], "TaskDataOperator": [ "sample string 1", "sample string 2" ], "Taskdata_Value": [ "sample string 1", "sample string 2" ], "Output_TaskData_Name": [ "sample string 1", "sample string 2" ], "MetadataField": [ "sample string 1", "sample string 2" ], "MetdataOperator": [ "sample string 1", "sample string 2" ], "MetadataValue": [ "sample string 1", "sample string 2" ], "Output_MetadataField": [ "sample string 1", "sample string 2" ] } ]
Name Description Type Information
TaskDataName Collection of string None
TaskDataOperator Collection of string None
Taskdata_Value Collection of string None
Output_TaskData_Name Collection of string None
MetadataField Collection of string None
MetdataOperator Collection of string None
MetadataValue Collection of string None
Output_MetadataField Collection of string None
POST Task/Search by (TaskDataName) (TaskDataOperator) (Taskdata_Value) (mode) (Output_TaskData_Name)
Used to Search Taskflow Data
POST http://< cubix-api-url>/api/1/Task/{TaskId}
TaskDataName String expected to put field names in array format["ChannelName"]
TaskDataOperator string expected to put operators in array format["="]
Taskdata_Value Integer expected to put values in array format ["Endemol"].
Output_TaskData_Name String expected to put output fields in array format ["James"]
Example: Request URL: http://< cubix-api-url>/1/Task/Search Example: Check for specific Task ID Body Parameter : {"TaskDataName":["TaskID"] , "TaskDataOperator":["="] ,"Taskdata_Value":["123"] ,"Output_TaskData_Name":[] } Example: Check for specific data in all tasks Body Parameter : {"TaskDataName":["Title"] , "TaskDataOperator":["like"] ,"Taskdata_Value":["Pokemon"] ,"Output_TaskData_Name":[] }

Sample: <Search xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataField> <MetadataValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetadataValue> <MetdataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </MetdataOperator> <Output_MetadataField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_MetadataField> <Output_TaskData_Name xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Output_TaskData_Name> <TaskDataName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataName> <TaskDataOperator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </TaskDataOperator> <Taskdata_Value xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Taskdata_Value> </Search>
Sample: { "TaskDataName": [ "sample string 1", "sample string 2" ], "TaskDataOperator": [ "sample string 1", "sample string 2" ], "Taskdata_Value": [ "sample string 1", "sample string 2" ], "Output_TaskData_Name": [ "sample string 1", "sample string 2" ], "MetadataField": [ "sample string 1", "sample string 2" ], "MetdataOperator": [ "sample string 1", "sample string 2" ], "MetadataValue": [ "sample string 1", "sample string 2" ], "Output_MetadataField": [ "sample string 1", "sample string 2" ] }
Name Description Type Information
TaskDataName Collection of string None
TaskDataOperator Collection of string None
Taskdata_Value Collection of string None
Output_TaskData_Name Collection of string None
MetadataField Collection of string None
MetdataOperator Collection of string None
MetadataValue Collection of string None
Output_MetadataField Collection of string None
POST Task/Nextstep
Used to retrieve Taskflow collections from Cubix. Gets taskflow filter by using a generic filter Multiple values are accepted
POST http://< cubix-api-url>/api/1/Task/Nextstep
TaskID String The unique identifier for the task
SuccessFail string values should be either "Success" or "Fail"
username String username
IPAddress String IPAddress
Notes String Notes
Dropdown_StepOrder Integer Dropdown_StepOrder
Dropdown_TST_ID Integer Dropdown_TST_ID
Example: Request URL: http://< cubix-api-url>/1/Task/Nextstep Body parameter: {"TaskID":1 , "SuccessFail":"success" ,"username":" test " ,"IPAddress":"1.1.1.1" ,"Notes":" test ","Dropdown_StepOrder":1,"Dropdown_TST_ID":1}

Sample: <NextStep xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <Dropdown_StepOrder>6</Dropdown_StepOrder> <Dropdown_TST_ID>7</Dropdown_TST_ID> <IPAddress>sample string 4</IPAddress> <Notes>sample string 5</Notes> <SuccessFail>sample string 2</SuccessFail> <TaskID>1</TaskID> <username>sample string 3</username> </NextStep>
Sample: { "TaskID": 1, "SuccessFail": "sample string 2", "username": "sample string 3", "IPAddress": "sample string 4", "Notes": "sample string 5", "Dropdown_StepOrder": 6, "Dropdown_TST_ID": 7 }

Get User

GET- by (ContactID)(Username)(EmailAddress)
Used to return the details for a specific user.
GET http://< cubix-api-url>/1/user?ContactID=&Username=demo1&EmailAddress=
ContactID Integer(optional)
Username String(optional)
EmailAddress String(optional)
Example: http://< cubix-api-url>/1/user?ContactID=&Username=demo1&EmailAddress=

Sample:
Sample: [ { "CompanyID": 11, "FullName": "John Major", "Title": "hkjkjkj", "Mobile": "123654987", "EmailAddress": "John@test.co.uk", "Country": "", "Username": "demo1", "userGroups": [ { "GroupID": 1, "GroupName": "Tech Portal" } ], "Groups": null, "Enabled": true } ]
Name Description Type Information
CompanyID Int
Full Name String
Job Title String
MobilePhoneNumber String
EmailAddress String
Country 2 letter ISO code
Username String
Groups String-array
LastUpdated string
Enabled bit

List Companies

GET- user/Companies
Used to provide a list of companies back that the user account who the API call is made under has access to
GET http://< cubix-api-url>/1/user/Companies No input would be required (as the username is already part of the authentication)
No input would be required (as the username is already part of the authentication).
Example: http://< cubix-api-url>/1/user/Companies

Sample:
Sample: [ { "CompanyID": 11, "CompanyName": "Ortana", "TermsAndConditionsEnabled": true }, { "CompanyID": 20, "CompanyName": "Joe Company", "TermsAndConditionsEnabled": null }, { "CompanyID": 24, "CompanyName": "Mandeeps Company", "TermsAndConditionsEnabled": null }, { "CompanyID": 1047, "CompanyName": "All Global Viewing", "TermsAndConditionsEnabled": null } ]
· CompanyID · CompanyName · Terms&Conditions

List Groups

GET- user/Groups
Used to return the list of PortalGroups available, so that this information can be used in a different call when creating users.
GET http://< cubix-api-url>/1/user/Groups
No input would be required
Example: http://< cubix-api-url>/1/user/Groups

Sample:
Sample: [ { "CompanyID": 11, "CompanyName": "Ortana", "TermsAndConditionsEnabled": true }, { "CompanyID": 20, "CompanyName": "Joe Company", "TermsAndConditionsEnabled": null }, { "CompanyID": 24, "CompanyName": "Mandeeps Company", "TermsAndConditionsEnabled": null }, { "CompanyID": 1047, "CompanyName": "All Global Viewing", "TermsAndConditionsEnabled": null } ]
· CompanyID · CompanyName · Terms&Conditions

Search

Search - by (keyword) (fullitems) (pageNumber) (pagesize) (orderby) (meta)
Gets all unique identifiers or all full items for the keyword for the current user
GET http://< cubix-api-url>/api/1/Search/{keyword}/{fullItems}/{pageNumber}/{pageSize}/{orderBy}/{meta}
keyword String The keyword used to search by
fullItems Boolean true to return values associated with items, false returns IDs only
pageNumber Integer The number of the page to return
pageSize Integer The number of results on the page to return
orderBy String Item parameter by which items to be sorted in ascending order
meta String Metadata key to by sorted by
Example: http://< cubix-api-url>/1/Search/Endemol/true/1/50/title

Sample: <ArrayOfItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LLSWebAPI.Models"> <Item> <AssociatedFiles> <AssociatedFiles> <FileExtension>MXF</FileExtension> <Filename>MXF_with_Duration_v2.MXF</Filename> <Id>468</Id> <Language></Language> <Type>Master (original)</Type> <UNCPath>\\10.10.14.20\inside_media_demo_media\NL1\VIA-27.MXF</UNCPath> </AssociatedFiles> </AssociatedFiles> <Children xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <Duration>00:00:02:16</Duration> <EpisodeId>569</EpisodeId> <EpisodeName>BB8</EpisodeName> <Id>569</Id> <InPoint>00:00:00:00</InPoint> <Metadata xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>Channel Name</d3p1:Key> <d3p1:Value xmlns:d5p1="http://www.w3.org/2001/XMLSchema" i:type="d5p1:string">Endemol</d3p1:Value> </d3p1:KeyValueOfstringanyType> </Metadata> <OutPoint>00:00:02:16</OutPoint> <ParentID>528</ParentID> <ParentName i:nil="true" /> <Proxies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>http://cubix.loftlondon.co.uk/proxies/D5845C3E-B36C-4FFC-8FDE-9E8B360D7716.MP4</d3p1:string> </Proxies> <SeriesId i:nil="true" /> <SeriesName i:nil="true" /> <Siblings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <Thumbnail>4047.png</Thumbnail> <Title>BB8</Title> </Item> </ArrayOfItem>
Sample: [ [ { "Id": 569, "Title": "BB8", "Duration": "00:00:02:16", "InPoint": "00:00:00:00", "OutPoint": "00:00:02:16", "SeriesId": null, "SeriesName": null, "EpisodeId": 569, "EpisodeName": "BB8", "ParentID": 528, "ParentName": null, "Siblings": [], "Children": null, "Thumbnail": "4047.png", "Proxies": [ "http://cubix.loftlondon.co.uk/proxies/D5845C3E-B36C-4FFC-8FDE-9E8B360D7716.MP4" ], "Metadata": { "Channel Name": "Endemol" }, "AssociatedFiles": [ { "Id": 468, "Filename": "MXF_with_Duration_v2.MXF", "Type": "Master (original)", "Language": "", "FileExtension": "MXF", "UNCPath": "\\\\10.10.14.20\\inside_media_demo_media\\NL1\\VIA-27.MXF" } ] } ]
Name Description Type Information
id integer None
Title string None
Duration string None
InPoint string None
OuPoint string None
SeriesID integer None
SeriesName string None
EpisodeID integer None
EpisodeName string None
ParentID integer None
ParentName string None
Siblings Collection of integer None
Children Collection of integer None
Thumbnail string None
Proxies Collection of string None
Metadata Dictionary of string [key] and Object [value] None
AssociatedFiles Collection of AssociatedFiles None

List Saved Search

GET - by (SavedSearchType)
Used to return a list of saved searches that are available to the user
GET http://< cubix-api-url>/1/user/GetSavedSearch?SavedSearchType=task
SavedSearchType String (optional)
Example: http://< cubix-api-url>/1/user/GetSavedSearch?SavedSearchType=task

Sample:
Sample: [ { "SavedSearchID": 1, "SavedSearchName": "Metadata Capture & Publish - Active Requests", "SavedSearchType": "task" }, { "SavedSearchID": 5, "SavedSearchName": "Playout Fulfilment - Playbox - Active Requests", "SavedSearchType": "task" }, { "SavedSearchID": 8, "SavedSearchName": "YouTube Publish - Active Requests", "SavedSearchType": "task" }, { "SavedSearchID": 9, "SavedSearchName": "Review & Approve - Active Requests", "SavedSearchType": "task" }, { "SavedSearchID": 10, "SavedSearchName": "Portal - New User Requests", "SavedSearchType": "task" }, { "SavedSearchID": 12, "SavedSearchName": "Metadata Capture, EDL & Publish - Active Requests", "SavedSearchType": "task" }, { "SavedSearchID": 15, "SavedSearchName": "Active Requests", "SavedSearchType": "task" }, { "SavedSearchID": 17, "SavedSearchName": "Mandeep The GENIUS!", "SavedSearchType": "task" }, { "SavedSearchID": 28, "SavedSearchName": "Order Form", "SavedSearchType": "task" }, { "SavedSearchID": 29, "SavedSearchName": "Demo Live Streaming", "SavedSearchType": "task" }, { "SavedSearchID": 31, "SavedSearchName": "FILE_CATALYST", "SavedSearchType": "task" }, { "SavedSearchID": 33, "SavedSearchName": "EDL TEST", "SavedSearchType": "task" }, { "SavedSearchID": 39, "SavedSearchName": "Database Backup", "SavedSearchType": "task" }, { "SavedSearchID": 40, "SavedSearchName": "Compliance & Metadata Test", "SavedSearchType": "task" }, { "SavedSearchID": 41, "SavedSearchName": "Metadata Test", "SavedSearchType": "task" }, { "SavedSearchID": 42, "SavedSearchName": "Test on system list", "SavedSearchType": "task" }, { "SavedSearchID": 43, "SavedSearchName": "Test on default value and group", "SavedSearchType": "task" }, { "SavedSearchID": 51, "SavedSearchName": "HabibiMultiMailTest", "SavedSearchType": "Task" }, { "SavedSearchID": 52, "SavedSearchName": "HabibiEmailTest", "SavedSearchType": "Task" }, { "SavedSearchID": 53, "SavedSearchName": "Asset Finder", "SavedSearchType": "task" }, { "SavedSearchID": 54, "SavedSearchName": "EDL Test", "SavedSearchType": "Task" } ]
Name Description Type Information
SavedSearchID integer Required
SavedSearchName string Required
SavedSearchType string Required

Get Saved Search

GET - by (SavedSearchID)(Keyword string)
Used to execute a saved search and return the results
GET http://< cubix-api-url>/1/user/SavedSearchResult?SavedSearchID=&&Keyword&PageNumber=1&PageSize=20
SavedSearchID Int
Keyword String(optional)
Then for pagination:
PageNumber Int
PageSize Int
Example: http://< cubix-api-url>/1/user/SavedSearchResult?SavedSearchID=&&Keyword&PageNumber=1&PageSize=20

Sample:
Sample: [ { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "10/07/2018 16:30:08", "TaskID": "666", "TaskflowID": "9", "TSTName": "Exception", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "29/05/2018 16:49:40", "TaskID": "662", "TaskflowID": "9", "TSTName": "Exception", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "test", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "29/05/2018 16:43:04", "TaskID": "664", "TaskflowID": "9", "TSTName": "Exception", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "29/05/2018 11:43:31", "TaskID": "651", "TaskflowID": "9", "TSTName": "Exception", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "667", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "test", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "665", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "663", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "661", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "test", "RequiredDate": "03/09/2015 00:00:00", "FullName": "Ortana TV", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "660", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "test", "RequiredDate": "03/09/2015 00:00:00", "FullName": "Ortana TV", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "659", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "658", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "657", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "Ortana TV", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "656", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "Ortana TV", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "655", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "654", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "653", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "652", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "650", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "649", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "648", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "647", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "646", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "645", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "642", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "641", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "640", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "639", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "638", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "637", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "636", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "635", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:23", "TaskID": "634", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:22", "TaskID": "633", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "", "RequiredDate": "03/09/2015 00:00:00", "FullName": "John Major", "LastUpdated": "30/10/2015 14:56:22", "TaskID": "632", "TaskflowID": "9", "TSTName": "YouTube Delivery In Progress", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" }, { "TaskflowName": "YouTube Publish", "TaskDataValue": "JB400", "RequiredDate": "19/06/2015 00:00:00", "FullName": "John Major", "LastUpdated": "20/08/2015 16:23:54", "TaskID": "529", "TaskflowID": "9", "TSTName": "Exception", "col1": null, "col2": null, "col3": null, "col4": null, "col5": null, "col6": null, "col7": null, "col8": null, "col9": null, "col10": null, "Message": null, "Percentage": null, "ParentJobId": 0, "JOBId": 0, "Status": null, "JobType": null, "ErrorMessage": null, "RowBackground": "" } ]
· Columns as per saved search - will be dynamic based on the results

Asset Search

POST - Asset/search
This new call works independent of the tagging system, and is the equivalent of the Advanced Search page in the Technical Portal.
POST http://< cubix-api-url>/api/1/Asset/search
Clip Type String array(optional)
Keyword String(optional)
FileExtensions Integer array(optional)
Date Created DateTime Range (optional)
Date Imported DateTime Range (optional)
Last Updated DateTime Range (optional)
Width int Range (optional)
Height int Range (optional)
Framerate float Range (optional)
Duration float Range (optional)
Size bigint Range (optional)
Location Types string Range (optional)
Tagged bit(optional)
Transcripts bit(optional)
ImageDetection bit(optional)
We also need to support something standard for pagination - e.g:
PageNumber int
PageSize int
Example: Request URL: http://< cubix-api-url>/1/Asset/search Body Parameter : { "paging": {"pageNumber":1,"pageSize":20}, "clipTypes": ["bbc","cnn","fox"], "keyword": "theresa", "fileExtensions": ["mxf","mov","mp4"], "dateCreated": "2017-01-01 10:00:00|2018-01-01 10:00:00", "lastUpdated": "2017-01-01 10:00:00|2018-01-01 10:00:00", "dateImported": "2017-01-01 10:00:00|2018-01-01 10:00:00", "width": "1|10", "height": "1|10", "framerate": "1|10", "duration": "1|10", "size": "1|10", "locationTypes": ["disk","archive","proxy"], "tagged": false, "transcripts": false, "imageDetection": false }

Sample:
Sample: Header: Pagination →{"previousPage":0,"nextPage":0,"PageSize":0,"CurrentPage":0,"TotalPages":0,"TotalCount":0} [ { "FLE_ID": 66249, "ClipName": "SPM-455", "Filename": "Theresa May - Cabinet has backed draft Brexit plan - BBC News-U77ZdnYi6Kw.mp4", "UNC": "\\\\172.31.11.0\\n$\\FTP\\Speechmatics\\Theresa May - Cabinet has backed draft Brexit plan - BBC News-U77ZdnYi6Kw.mp4", "InPoint": "00:00:00:00", "OutPoint": "00:02:47:04", "ClipType": "Speechmatics", "Duration": 167.18, "DurationSMPTE": "00:02:47:04", "LocationsList": "", "DateCreated": "2018-11-14T20:13:00", "LastModified": "2018-12-20T20:15:44", "Thumbnail": "thumbnails\\29465480.png" }, { "FLE_ID": 66303, "ClipName": "SPM-463", "Filename": "Theresa May defends planned Brexit deal - BBC News-ZVJqm5-u5BU.mkv", "UNC": "\\\\172.31.11.0\\n$\\FTP\\Speechmatics\\Theresa May defends planned Brexit deal - BBC News-ZVJqm5-u5BU.mkv", "InPoint": "00:00:00:00", "OutPoint": "00:11:24:04", "ClipType": "Speechmatics", "Duration": 684.16, "DurationSMPTE": "00:11:24:04", "LocationsList": "", "DateCreated": "2018-11-21T13:53:30", "LastModified": "2018-11-21T13:56:51", "Thumbnail": "thumbnails\\29473157.png" }, { "FLE_ID": 66305, "ClipName": "SPM-467", "Filename": "Theresa May - 'I believe in my deal' - BBC News-F_WWSIt0kRo.mkv", "UNC": "\\\\172.31.11.0\\n$\\FTP\\Speechmatics\\Theresa May - 'I believe in my deal' - BBC News-F_WWSIt0kRo.mkv", "InPoint": "00:00:00:00", "OutPoint": "00:05:31:10", "ClipType": "Speechmatics", "Duration": 331.35, "DurationSMPTE": "00:05:31:10", "LocationsList": "", "DateCreated": "2018-11-21T14:01:41", "LastModified": "2018-12-07T16:17:41", "Thumbnail": "thumbnails\\29473247.png" } ]
Name
FLE_ID
Clip Name
Clip Title
ClipType
Duration
DurationSMPTE
ImportPath
DateCreated
LastModified
Thumbnail

Asset Info

POST - by (FLE_ID)
Used to return a full payload of information regarding one or more assets
POST http://< cubix-api-url>/api/1/Asset/AssetInfo
FLE_IDs Int(array)
Example: Request URL: http://< cubix-api-url>/1/Asset/AssetInfo { }

Sample:
Sample: [ { "fileImport": { "UNCPath": "\\\\192.168.1.10\\nl2\\LPR-37.MOV", "ImportID": 286, "Job_ID": 2412, "Filename": "0C20A256-BA7A-497B-8331-AB842C878067.MOV", "Directory": "\\\\10.0.0.1\\Nearline\\Production\\CubixIn\\Transcodes\\", "UNC": "\\\\10.0.0.1\\Nearline\\Production\\CubixIn\\Transcodes\\ 0C20A256-BA7A-497B-8331-AB842C878067.MOV", "FileExtension": "MOV", "filesize": 5865271, "File_DateCreated": "", "File_LastModified": "", "num_of_vid_streams": 1, "num_of_aud_streams": 1, "format": "MPEG-4", "format_profile": "QuickTime", "aud_codec": "AAC", "duration": 8267, "overall_bitrate": 5675840, "bitrate_mode": "CBR", "writing_application": "Lavf55.3.100", "video_format": "AVC", "video_profile": "Main@L3.1", "video_format_version": "0", "video_codec": "AVC", "video_bitrate": 105435, "video_mode": "CBR", "width": 1280, "height": 720, "display_aspect_ratio": 1.778, "pixel_aspect_ratio": 1, "framerate_mode": "CFR", "framerate": 25, "colour_space": "YUV", "chroma_subsampling": "4:2:0", "scan_type": "Progressive", "audio_format": "AAC", "audio_bit_depth": 0, "audio_sampling_rate": 44100, "audio_endianness": "0", "audio_bitrate": 105435, "audio_mode": "CBR", "MD5Hash": "", "FLE_ID": 305, "Parent_FLE_ID": 268, "FileInPoint": "00:00:00:00", "Transcode_Profile": "HD Video - 50L MPEG2 1920x1080", "FileOffset": "-2.60507", "FourCC": "AVC", "Deleted": null, "UUID": "CC66520E-683E-42FB-87B0-3E695ABCDB96", "FieldDominance": "PPF", "StashAndMovePath": "\\\\10.0.0.1\\Nearline\\Production\\CubixIn\\Transcodes\\", "audio_channels": 2, "AncillaryType": "1", "MezzanineType": "", "active_height": null, "active_width": null, "Language": "", "input_i": "", "input_tp": "", "input_lra": "", "input_thresh": "", "output_i": "", "output_tp": "", "output_lra": "", "output_thresh": "", "normalization_type": "", "target_offset": "", "Num_Of_Pages": null, "Page_Width": null, "Page_Height": null, "Page_Rotation": "", "Fonts_Embedded": null, "HorizontalResolution": null, "VerticalResolution": null, "Latitude": "", "Longitude": "", "CABAC": "", "Ref_Frames": "", "GOP_Structure": "", "Wrapping_Mode": "" }, "fileTracks": [ { "ChannelID": 7555, "JOB_ID": 2412, "TrackNumber": "-1", "TrackType": "ERROR", "TrackLanguage": "", "TrackMetadata": "Import error", "DateAdded": "23/05/2017 13:44:39" } ], "fileEvents": [ { "FileEventID": 1, "FLE_ID": 305, "EventType": "Silence Detection", "Offset": 0, "EventTitle": "", "EventImageURL": "", "DateAdded": "20/06/2018 10:47:51", "AddedBy": "cubix", "OutPoint": 0.89 }, { "FileEventID": 2, "FLE_ID": 305, "EventType": "Silence Detection", "Offset": 3.8, "EventTitle": "", "EventImageURL": "", "DateAdded": "20/06/2018 10:47:51", "AddedBy": "cubix", "OutPoint": 7.48 }, { "FileEventID": 3, "FLE_ID": 305, "EventType": "Silence Detection", "Offset": 175.67, "EventTitle": "", "EventImageURL": "", "DateAdded": "20/06/2018 10:47:51", "AddedBy": "cubix", "OutPoint": 176.32 }, { "FileEventID": 4, "FLE_ID": 305, "EventType": "Silence Detection", "Offset": 270.62, "EventTitle": "", "EventImageURL": "", "DateAdded": "20/06/2018 10:47:51", "AddedBy": "cubix", "OutPoint": 0 }, { "FileEventID": 6, "FLE_ID": 305, "EventType": "Subtitle_Speaker", "Offset": 0.59, "EventTitle": "M1", "EventImageURL": "", "DateAdded": "21/09/2018 15:21:34", "AddedBy": "", "OutPoint": 4.06 }, { "FileEventID": 7, "FLE_ID": 305, "EventType": "Subtitle_Speaker", "Offset": 4.07, "EventTitle": "M2", "EventImageURL": "", "DateAdded": "21/09/2018 15:21:34", "AddedBy": "", "OutPoint": 37.43 }, { "FileEventID": 8, "FLE_ID": 305, "EventType": "Subtitle_Speaker", "Offset": 38.01, "EventTitle": "M1", "EventImageURL": "", "DateAdded": "21/09/2018 15:21:34", "AddedBy": "", "OutPoint": 41.15 }, { "FileEventID": 9, "FLE_ID": 305, "EventType": "Subtitle_Speaker", "Offset": 41.79, "EventTitle": "M2", "EventImageURL": "", "DateAdded": "21/09/2018 15:21:34", "AddedBy": "", "OutPoint": 54.35 } ], "fileClips": [ { "FLE_ID": 305, "CLP_clip_name": "LPR-37", "CLP_clip_title": "244153186", "CLT_ID": "1", "CLP_in_point": "00:00:00:00", "CLP_out_point": "00:00:08:06", "CLP_duration": "00:00:08:06", "CLP_duration_frames": 206, "CLP_tc_format_id": 25, "CLP_complexity": 0, "CLP_Locations": "NL1_IN", "rowversion": "System.Byte[]", "CLP_WorkflowStatus": null, "LOC_location": "NL1", "FLE_sharer_path": "\\Omn\\A\\A\\27\\56", "FLE_date_modified": "12/04/2015 21:32:58", "CLL_location_FID": "LPR-37.MOV", "CLT_clip_type": "Leap Productions", "CLL_Pending": 0, "LCT_ID": 8, "CLD_flags": null, "CLD_source_format": null, "LocationsList": "NL1", "Complexity": 0, "CLL_location_offset": 0, "FLE_date_created": "12/04/2015 21:32:58", "CLD_clip_unavailable": 0, "CLL_ID": 1062, "LCF_ID": -99, "CLP_in_point_original": "", "CLP_out_point_original": "", "CLP_duration_original": "", "CLP_duration_frames_original": null } ], "FLE_IDS": [ 305 ] }, { "fileImport": { "UNCPath": "\\\\192.168.1.10\\nl2\\LPR-20.mov", "ImportID": 268, "Job_ID": 2264, "Filename": "Leap Reel 2015.mov", "Directory": "\\\\10.0.0.1\\Nearline\\Production\\CubixIn\\Leap Productions\\", "UNC": "\\\\10.0.0.1\\Nearline\\Production\\CubixIn\\Leap Productions\\Leap Reel 2015.mov", "FileExtension": "mov", "filesize": 97763632, "File_DateCreated": "", "File_LastModified": "", "num_of_vid_streams": 1, "num_of_aud_streams": 1, "format": "MPEG-4", "format_profile": "QuickTime", "aud_codec": "AAC", "duration": 86000, "overall_bitrate": 9094291, "bitrate_mode": "CBR", "writing_application": "Apple QuickTime", "video_format": "AVC", "video_profile": "Main@L3.1", "video_format_version": "0", "video_codec": "AVC", "video_bitrate": 128000, "video_mode": "CBR", "width": 1280, "height": 720, "display_aspect_ratio": 1.778, "pixel_aspect_ratio": 1, "framerate_mode": "CFR", "framerate": 25, "colour_space": "YUV", "chroma_subsampling": "4:2:0", "scan_type": "Progressive", "audio_format": "AAC", "audio_bit_depth": 0, "audio_sampling_rate": 44100, "audio_endianness": "0", "audio_bitrate": 128000, "audio_mode": "CBR", "MD5Hash": "", "FLE_ID": 287, "Parent_FLE_ID": null, "FileInPoint": "00:00:07:10", "Transcode_Profile": "", "FileOffset": "0.000000", "FourCC": "AVC", "Deleted": null, "UUID": "", "FieldDominance": "PPF", "StashAndMovePath": "\\\\10.0.0.1\\Nearline\\Production\\CubixIn\\Leap Productions\\", "audio_channels": 2, "AncillaryType": "", "MezzanineType": "", "active_height": null, "active_width": null, "Language": "", "input_i": "", "input_tp": "", "input_lra": "", "input_thresh": "", "output_i": "", "output_tp": "", "output_lra": "", "output_thresh": "", "normalization_type": "", "target_offset": "", "Num_Of_Pages": null, "Page_Width": null, "Page_Height": null, "Page_Rotation": "", "Fonts_Embedded": null, "HorizontalResolution": null, "VerticalResolution": null, "Latitude": "", "Longitude": "", "CABAC": "", "Ref_Frames": "", "GOP_Structure": "", "Wrapping_Mode": "" }, "fileTracks": [ { "ChannelID": 56, "JOB_ID": 2264, "TrackNumber": "0:0", "TrackType": "Video", "TrackLanguage": "eng", "TrackMetadata": "h264 (Main) (avc1 / 0x31637661), yuv420p, 1280x720, 8772 kb/s, SAR 1280:1280 DAR 16:9, 25 fps, 25 tbr, 25 tbn, 50 tbc", "DateAdded": "12/04/2015 19:09:53" }, { "ChannelID": 57, "JOB_ID": 2264, "TrackNumber": "0:1", "TrackType": "Audio", "TrackLanguage": "eng", "TrackMetadata": "aac (mp4a / 0x6134706D), 44100 Hz, stereo, fltp, 126 kb/s", "DateAdded": "12/04/2015 19:09:53" }, { "ChannelID": 58, "JOB_ID": 2264, "TrackNumber": "0:2", "TrackType": "Data", "TrackLanguage": "eng", "TrackMetadata": "none (tmcd / 0x64636D74)", "DateAdded": "12/04/2015 19:09:53" } ], "fileEvents": [], "fileClips": [ { "FLE_ID": 287, "CLP_clip_name": "LPR-20", "CLP_clip_title": "Leap Reel 2015.mov", "CLT_ID": "1", "CLP_in_point": "00:00:07:10", "CLP_out_point": "00:01:33:10", "CLP_duration": "00:01:26:00", "CLP_duration_frames": 2150, "CLP_tc_format_id": 25, "CLP_complexity": 0, "CLP_Locations": "NL1_IN", "rowversion": "System.Byte[]", "CLP_WorkflowStatus": null, "LOC_location": "NL1", "FLE_sharer_path": "\\Omn\\A\\A\\27\\38", "FLE_date_modified": "13/04/2015 02:23:25", "CLL_location_FID": "LPR-20.mov", "CLT_clip_type": "Leap Productions", "CLL_Pending": 0, "LCT_ID": 8, "CLD_flags": null, "CLD_source_format": null, "LocationsList": "NL1, PROXY, PROXY_OGV, PROXY_WEBM", "Complexity": 0, "CLL_location_offset": 90000, "FLE_date_created": "13/04/2015 02:23:25", "CLD_clip_unavailable": 0, "CLL_ID": 943, "LCF_ID": -99, "CLP_in_point_original": "", "CLP_out_point_original": "", "CLP_duration_original": "", "CLP_duration_frames_original": null }, { "FLE_ID": 287, "CLP_clip_name": "LPR-20", "CLP_clip_title": "Leap Reel 2015.mov", "CLT_ID": "1", "CLP_in_point": "00:00:07:10", "CLP_out_point": "00:01:33:10", "CLP_duration": "00:01:26:00", "CLP_duration_frames": 2150, "CLP_tc_format_id": 25, "CLP_complexity": 0, "CLP_Locations": "NL1_IN", "rowversion": "System.Byte[]", "CLP_WorkflowStatus": null, "LOC_location": "PROXY", "FLE_sharer_path": "\\Omn\\A\\A\\27\\38", "FLE_date_modified": "13/04/2015 02:23:25", "CLL_location_FID": "D0C57F47-00D5-47FE-AA25-AC79B0C0AF43.MP4", "CLT_clip_type": "Leap Productions", "CLL_Pending": 0, "LCT_ID": 8, "CLD_flags": null, "CLD_source_format": null, "LocationsList": "NL1, PROXY, PROXY_OGV, PROXY_WEBM", "Complexity": 0, "CLL_location_offset": 0, "FLE_date_created": "13/04/2015 02:23:25", "CLD_clip_unavailable": 0, "CLL_ID": 977, "LCF_ID": -99, "CLP_in_point_original": "", "CLP_out_point_original": "", "CLP_duration_original": "", "CLP_duration_frames_original": null }, { "FLE_ID": 287, "CLP_clip_name": "LPR-20", "CLP_clip_title": "Leap Reel 2015.mov", "CLT_ID": "1", "CLP_in_point": "00:00:07:10", "CLP_out_point": "00:01:33:10", "CLP_duration": "00:01:26:00", "CLP_duration_frames": 2150, "CLP_tc_format_id": 25, "CLP_complexity": 0, "CLP_Locations": "NL1_IN", "rowversion": "System.Byte[]", "CLP_WorkflowStatus": null, "LOC_location": "PROXY_OGV", "FLE_sharer_path": "\\Omn\\A\\A\\27\\38", "FLE_date_modified": "13/04/2015 02:23:25", "CLL_location_FID": "468CEE35-9F67-4101-BE81-97E1C29A4B17.OGV", "CLT_clip_type": "Leap Productions", "CLL_Pending": 0, "LCT_ID": 8, "CLD_flags": null, "CLD_source_format": null, "LocationsList": "NL1, PROXY, PROXY_OGV, PROXY_WEBM", "Complexity": 0, "CLL_location_offset": 0, "FLE_date_created": "13/04/2015 02:23:25", "CLD_clip_unavailable": 0, "CLL_ID": 999, "LCF_ID": -99, "CLP_in_point_original": "", "CLP_out_point_original": "", "CLP_duration_original": "", "CLP_duration_frames_original": null }, { "FLE_ID": 287, "CLP_clip_name": "LPR-20", "CLP_clip_title": "Leap Reel 2015.mov", "CLT_ID": "1", "CLP_in_point": "00:00:07:10", "CLP_out_point": "00:01:33:10", "CLP_duration": "00:01:26:00", "CLP_duration_frames": 2150, "CLP_tc_format_id": 25, "CLP_complexity": 0, "CLP_Locations": "NL1_IN", "rowversion": "System.Byte[]", "CLP_WorkflowStatus": null, "LOC_location": "PROXY_WEBM", "FLE_sharer_path": "\\Omn\\A\\A\\27\\38", "FLE_date_modified": "13/04/2015 02:23:25", "CLL_location_FID": "5DC72166-47CC-4837-98E6-EAFC6E6C4353.WEBM", "CLT_clip_type": "Leap Productions", "CLL_Pending": 0, "LCT_ID": 8, "CLD_flags": null, "CLD_source_format": null, "LocationsList": "NL1, PROXY, PROXY_OGV, PROXY_WEBM", "Complexity": 0, "CLL_location_offset": 0, "FLE_date_created": "13/04/2015 02:23:25", "CLD_clip_unavailable": 0, "CLL_ID": 1037, "LCF_ID": -99, "CLP_in_point_original": "", "CLP_out_point_original": "", "CLP_duration_original": "", "CLP_duration_frames_original": null } ], "FLE_IDS": [ 287 ] } ]
· All of the existing values in the AssociatedFiles call of the Items API - plus; · Any missing fields from LLS_FileImports · File Imports Tracks info · File Imports Events · Location details from LLS_Clips

XML Packet

POST - by (FLE_ID)
Post an order request or similar to our https endpoint, and will respond back in our standard schema confirming the order’s been received
POST 1/DigitalRiver
xmlPost String
Example: http://< cubix-api-url>/1/DigitalRiver Body parameter:{"xmlPost": "sample string 1"}

Sample: 200 OK
Sample: 200 OK
200 OK