Mayam Tasks API Documentation

RESTful Resources

BasePath
http://mayam.example.com:8084/tasks-ws/rest
Api Version
v1

activities

Activity management

POST /activities/site

Performs site activity on provided subject which must contain SITE_ACTIVITY_ID.

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.attributemap-v1+json

Body Parameters

inSubject
AttributeMap (multiple)
Activity subject

Response

AttributeMap

Response Codes

400
Missing required attributes
500
Failed to perform activity

bpms

Bpms process instance management

GET /bpms/instance-{id}

Get the attributemap in an active process

Produces

application/vnd.mayam.attributemap-v1+json

Path Parameters

id
string (multiple)
Process Instance Id

Response

AttributeMap

Response Codes

500
Failed to get instance
404
No instance found

DELETE /bpms/instance-{id}

Delete process instance

Path Parameters

id
string (multiple)
Process Instance Id

Response Codes

500
Failed to delete instance
404
No instance found

PUT /bpms/instance-{id}

Update BPMS Process Instance using a signal message, attribute BPMS_SIGNAL is required

Consumes

application/vnd.mayam.attributemap-v1+json

Path Parameters

id
string (multiple)
Process Instance Id

Body Parameters

map
AttributeMap (multiple)
BPMS instance data to set

Response Codes

500
Failed to create instance

POST /bpms/process-{name}

Create BPMS Process Instance, returns the process Id

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.job-v1+json

Path Parameters

name
string (multiple)
Process Name

Body Parameters

map
AttributeMap (multiple)
Initial BPMS instance data

Response

Job

Response Codes

500
Failed to create instance

POST /bpms/process-{name}/filtered

List filtered active process instances data based on process name and data in attributemap

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.attributemap-collection-v1+json

Path Parameters

name
string (multiple)
Process Name

Body Parameters

map
AttributeMap (multiple)
Map to filter on

Response

array[ AttributeMap ]

Response Codes

500
Failed to list instances
404
No instance found

configs

Config management

GET /configs

Produces a simple list of configurations that can be fetched.

Produces

application/vnd.mayam.string-collection-v1+json

Response

array[ string ]

Response Codes

500
Failed to get active configuration

GET /configs/active

Gets the active configuration for the default configuration domain.

Produces

application/vnd.mayam.config-v1+json

Response

Config

Response Codes

500
Failed to get active configuration

PUT /configs/config-{name}

Creates or updates the named configuration.

Consumes

application/vnd.mayam.config-v1+json

Path Parameters

name
string (multiple)
Configuration name

Body Parameters

config
Config (multiple)
Configuration data

Response Codes

500
Failed to update named configuration
403
Configuration exists and is not an unlocked WIP

GET /configs/config-{name}

Gets the named configuration.

Produces

application/vnd.mayam.config-v1+json

Path Parameters

name
string (multiple)
Configuration name

Response

Config

Response Codes

500
Failed to get named configuration

assets

Asset management

POST /assets

Creates a new asset based on provided data subset, returning the complete new asset.

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.attributemap-v1+json

Body Parameters

inAsset
AttributeMap (multiple)
Initial asset data

Request Examples

A valid ASSET_TYPE is required and typically at least an additional ASSET_TITLE is provided . Any Attribute with an explicit (config) or implicit (MAM specific) mapping is alllowed as input .
{
  "asset_title" : "An example title",
  "asset_type" : "ITEM",
  "op_val" : "somehing explicitly mapped"
}

Response

AttributeMap

Response Examples

The asset identifier created by the MAM is returned in ASSET_ID. Attributes passed in the request are returned in the reponse together with initial values for other mapped attributes
{
  "asset_id" : "1100120828000482821",
  "asset_site_id" : "ABV3333-anexampletitle",
  "asset_title" : "An example title",
  "asset_type" : "ITEM",
  "asset_updated" : "1615454691984",
  "op_val" : "somehing explicitly mapped"
}

Response Codes

400
Missing required attributes
500
Failed to create asset

GET /assets/asset-{type:[A-Z_]+}-{id}

Reads an asset.

Produces

application/vnd.mayam.attributemap-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Response

AttributeMap

Response Codes

404
Asset could not be found
500
Failed to read asset

PUT /assets/asset-{type:[A-Z_]+}-{id}

Updates an existing asset using the provided changes, returning complete data with the updates.

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.attributemap-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Body Parameters

inAsset
AttributeMap (multiple)
Asset data updates

Request Examples

With the identity specified in the URL, the only contents in the request body should be the changes.
{
  "op_val" : "a new and improved value"
}

Response

AttributeMap

Response Codes

404
Asset could not be found
500
Failed to update asset

GET /assets/asset-{type:[A-Z_]+}-{id}/children

Reads child assets of the identified parent; results being limited to a set of child asset types.

Produces

application/vnd.mayam.attributemap-collection-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Query Parameters

types
array[ AssetType ] (multiple)
Allowed child types

Response

Collection[ AttributeMap ]

Response Codes

404
Parent asset could not be found
500
Failed to read child assets

GET /assets/asset-{type:[A-Z_]+}-{id}/fileformat

Gets file format information about a given asset.

Produces

application/vnd.mayam.fileformatinfo-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Response

FileFormatInfo

Response Codes

500
Failed to read file format info

POST /assets/asset-{type:[A-Z_]+}-{id}/jobs/conforms

Requests a conform.

Consumes

application/vnd.mayam.conformrequest-v1+json

Produces

application/vnd.mayam.job-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Body Parameters

request
ConformRequest (multiple)
Conform request

Response

Job

Response Codes

500
Failed to request transfer

POST /assets/asset-{type:[A-Z_]+}-{id}/jobs/media-imports

Imports a file on a specified storage/service with a specified file path.

Consumes

application/vnd.mayam.importrequest-v1+json

Produces

application/vnd.mayam.job-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Body Parameters

request
ImportRequest (multiple)
Import request

Request Examples

{
  "storage" : "autoimp0",
  "filePath" : "videos/newsworthy.mxf"
}

Response

Job

Response Examples

{
  "jobId" : "19293"
}

Response Codes

500
Failed to import file

POST /assets/asset-{type:[A-Z_]+}-{id}/jobs/media-moves

Moves media essence from the source asset to the destination asset.

Consumes

application/vnd.mayam.movemediarequest-v1+json

Path Parameters

type
AssetType (multiple)
Destination type
id
string (multiple)
Destination identifier

Body Parameters

request
MoveMediaRequest (multiple)
Move media request

Response Codes

500
Failed to move media

POST /assets/asset-{type:[A-Z_]+}-{id}/jobs/transcodes

Requests a transcode of the asset video into another format using explicit or preset profile.

Consumes

application/vnd.mayam.transcoderequest-v1+json

Produces

application/vnd.mayam.job-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Body Parameters

request
TranscodeRequest (multiple)
Transcode request

Response

Job

Response Codes

500
Failed to request transcode

POST /assets/asset-{type:[A-Z_]+}-{id}/jobs/transfers

Requests a transfer of asset files; MAM and destination type dependent.

Consumes

application/vnd.mayam.transferrequest-v1+json

Produces

application/vnd.mayam.job-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Body Parameters

request
TransferRequest (multiple)
Transfer request

Response

Job

Response Codes

500
Failed to request transfer

DELETE /assets/asset-{type:[A-Z_]+}-{id}/media

Deletes the media from given asset. This is sometimes termed 'uningest'.

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Response Codes

500
Failed to delete asset media

GET /assets/asset-{type:[A-Z_]+}-{id}/qc-messages

Fetches a list of qc messages.

Produces

application/vnd.mayam.string-collection-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Response

Collection[ string ]

Response Codes

500
Failed to fetch qc messages

GET /assets/asset-{type:[A-Z_]+}-{id}/revision-{revisionId}/markers

Read markers for an asset revision.

Produces

application/vnd.mayam.marker-collection-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier
revisionId
string (multiple)
Revision identifier

Response

Collection[ Marker ]

Response Codes

500
Failed to read markers

GET /assets/asset-{type:[A-Z_]+}-{id}/tech-report

Fetches a technical report with QC events and their respective number of occurrences for an asset.

Produces

application/vnd.mayam.techreport-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Response

TechReport

Response Codes

500
Failed to fetch tech report

GET /assets/asset-{type:[A-Z_]+}-{id}/unmanaged-metadata

Gets unmanaged metadata for asset

Produces

application/vnd.mayam.unmanagedmetadata-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Response

UnmanagedMetadata

Response Examples

Example metadata from MAM
{
  "form" : "hubitem",
  "values" : {
    "asset.materialType" : "orig",
    "asset.contributor" : [ {
      "person.role" : "role1.3",
      "person.lastName" : "stestsson",
      "person.firstName" : "test"
    }, {
      "person.role" : "role1.2",
      "person.lastName" : "Bågfors",
      "person.firstName" : "Erik"
    }, {
      "person.role" : "role1.1",
      "person.lastName" : "Mårtensson",
      "person.firstName" : "Markus"
    } ],
    "asset.rightsUri" : "",
    "asset.alternativeTitle" : "eb update",
    "asset.rightsComment" : "",
    "asset.title" : "räksmörgås2",
    "asset.recordingDate" : "2021-03-11T09:24:52.001Z",
    "asset.category" : "mukn"
  }
}

Response Codes

404
Asset could not be found
500
Failed to read asset

PUT /assets/asset-{type:[A-Z_]+}-{id}/unmanaged-metadata

Updates unmanaged metadata for asset

Consumes

application/vnd.mayam.unmanagedmetadata-v1+json

Produces

application/vnd.mayam.unmanagedmetadata-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Body Parameters

metadata
UnmanagedMetadata (multiple)
Unmanaged Metadata

Response

UnmanagedMetadata

Response Codes

404
Asset could not be found
500
Failed to update asset

DELETE /assets/asset-{type}-{id}

Deletes an asset (or possibly marks it for deletion, depending on the MAM); returns last known asset data.

Produces

application/vnd.mayam.attributemap-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Query Parameters

grace-period
number (multiple) (default: 0)
Grace period (seconds)

Response

AttributeMap

Response Codes

404
Asset could not be found
500
Failed to delete asset

GET /assets/asset-{type}-{id}/segments

Gets all segment lists for the given asset.

Produces

application/vnd.mayam.segmentlist-collection-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Response

Collection[ SegmentList ]

Response Codes

400
Segments not supported by MAM
500
Failed to get segment lists

POST /assets/asset-{type}-{id}/segments

Creates a segment list with initial data for a given asset.

Consumes

application/vnd.mayam.segmentlist-v1+json

Produces

application/vnd.mayam.segmentlist-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
id
string (multiple)
Asset identifier

Body Parameters

list
SegmentList (multiple)
Initial segment list data

Response

SegmentList

Response Codes

400
Segments not supported by MAM
500
Failed to create segment list

GET /assets/site-asset-{type:[A-Z_]+}-{siteId}

Reads an asset located by its site identifier.

Produces

application/vnd.mayam.attributemap-v1+json

Path Parameters

type
AssetType (multiple)
Asset type
siteId
string (multiple)
Asset site identifier

Response

AttributeMap

Response Codes

404
Asset could not be found
500
Failed to read asset

system

Server and session management

PUT /system/clients/client-{token}

Logs client software. Sets provided API token as cookie.

Consumes

application/vnd.mayam.clientinfo-v1+json

Path Parameters

token
string (multiple)
API token (see site-config.properties/api.accounts)

Body Parameters

clientInfo
ClientInfo (multiple)
Client information

Request Examples

While both name/version pairs are optional, providing them increases usefulness of server logs.
{
  "appName" : "OurCoolApp",
  "appVersion" : "4.2",
  "clientName" : "MayamAdapter",
  "clientVersion" : "1.1"
}

GET /system/info

Gets server version and current server time (xsd:dateTimeStamp).

Produces

application/vnd.mayam.systeminfo-v1+json

Response

SystemInfo

GET /system/metrics

Gets metrics collected throughout the whole REST/SOAP subsystem.

Produces

application/json

Response

MetricRegistry

tasks

Task management

POST /tasks

Creates a new task based on provided data subset, returning the complete new task.

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.attributemap-v1+json

Body Parameters

inTask
AttributeMap (multiple)
Initial task data

Request Examples

Valid TASK_LIST_ID and TASK_STATE values are required. Additional attributes are allowed.
{
  "complete_by_date" : "2021-03-12T09:25:46.305Z",
  "task_list_id" : "ingest",
  "task_state" : "PENDING"
}

Response

AttributeMap

Response Examples

The task identifier for the newly created task is returned in TASK_ID. Attributes passed in the request are returned in the reponse together with some automatically populated attributes.
{
  "complete_by_date" : "2021-03-12T09:25:46.305Z",
  "task_created" : "1615454691984",
  "task_id" : "63637",
  "task_list_id" : "ingest",
  "task_state" : "PENDING",
  "task_updated" : "1615454691984"
}

Response Codes

400
Missing required attributes
500
Failed to create task

POST /tasks/filtered

Gets a filtered list of tasks; paging supported.

Consumes

application/vnd.mayam.filterexpression-v1+json

Produces

application/vnd.mayam.attributemap-collection-v1+json

Query Parameters

rowOffset
number (multiple) (default: 0)
Row offset
pageSize
number (multiple) (default: 40)
Page size

Body Parameters

filterExpression
FilterExpression (multiple)
Filter expression

Response

Collection[ AttributeMap ]

Response Codes

500
Failed to filter tasks

POST /tasks/filtered

Gets a filtered list of tasks; paging supported.

Consumes

application/vnd.mayam.filtercriteria-v1+json

Produces

application/vnd.mayam.attributemap-collection-v1+json

Query Parameters

rowOffset
number (multiple) (default: 0)
Row offset
pageSize
number (multiple) (default: 40)
Page size

Body Parameters

criteria
FilterCriteria (multiple)
Filter criteria

Response

Collection[ AttributeMap ]

Response Codes

500
Failed to filter tasks

DELETE /tasks/task-{id}

Deletes a task.

Path Parameters

id
number (multiple)
Task identifier

Response Codes

500
Failed to delete task

PUT /tasks/task-{id}

Updates an existing task using the provided changes, returning complete data with the updates.

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.attributemap-v1+json

Path Parameters

id
number (multiple)
Task identifier

Body Parameters

inTask
AttributeMap (multiple)
Task updates

Response

AttributeMap

Response Codes

500
Failed to update task

GET /tasks/task-{id}

Reads a task.

Produces

application/vnd.mayam.attributemap-v1+json

Path Parameters

id
number (multiple)
Task identifier

Response

AttributeMap

Response Codes

404
Task could not be found
500
Failed to read task

reports

Resource providing information tailored specifically for report generation.

segments

Segments management

GET /segments/segmentlist-{id}

Gets the identified segment list.

Produces

application/vnd.mayam.segmentlist-v1+json

Path Parameters

id
string (multiple)
Segment identifier

Response

SegmentList

Response Codes

400
Segments not supported by MAM
500
Failed to fetch segment list

DELETE /segments/segmentlist-{id}

Deletes the identified segment list.

Path Parameters

id
string (multiple)
Segment list identifier

Response Codes

400
Segments not supported by MAM
500
Failed to delete segment list

PUT /segments/segmentlist-{id}

Updates an existing segment list using the provided changes, returning complete data with the updates.

Consumes

application/vnd.mayam.segmentlist-v1+json

Produces

application/vnd.mayam.segmentlist-v1+json

Path Parameters

id
string (multiple)
Segment list identifier

Body Parameters

list
SegmentList (multiple)
Segment list data updates

Response

SegmentList

Response Codes

400
Segments not supported by MAM
500
Failed to update segment list

GET /segments/site-segmentlist/{siteId}

Gets a segment list by its site identifier.

Produces

application/vnd.mayam.segmentlist-v1+json

Path Parameters

siteId
string (multiple)
Site identifier

Response

SegmentList

Response Codes

400
Segments not supported by MAM
404
Segment list could not be found
500
Failed to fetch segment list

test

API tests (no side effects).

POST /test/exception

Always throws an exception.

Response Codes

500
Always

GET /test/task

Returns a valid task with some sample data.

Produces

application/vnd.mayam.attributemap-v1+json

Response

AttributeMap

PUT /test/task

Response contains the same task data that was sent in the request.

Consumes

application/vnd.mayam.attributemap-v1+json

Produces

application/vnd.mayam.attributemap-v1+json

Body Parameters

map
AttributeMap (multiple)
Task data

Response

AttributeMap

snapshots

NamedSnapshot management

GET /snapshots/snapshot-{name}

Produces a list of entries for a given snapshot name.

Produces

application/vnd.mayam.snapshot-collection-v1+json

Path Parameters

name
string (multiple)
NamedSnapshot name

Query Parameters

startTs
Date (multiple)
Start time
endTs
Date (multiple)
End time

Response

array[ Snapshot ]

Response Codes

500
Failed to get snapshots

POST /snapshots/snapshot-{name}

Creates a new entry for named snapshot.

Consumes

application/vnd.mayam.snapshot-v1+json

Path Parameters

name
string (multiple)
NamedSnapshot name

Body Parameters

snapshot
Snapshot (multiple)
NamedSnapshot data

Response Codes

500
Failed to create snapshot entry

users

Resource allowing access to user information.

GET /users/user-{username}/groups

Gets a list of groups that the specified user belongs to.

Produces

application/vnd.mayam.string-collection-v1+json

Path Parameters

username
string (multiple)
Username

Response

Collection[ string ]

Response Codes

500
Failed to list user groups

Data Types

Action (object) [Javadoc]

viewGroup
string
embedContexts
array[ EmbedContext ]
activities
array[ ActivityBundle.Main ]
states
array[ TaskState ]
multiplicity
Action.TaskMultiplicity
activationExpression
string
userAction
UserAction
icon
string
description
TranslatedString
id
string

Action.TaskMultiplicity (string) [Javadoc]

ZERO
EXACTLY_ONE
ONE_OR_MORE

ActivityBundle.Main (object) [Javadoc]

activationExpression
string
recoveryActivities
array[ ActivityBundle.Recovery ]
configMap
AttributeMap
uiActivity
UiActivity
serverActivity
ServerActivity

ActivityBundle.Recovery (object) [Javadoc]

configMap
AttributeMap
uiActivity
UiActivity
serverActivity
ServerActivity

ActivityClosedAllowed (string) [Javadoc]

NEVER
READ_ONLY
ALWAYS

ActivityFlowControl (string) [Javadoc]

CONTINUE
Current activity will be followed by the next one in the bundle, unless flow is interrupted by a failure. This is the default behavior unless otherwise explicitly specified.
BREAK_AFTER_CURRENT
Current activity will be the last one executed for the bundle. Unless there is a failure, the entire bundle will be considered a success even if not all of the activities have been executed. Primarily used with breakPolicy in Form configuration.
SERVER_BREAK_AFTER_CURRENT
This is used by ServerActivityRunnerImpl to break and not run after this server activity chain Current activity will be the last one executed for the bundle. Unless there is a failure, the entire bundle will be considered a success even if not all of the activities have been executed. Primarily used to stop executing server activities. Example is .addServer(ServerActivity.SITE_ACTIVITY) .set(Attribute.SITE_ACTIVITY_ID, "somethingThatSets_ACTIVITY_ERROR_CODE") .addServer(ServerActivity.JAVASCRIPT).set(Attribute.ACTIVITY_PARAM, jsq("if (s.ACTIVITY_ERROR_CODE == 1) { s.ACTIVITY_FLOW_CONTROL = {} }", ActivityFlowControl.SERVER_BREAK_AFTER_CURRENT); .addServer(ServerActivity.CREATE_BPMS_PROCESS_INSTANCE) .set(Attribute.BPMS_PROC, "somethingThatShouldNotAlwaysRun")
BREAK_AFTER_SERVER_ACTIVITIES
Current activity will be followed by any activities next in the bundle leading up to, but excluding, a UiActivity. Unless there is a failure, the entire bundle will be considered a success even if not all of the activities have been executed. Primarily used with breakPolicy in Form configuration.
PREVIOUS_AFTER_CURRENT
After the current activity is finished, flow progress will be reset to the previous UiActivity which will be performed again. Primarily used with prevPolicy in Form configuration.
PREVIOUS_AFTER_SERVER_ACTIVITIES
After the current activity and any immediately following server activities are finished, flow progress will be reset to the previous UiActivity which will be performed again. Primarily used with prevPolicy in Form configuration.

Approval (object{ string : Approval.Entry }) [Javadoc]

Approval.Entry (object) [Javadoc]

user
string
comment
string
state
Approval.State

Approval.State (string) [Javadoc]

PENDING
APPROVED
REJECTED

ApprovalRole (object) [Javadoc]

label
TranslatedString
id
string

ApprovalRole.RoleList (array[ ApprovalRole ]) [Javadoc]

AspectRatio (string) [Javadoc]

ACADEMY
CINERAMA
IMAX
PANAVISION
POLYVISION
SQUARE
SUPERSCOPE
TV_4_3
VISTAVISION
WIDE_14_9
WIDE_16_9
WIDE_5_3

AssetAccess (object) [Javadoc]

standard
AssetAccess.ControlList
media
AssetAccess.ControlList

Examples

Access control list for assets.
{
  "standard" : [ {
    "entityType" : "GROUP",
    "entity" : "cataloguers",
    "read" : true,
    "write" : true,
    "admin" : false
  } ],
  "media" : [ ]
}

AssetAccess.ControlList (array[ AssetAccess.ControlList.Entry ]) [Javadoc]

AssetAccess.ControlList.Entry (object) [Javadoc]

entityType
AssetAccess.EntityType
read
boolean
write
boolean
admin
boolean
entity
string

AssetAccess.EntityType (string) [Javadoc]

USER
Adds rights for one particular user. At most one USER entry per user is allowed.
GROUP
Adds rights for all members of a specific group. At most one GROUP entry per group is allowed.
WORLD
Specifies the base rights of anyone accessing the system. At most one WORLD entry is allowed. Name of the entity is ignored and assumed to be null.

AssetAvailability (string) [Javadoc]

AVAILABLE
The asset is available.
MISSING
The asset was removed from the MAM without Mayam Tasks being notified.
DELETED
The asset is recently deleted, or scheduled to be deleted.

AssetSubType (string) [Javadoc]

COLUMN
Database column.
METADATA
Metadata field.
EVAL
Eval expression

AssetType (string) [Javadoc]

COLLECTION
A collection of assets.
EPISODE
An episode.
ITEM
A media item.
SUBITEM
A subitem
LOG_TRACK
A grouping of logging information.
LOG_TRACK_ITEM
A logging information entry.
PACKAGE
A media package.
SEASON
A season (of a series).
SERIES
A series.
SEGMENT_LIST
A segment list
REVISION
A revision / mog.
PLAYLIST
A playlist, not including rows
PLAYLIST_ROW
A playlist row
PLAYLIST_EVENT
A playlist event (inside of a row)
FILE
A file / fil.
DIRECTORY
A directory
DIRECTORY_ENTRY
A directory entry
USER
A user.
GROUP
A user group.
EDITORIAL_OBJECT
Editorial object.
MEDIA_RESOURCE
Media resource.
PUBLICATION_EVENT
Publication event.
ESSENCE
Essence.

Attachment (object) [Javadoc]

blobId
number
filename
string
uploaded
Date
comment
string
type
string
size
number

AttachmentConstraints (object) [Javadoc]

maxTotalBytes
number
maxFiles
number

AttachmentList (array[ Attachment ]) [Javadoc]

Attribute (string) [Javadoc]

ACTIVITY_ERROR_CODE
number
Activity error code
ACTIVITY_ERROR_MSG
string
Activity error message
ACTIVITY_FLOW_CONTROL
ActivityFlowControl
Controls the activity execution flow, allowing for early termination
ACTIVITY_PARAM
string
Extra arguments to server activity code
ACTIVITY_CLOSED_ALLOWED
ActivityClosedAllowed
argument to server activity if activity can run on closed tasks
ADVERTISER
string
Name of advertiser
AGGREGATOR
string
Name of aggregator
AIR_DURATION
string
Airable duration in free form
APP_EXTIDSTR
string
String identifier related to approval
APP_FLAG
boolean
Flag related to approval
APP_ID
number
Numeric identifier related to approval
APP_NOTES
string
Approval notes
APP_SRC
string
Approval source
APP_STAT
string
Approval status
APP_TYPE
string
Approval type
APP_VAL
string
Approval value parameter
APPROVAL
Approval
Approval states for a configured set of roles
ARCHIVE_NOTES
string
Archive notes
ARCHIVE_RICH_NOTES
RichText
Archive notes using rich text
ARCHIVE_POLICY
string
Archive policy
ASPECT_RATIO
AspectRatio
Aspect ratio
ASSET_ACCESS
AssetAccess
Control lists for access to the asset
ASSET_AVAILABILITY
AssetAvailability
Availability status for the asset - does it still exist in the MAM?
ASSET_DELETED
Date
If set, describes the date and time when the asset was deleted in the MAM system
ASSET_DURATION
number
Duration of the asset, expressed in milliseconds
ASSET_EOM
number
Asset, end of message expressed in milliseconds
ASSET_WIDTH
number
Width of the asset
ASSET_HEIGHT
number
Height of the asset
ASSET_MAM_REPRESENTATION
string
Holds the internal mam represenation of the asset (if mapped)
ASSET_STORAGE_ORIGINAL
string
Original storage id of the item
ASSET_SYSTEM_ID
string
Identifies the system which manages the asset
ASSET_ID
string
The primary id of the associated asset
ASSET_LANGUAGE
string
Code describing the main language of the asset content
ASSET_PACKAGE_ID
string
Id of a container package
ASSET_PACKAGE_SITE_ID
string
Site id of a container package
ASSET_PARENT_ID
string
Primary identifier of parent asset
ASSET_PARENT_IDS
StringList
Primary identifier of parent asset
ASSET_PARENT_SITE_ID
string
Primary site identifier of parent asset
ASSET_GRANDPARENT_ID
string
Primary identifier of grandparent asset
ASSET_GUID
string
Globally unqiue asset identifier. This is an extra identifier, not the primary key to the asset
ASSET_KEY_NUMBER
string
Additional key number used to identify an asset
ASSET_PEER_ID
string
Identifier of a peer asset sharing the same type; typically a source or destination asset
ASSET_PEER_SITE_ID
string
Peer asset site identifier / file name
ASSET_PEER_TYPE
AssetType
The type of the peer asset
ASSET_SITE_ID
string
Asset site identifier / file name
ASSET_SOM
number
Asset, start of message expressed in milliseconds
ASSET_TITLE
string
The main title of the associated asset
ASSET_TYPE
AssetType
The main type of the associated asset
ASSET_SUBTYPE
string
The secondary type (if applicable) of the associated asset
ASSET_STATE
string
Current state of the asset
ASSET_UPDATED
Date
Last update of asset
ASSET_UPDATED_BY
string
Last asset update user
ASSIGNED_GROUP
string
The name of the group currently assigned to perform the task
ASSIGNED_USER
string
The name of the user currently assigned to perform the task
AUDIO_FMT
string
Audio format
AUDIT_UPDATES_BLOCKED
boolean
If true, audit trail will not be maintained for changes
AUDIO_TRACKS
AudioTrackList
Audio tracks description
AUDIO_TRACK_NUMBER
number
Number of audio tracks
AUDIO_LOUDNESS
number
Total audio loudness level
AUTOMATION_ID
string
Id in automation system
AUX_CATEGORY
string
Auxiliary category
AUX_EXTIDSTR
string
Storage of auxiliary string id
AUX_FLAG
boolean
Flag related to auxiliary data
AUX_ID
number
Storage of auxiliary numeric id
AUX_SRC
string
Source of auxiliary data
AUX_STAT
string
Auxiliary data status
AUX_TYPE
string
Auxiliary data type
AUX_URL
string
Auxiliary URL, used to pass URL to external system
AUX_VAL
string
Auxiliary data value
BPMS_INST
string
BPMS instance identifier
BPMS_PROC
string
BPMS process name
BPMS_VER
string
BPMS process version
BPMS_SIGNAL
BpmsSignal
BPMS signal to send
BPMS_CORRELATION_ATTRIBUTES
AttributeSet
BPMS correlation attribute used to find which process instance to signal
CANCEL_NOTES
string
Cancel notes
CHANNEL
string
Channel used, or that asset belongs to
CHANNELS
StringList
List of channels
CHANNEL_GROUPS
StringList
list of channel groups
CHECKSUM
string
Checksum
CHILDREN
AttributeMapList
Children for this asset, only used in some messages
CLIENT
string
Name of client related to the task
CLOSED
Date
Time and day of task closure, i.e. when a closed state was assigned to the task
CLOSED_BY
string
Name of user closing the task
COMM_ID_1
string
Communication id 1
COMM_ID_2
string
Communication id 2
COMM_ID_3
string
Communication id 3
COMMENT_LOG
CommentLog
Chat style log for comments
COMPLETE_BY_DATE
Date
Time and day of the task deadline
COMPLIANCE_NOTES
string
Compliance notes
COMPLIANCE_RICH_NOTES
RichText
Compliance notes using rich text
COMPUTED
ComputedMap
Contains values for fields with configured server side compute operations
CONS_ADV_NOTES
string
Consumer advice notes
CONT_ASPECT_RATIO
string
Content aspect
CONT_CATEGORY
string
Content category; eg. news, docu
CONT_CLASSIFICATION
string
Content classification; eq. PG13, M
CONT_DESC
string
Content description
CONT_FMT
string
Content format; eg. 1080p50
CONT_MAT_TYPE
string
Content type; eg. feed, prom
CONT_OWNER
string
Content owner
CONT_RESTRICTED_MATERIAL
boolean
Restricted material
CONT_RESTRICTED_ACCESS
boolean
Restricted access to content
CONTACT_EMAIL
string
Contact email
CONTACT_PERSON
string
Contact person
CONTACT_PHONE1
string
Contact phone 1
CONTACT_PHONE2
string
Contact phone 2
CONTACT_PHONE3
string
Contact phone 3
CONTACT2_EMAIL
string
Contact 2 email
CONTACT2_PERSON
string
Contact 2 person
CONTACT2_PHONE
string
Contact 2 phone
CONTACT3_EMAIL
string
Contact 3 email
CONTACT3_PERSON
string
Contact 3 person
CONTACT3_PHONE
string
Contact 3 phone
CONTRACT_CREATED
Date
Contract created date
CONTRIBUTOR
string
Contributor
CONTRIBUTORS
StringList
List of Contributors
CORRELATION_ATTRIBUTES
AttributeSet
Correlation attributes, used by message services for task operations
CURRENT_USER_ACTION
UserAction
Current user action performed on the task
DATE_FILTER_1
Date
Generic Filter Scope Date 1
DATE_FILTER_2
Date
Generic Filter Scope Date 2
DATE_DETAILS_1
Date
Generic Details Scope Date 1
DATE_DETAILS_2
Date
Generic Details Scope Date 2
DATE_DETAILS_3
Date
Generic Details Scope Date 3
DELETE_MEDIA
DeleteMedia
Delete media option
DIST_NAME
string
Name of distributor
DLG_STATIC_MESSAGE
TranslatedString
Statically configured message to be displayed in a dialog
DLG_DYNAMIC_MESSAGE
string
Dynamically generated message to be displayed in a dialog
DLG_TITLE
TranslatedString
Title of message dialog
DURATION_DETAILS_1
number
Duration 1, expressed in milliseconds
DURATION_DETAILS_2
number
Duration 2, expressed in milliseconds
DURATION_DETAILS_3
number
Duration 3, expressed in milliseconds
DURATION_DETAILS_4
number
Duration 4, expressed in milliseconds
DURATION_DETAILS_5
number
Duration 5, expressed in milliseconds
DURATION_DETAILS_6
number
Duration 6, expressed in milliseconds
DURATION_DETAILS_7
number
Duration 7, expressed in milliseconds
DURATION_DETAILS_8
number
Duration 8, expressed in milliseconds
EDIT_NOTES
string
Edit notes
DOUBLE_DETAILS_1
number
Generic Details Scope Double 1
DOUBLE_DETAILS_2
number
Generic Details Scope Double 2
DOUBLE_DETAILS_3
number
Generic Details Scope Double 3
DOUBLE_DETAILS_4
number
Generic Details Scope Double 4
DOUBLE_DETAILS_5
number
Generic Details Scope Double 5
DOUBLE_DETAILS_6
number
Generic Details Scope Double 6
EDIT_RICH_NOTES
RichText
Edit notes using rich text
ERROR_MSG
string
Error messages
ERROR_DATE
Date
Date of last error
EPISODE_DESC
string
Episode description
EPISODE_NUMBER
number
Episode number
EPISODE_TITLE
string
Episode title
ESC_NOTES
CommentLog
Chat style log for escalation notes
ESCALATION_LEVEL
number
Escalation level of the task, anything >0 means escalated to manager
EST_DURATION
string
Requested duration in free form
EVENT_DATE
Date
Date of an event, typically portraid within the associated asset
EVENT_DURATION
number
Duration of an event, in milliseconds
EXTENDED
Date
Time and date of the last extension (if any)
EXTENDED_BY
string
Name of user responsible for the last extension (if any)
EXPRESSION
string
Expression used to make highly configurable read-only fields
FEEDBACK_RECEIVED
Date
Describes when feedback was last received
FEEDBACK_REQUESTED
Date
Describes when feedback was last requested
FILE_NAME
string
Name of the file
FILE_CONTENTS
string
File contents
FILE_PATH
string
Full local file path (or remote URI)
FILE_EXTENSION
string
File extension
FILE_METADATA
GenericTable
File metadata
FILE_DM_SCHEMES
string
File metadata schemas
FOLDER_NAME
string
The basename of the directory path (ie. the last part)
FORM_ID
string
Identifier of a form
FORM_MSG_NOTE
string
User notification in data entry form; typically from validator
FORM_MSG_ERROR
string
User error message in data entry form; typically from validator
GENRE
string
Content genre
GRACE_PERIOD
number
Grace period (seconds) for an operation
GRANDPARENT_TASK_ID
number
Identifier of grandparent task
GROUPS
StringList
List of groups
HOUSE_ID
string
House ID
IMAGE_URL
string
Image URL (image representative of asset)
INGEST_NOTES
string
Ingest notes
INGEST_RICH_NOTES
RichText
Ingest notes using rich text
INVOKER_URLS
InvokerUrls
Invokers used
INT_DETAILS_1
number
Generic integer 1, details
INT_DETAILS_2
number
Generic integer 2, details
INT_DETAILS_3
number
Generic integer 3, details
JOB_START1
Date
Job start timestamp 1
JOB_START2
Date
Job start timestamp 2
JOB_START3
Date
Job start timestamp 3
JOB_STOP1
Date
Job stop timestamp 1
JOB_STOP2
Date
Job stop timestamp 2
JOB_STOP3
Date
Job stop timestamp 3
JSON_1
string
General purpose storage of JSON
JSON_2
string
General purpose storage of JSON
JSON_3
string
General purpose storage of JSON
JSON_4
string
General purpose storage of JSON
LAST_USER_ACTION
UserAction
Last user action performed on the task
LICENSE_COST_REMARKS
string
License cost remarks
LICENSE_DETAILS
string
License details
LICENSE_START
Date
Start of license period
LICENSE_END
Date
End of license period
LICENSE_NOTES
string
License notes
LICENSE_TYPE_OF_USE
string
License type of use
LOCATION
string
Location of physical entity
LOWRES_REQUIRED
boolean
Is lowres required
MAM_BOOKMARKS
StringList
List of assets bookmarked by the user in the MAM
MAM_UPDATES_BLOCKED
boolean
If true, changes will not be commited to the MAM during server activities
MANAGED_FOLDER_1
ManagedFolder
Holds managed files associated the task
MANAGED_FOLDER_2
ManagedFolder
Holds managed files associated the task
MANAGED_FOLDER_3
ManagedFolder
Holds managed files associated the task
MAM_OP_MODE
MamOpMode
Control the behaviour of specific MAM operations
MAIL_FORM_ID
string
Form to use as basis for e-mail body
MAIL_FROM
string
Sender e-mail address
MAIL_LANGUAGE
string
Language for use in e-mail; affects form translation
MAIL_TO
string
Recipient e-mail address
MEDIA_CREATED
Date
Time and day of media creation
MEDIA_DURATION
string
DEPRECATED: Media duration
MEDIA_EXPIRES
Date
Time and day of media expiration
MEDIA_FILE_SIZE
number
Size of media file
MEDIA_FRAME_RATE
number
Media frame rate
MEDIA_ID
string
Identifier of the primary media object
MEDIA_ITEM_COMMENTS
string
Media item comments
MEDIA_ORIGINAL_FILENAME
string
Original filename of media
MEDIA_PROFILE
string
Profile used when creating the media file
MEDIA_RIGHTS
GenericTable
Media licensing rights
MEDIA_TYPE
string
Primary media type for this asset
MEDIA_INGESTED
Date
Media ingest timestamp
MEDIA_BITRATE
number
The bitrate for the media
MEDST_AD
MediaStatus
Media status for audio description
MEDST_AUD
MediaStatus
Media status for additional audio
MEDST_CAP
MediaStatus
Media status for caption
MEDST_CAPEX
MediaStatus
Media status for extracted caption
MEDST_EDL
MediaStatus
Media status for edit decision list
MEDST_EXT
MediaStatus
Media status for extracted essence
MEDST_HR
MediaStatus
Media status for highres essence (video/audio/image)
MEDST_IMG
MediaStatus
Media status for additional image
MEDST_LR
MediaStatus
Media status for lowres
MEDST_LRCAP
MediaStatus
Media status for lowres caption
MEDST_PLAYOUT
MediaStatus
Media status for highres on playout servers
MEDST_TXT
MediaStatus
Media status for associated text
METADATA_FORM
string
Metadata form used for this Asset
MOB_ID
string
Primary id of the associated media object
NEW_ASSET
boolean
Asset is new, or is about to become created
NEW_ASSET_SITE_ID
string
Site id of asset that is about to become created
NEW_TASK_LIST_ID
string
Id of task list that is to become created
NEW_TASK_STATE
TaskState
State of task that is to become created
NEW_GRANDPARENT_TASK_ID
number
Target grandparent task when changing parent
NEW_PARENT_TASK_ID
number
Target parent task when changing parent
NOTIFY
boolean
Send notifications
NOTIFICATION_EVENT_ID
NotificationEvent
Workflow name for event notification
NOTIFICATION_SITE_EVENT_ID
string
Site specific workflow name for event notification
NOTIFICATION_EVENT_OVERRIDE_RECIPIENTS
StringList
Override recipients with this list
NOTIFICATION_SETTINGS
StringList
Notification settings
OP_DATE
Date
Date related to task operation
OP_DURATION
number
Duration related to operation, expressed in milliseconds
OP_EXTIDSTR
string
String identifier related to task operation
OP_FILENAME
string
Prefered file name for operation
OP_FLAG
boolean
Flag related to task operation
OP_FRAME_RATE
number
Frame rate related to operation
OP_HOSTNAME
string
Hostname related to task operation
OP_ID
number
Numeric identifier related to task operation
OP_SRC
string
Task operation source
OP_SOM
number
Start timecode related to operation, expressed in milliseconds
OP_STAT
string
Task operation status such as result of ingest
OP_TYPE
string
Task operation type such as type of ingest
OP_VAL
string
Task operation value parameter such as ingest channel
OP_FMT
string
Task operation parameter for format
OWNER_ORG
string
Owner organization
OWNER_DEP
string
Owner department
OWNER_USER
string
Owner user
MEMBER_IDS
StringList
Package/collection member ids or urls
PARENT_TASK_ID
number
Identifier of parent task
PARENT_HOUSE_ID
string
House id of parent asset
PASSWORD_PLAIN
string
Password passed in plain text
PASSWORD_HASH
string
Password hash suitable for storage
PROVIDER_ID
string
Provider Id
PROVIDER_NAME
string
Provider Name
PROVIDER_DETAILS
string
Provider details
PROVIDER_CONTACT
string
Provider Contact
PROXY_URL
string
Proxy URL (low resolution video representative of asset)
PURGE_PROTECTED
boolean
protected from purge
PRESENTATION_FLAG
boolean
Is presentation material
PRICE_TOTAL
string
Total price
PRIORITY
number
Priority; site specific numeric range
PRODUCTION_NUMBER
string
Production Number
REJECT_NOTES
string
Reject notes
REPORT_DATE_ATTRIBUTE
Attribute
Report date attribute
REPORT_END_DATE
Date
Report end date
REPORT_INPUT_FILE
string
Report input (definition) file name
REPORT_OUTPUT_FILE
string
Report output file name
REPORT_OUTPUT_TYPE
ReportOutputType
Report output file type (pdf)
REPORT_START_DATE
Date
Report start date
ROLES
StringList
List of roles
QC_AUTO_CLOSE
boolean
QC auto close task
QC_PRIORITY
number
QC priority
QC_PROFILE
string
QC profile
QC_REPORT
string
QC report
QC_REQUIRED
boolean
Is QC required
QC_PARALLEL_ALLOWED
boolean
Can multiple QCs happen in parallel
QC_PREVIEW_STATUS
QcStatus
QC Preview status
QC_PREVIEW_NOTES
string
QC Preview notes
QC_PREVIEW_RICH_NOTES
RichText
QC Preview notes using rich text
QC_PREVIEW_RESULT
string
QC Preview result
QC_REQUEST_OPTIONS
QCRequestOptions
QC request options, typically passed to a MAM
QC_RESULT
string
QC result
QC_NOTES
string
QC notes
QC_RICH_NOTES
RichText
QC notes using rich text
QC_FAIL_NOTES
string
QC fail notes
QC_STATUS
QcStatus
QC status
QC_SUBSTATUS1
QcStatus
QC sub status 1
QC_SUBSTATUS2
QcStatus
QC sub status 2
QC_SUBSTATUS3
QcStatus
QC sub status 3
QC_SUBSTATUS1_NOTES
string
QC sub status 1 notes
QC_SUBSTATUS1_RICH_NOTES
RichText
QC sub status 1 notes using rich text
QC_SUBSTATUS2_NOTES
string
QC sub status 2 notes
QC_SUBSTATUS2_RICH_NOTES
RichText
QC sub status 2 notes using rich text
QC_SUBSTATUS3_NOTES
string
QC sub status 3 notes
QC_SUBSTATUS3_RICH_NOTES
RichText
QC sub status 3 notes using rich text
RECEIVED_BY
string
Received by
REVISION_ID
string
Identifier of a revision of the primary asset
REVISION_NUMBER
number
Revision number
REVISION_SEGMENT_LIST_ID
string
Segment list identifier of associated revision
REVISION_STATE
RevisionState
State of the associated revision
REVISION_TITLE
string
Title of the associated revision
REQ_BY
string
Request user
REQ_EXTIDSTR
string
Request external id string such as work order id
REQ_FLAG
boolean
Flag related to the task request
REQ_FLAG2
boolean
Flag 2 related to the task request
REQ_FLAG3
boolean
Flag 3 related to the task request
REQ_FMT
string
Requested/required format
REQ_WIDTH
number
Requested Width
REQ_HEIGHT
number
Requested Height
REQ_KEYWORDS
string
Requested Keywords
REQ_TEMPLATE
string
Requested Template
REQ_TEMPLATE_CONCEPT
string
Requested Template Conceps
REQ_ID
number
Numeric identifier related to request
REQ_NUMBER
number
Number related to request
REQ_NOTES
string
Request notes
REQ_RICH_NOTES
RichText
Request notes using rich text
REQ_ALSO_NOTIFY
string
Also notify (list of additional users/email addresses)
REQ_ORIG
string
Request origin
REQ_REFERENCE
string
Request Reference
REQ_STAT
string
Request status
REQ_TYPE
string
Request type
REQ_VAL
string
Request value
REQ_AUX1
string
Request auxilary 1
REQ_AUX2
string
Request auxilary 2
REQ_AUX3
string
Request auxilary 3
REQ_AUX4
string
Request auxilary 4
REQUESTED
Date
Time and day of the task request
RIGHTS_EXPIRE
Date
Rights expiration date
RIGHTS_CODE
string
Rights code
RIGHTS_SUMMARY
string
Rights summary
RIGHTS_URI
string
Rights URI (pointer to authorative reference)
SEARCH_VIEW
SearchView
Search view
SECURITY_ZONE
string
Security zone
SEGMENTATION_NOTES
string
Segmentation notes
SEGMENTATION_RICH_NOTES
RichText
Segmentation notes using rich text
SEGMENTATION_DATA
string
Segmentation data
SEGMENTATION_LIST
SegmentList
Segmentation list
SEASON_NUMBER
number
Season number
SERIES_DESC
string
Series description
SERIES_TITLE
string
Series title
SERIES_YEAR
string
Series year
SHOW
string
Name of show
SITE_ACTIVITY_ID
string
Identifier of site activity code
SITE_ACTIVITY_PARAM
string
Arguments to site activity code
SOURCE_DESC
string
Description of source media
SOURCE_IDS
StringList
Identifiers of source media
SOURCE_EXTIDSTR
string
Source media external id
SOURCE_HOUSE_ID
string
House id of source material
SPLIT_VIEW
boolean
Split view, adds arrow button to task list UI
SPLIT_PEER_VIEW
boolean
Split view, adds arrow button to task list UI for peer asset
STARTED
Date
Timestamp used to denote the start of something
STRING_FILTER_1
string
Generic Filter Scope String 1
STRING_FILTER_2
string
Generic Filter Scope String 2
STRING_DETAILS_1
string
Generic Details Scope String 1
STRING_DETAILS_2
string
Generic Details Scope String 2
STRING_DETAILS_3
string
Generic Details Scope String 3
STRINGLIST_DETAILS_1
StringList
Generic Details Scope StringList 1
STRINGLIST_DETAILS_2
StringList
Generic Details Scope StringList 2
STRINGLIST_DETAILS_3
StringList
Generic Details Scope StringList 3
SYNOPSIS
string
Synopsis
TABLE1
GenericTable
Hierarchical data
TABLE2
GenericTable
Hierarchical data
TABLE3
GenericTable
Hierarchical data
TABLE4
GenericTable
Hierarchical data
TABLE5
GenericTable
Hierarchical data
TABLE6
GenericTable
Hierarchical data
TABLE7
GenericTable
Hierarchical data
TABLE8
GenericTable
Hierarchical data
TABLE9
GenericTable
Hierarchical data
TABLE10
GenericTable
Hierarchical data
TARIFF_LICENSE
string
Tarriff for license
TARIFF_HANDLING
string
Tarriff for handling
TASK_CREATED
Date
Time and day of task creation
TASK_CREATED_BY
string
Name of user that created the task
TASK_ID
number
Task identifier
TASK_LIST_ID
string
Identifier of the task list
TASK_PEER_ID
number
Identifier of peer task; typically a source or target
TASK_ATTACHMENTS
AttachmentList
File attachment descriptors
TASK_AUDIT_REVISION
number
Holds the revision identifier for tasks retrieved from audit history
TASK_SELECTED
boolean
Task is selected, typically by checkbox in the task list UI
TASK_STATE
TaskState
Current state of the task
TASK_STYLES
StyleMap
Attribute rendering styles
TASK_UPDATE_ORIGIN
string
Thread, method, file, and line number of code requesting update
TASK_UPDATED
Date
Time and day of last task update
TASK_UPDATED_BY
string
Name of user that last updated the task; mutually exclusive with TASK_UPDATED_BY_SYSTEM
TASK_UPDATED_BY_SYSTEM
string
Name of system that last updated the task; mutually exclusive with TASK_UPDATED_BY
TASK_UNMANAGED_METADATA
UnmanagedMetadata
Unmanaged Metadata for Task
TEMP_RICH_NOTES_1
RichText
Temporary rich text; typically used to embed some HTML for display in a form
TEMP_STRING_1
string
Temporary string; typically used with form validator or site activity logic
TEMP_STRING_2
string
Temporary string; typically used with form validator or site activity logic
TEMP_STRING_LIST_1
StringList
Temporary string list; typically used with form validator or site activity logic
TEMP_TABLE_1
GenericTable
Temporary generic table; typically used with form validator or site activity logic
TEMP_TABLE_2
GenericTable
Temporary generic table; typically used with form validator or site activity logic
TIME_LOG
TimeLog
A log over user time spent on a task
TIMECODED_TEXT
GenericTable
Text lines with timecode
TOTAL_CHILD_TASKS
number
Number of child tasks
TOTAL_GRANDCHILD_TASKS
number
Number of grandchild tasks
TX_STATUS
TxStatus
TX approval status
TX_FIRST
Date
Time and day of the original publication
TX_FIRSTCH
string
Channel in which the original publication took place
TX_NEXT
Date
Time and day of next scheduled publication
TX_READY
boolean
TX Ready
TX_DELIVER
boolean
Delivered to TX
TX_NEXTCH
string
Channel for the next publication
TX_END
Date
Time and day when the event ended
UNCLOSED_CHILD_TASKS
number
Number of child tasks not closed
UNCLOSED_GRANDCHILD_TASKS
number
Number of grandchild tasks not closed
UNMANAGED_METADATA
UnmanagedMetadata
Unmanaged Metadata
USER_LOG
CommentLog
Chat style log for user comments
USER_REMOTE_ADDRESS
string
Ip address of the client
VISUAL_BUG
string
Visual bug descriptor/identifier
VISUAL_BUG_FLAG
boolean
Visual bug included
VISUAL_TIMECODE_POSITION
string
Visual Timecode Position
VISUAL_TIMECODE_COLOR
string
Visual Timecode color
VERSION_DESC
string
Version description
VERSION_ID
string
Version id
VERSION_TITLE
string
Version title
VERSION_QUALIFIER
string
Version number/type
VERSION_NUMBER
number
Version number
XFER_DEST_ASSET_ID
string
Identifier of asset to associate destination copy with; typically used for conforms
XFER_DEST_ASSET_TYPE
AssetType
Type of asset to associate destination copy with; typically used for conforms
XFER_DEST_TYPE
string
File transfer destination type; MAM specific usage of the string
XFER_DEST_NAME
string
File transfer destination; MAM specific usage of the string
XFER_ETA
Date
File transfer ETA
XFER_ID
number
Numeric file transfer id; replaced by XFER_IDSTR
XFER_IDSTR
string
MAM specific job return value; typically uniquely identifies the transfer/conform/transcode job
XFER_JOB_STATE
string
Transfer/job state
XFER_FILENAME
string
Prefered file name for transfer destination file
XFER_LANGUAGE
string
Language associated with transfer destination; typically used for subtitle export
XFER_PERCENT
number
File transfer percent complete
XFER_PRIORITY
number
File transfer priority, (1-10000, 1 is highest priority)
XFER_PROFILE
string
File transfer/export profile, used to specify a transformation
XFER_TITLE
string
File transfer title/descriptive name
XFER_WARNING
string
File transfer warning message

AttributeMamMapping (object) [Javadoc]

qualifier
string
assetType
AssetType
assetSubType
AssetSubType

AttributeMamMapping.Map (object{ AssetType : AttributeMamMapping }) [Javadoc]

AttributeMap (object) [Javadoc]

Examples

Map from Attribute to a value with a type matching the Attribute. A task requires a TASK_ID to be set (and additionally TASK_LIST_ID and TASK_STATE during creation) and a legal asset representation requires instead ASSET_TYPE.
{
  "asset_duration" : 60000,
  "asset_id" : "1100120828000482821",
  "asset_type" : "ITEM",
  "comment_log" : {
    "entries" : [ {
      "user" : "apiuser",
      "timestamp" : "2021-03-11T11:25:04.329Z",
      "comment" : "Great job on the documentation!"
    }, {
      "user" : "apichief",
      "timestamp" : "2021-03-11T12:25:15.440Z",
      "comment" : "Thanks!"
    } ]
  },
  "op_flag" : true
}

AttributeMapList (array[ AttributeMap ]) [Javadoc]

AttributeMultiMap (object) [Javadoc]

Examples

Map from Attribute to an array of values with a type matching the Attribute. If the Attribute key is prefixed with a plus (+) then the array is interpreted as an inclusive set, whereas the minus (-) denotes a set to be used for exclusion.
{
  "+asset_type" : [ "ITEM", "EPISODE" ],
  "-task_state" : [ "CANCELLED", "FINISHED", "REJECTED_POST_FIN", "REMOVED", "EXPIRED", "FINISHED_FAILED", "FINISHED_RETURNED", "REJECTED" ]
}

AttributeRangeMap (object) [Javadoc]

Examples

Map from Attribute to an array of two values with a type matching the Attribute. First value is the start of the range and the second is its end; either can be declared open by specifying null.
{
  "priority" : [ 1, 5 ],
  "task_created" : [ "2020-03-11T09:24:51.984Z", "2022-03-11T09:24:51.984Z" ]
}

AttributeSchema (object) [Javadoc]

mamMappings
AttributeMamMapping.Map
tableDetails
TableSchemaDetails

AttributeSchema.Map (object{ Attribute : AttributeSchema }) [Javadoc]

AttributeSet (array[ Attribute ]) [Javadoc]

AudioTrack (object) [Javadoc]

name
string
encoding
AudioTrack.EncodingType
number
number

AudioTrack.EncodingType (string) [Javadoc]

LINEAR
DOLBY_E

AudioTrackList (array[ AudioTrack ]) [Javadoc]

BpmsSignal (string) [Javadoc]

ASSET_ITEM_CREATE
ASSET_ITEM_UPDATE
ASSET_ITEM_DELETE
ASSET_ITEM_DELETE_REQ
ASSET_ITEM_RESTORE
ASSET_ITEM_MEDIA_MOVE
ASSET_SUBITEM_CREATE
ASSET_SUBITEM_UPDATE
ASSET_SUBITEM_DELETE
ASSET_FILE_CREATE
ASSET_FILE_UPDATE
ASSET_FILE_DELETE
ASSET_SERIES_CREATE
ASSET_SERIES_UPDATE
ASSET_SERIES_DELETE
ASSET_EPISODE_CREATE
ASSET_EPISODE_UPDATE
ASSET_EPISODE_DELETE
ASSET_FILE_CHKSUMFAIL
ASSET_FILE_CHKSUMPASS
ASSET_COLLECTION_CREATE
ASSET_COLLECTION_UPDATE
ASSET_COLLECTION_DELETE
ASSET_COLLECTION_DELETE_REQ
ASSET_COLLECTION_RESTORE
ASSET_SEGMENT_LIST_CREATE
ASSET_SEGMENT_LIST_UPDATE
ASSET_SEGMENT_LIST_DELETE
ASSET_SEGMENT_LIST_DELETE_REQ
ASSET_SEGMENT_LIST_RESTORE
TASK_CREATE
TASK_UPDATE
TASK_DELETE
JOB_DONE
JOB_FAILED
JOB_PENDING
JOB_STARTED
JOB_RUNNING
JOB_ABORTED
MEDIA
ARCHIVED
MEDIA_PEER
UNKNOWN_MEDIA
DUPLICATE_MEDIA
APPROVE
ASSIGN
CHECKIN
CLONE
CLOSE
COMMENT
COMMIT
CONFIRM
CREATE
EDIT
ESCALATE
ESCALATE_A
ESCALATE_B
EXTEND
FAIL
FAIL_A
FAIL_B
FINISH
KEEP
MATCH
MOVE_TO_ARCHIVE
NOTIFY
OPEN
PASS
PICKUP
REJECT
REMOVE
RESUME
RETRY
RETURN
REVERT
SPECIAL
STAGE
SUSPEND
TRANSFER
UNASSIGN
TRANSCODE
REPORT

CardView (object) [Javadoc]

design
string
fields
array[Ref[ Field ]]

ClientInfo (object) [Javadoc]

appName
string
appVersion
string
clientName
string
clientVersion
string

Examples

Name and version of the application containing business logic and name and version of supporting networking library (if not integral part of the application itself)
{
  "appName" : "OurCoolApp",
  "appVersion" : "4.2",
  "clientName" : "MayamAdapter",
  "clientVersion" : "1.1"
}

Collection (object) [Javadoc]

items
array[ any ]
paging
Collection.Paging

Examples

Collection can wrap any of the other data types; below is a simple Collection[string]
{
  "items" : [ "one", "two", "three" ]
}
Paging is supported, allowing a subset to be fetched at given time
{
  "paging" : {
    "rowOffset" : 0,
    "pageSize" : 10,
    "rowCount" : 750
  },
  "items" : [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ]
}
Retrieving the next 10 entries is a matter of setting the correct query parameters
"http://.../some/collection?rowOffset=10&pageSize=10"

Collection.Paging (object) [Javadoc]

rowCount
number
rowOffset
number
pageSize
number

CommentLog (object) [Javadoc]

entries
array[ CommentLog.Entry ]

Examples

{
  "entries" : [ {
    "user" : "apiuser",
    "timestamp" : "2021-03-11T11:25:04.329Z",
    "comment" : "Great job on the documentation!"
  }, {
    "user" : "apichief",
    "timestamp" : "2021-03-11T12:25:15.440Z",
    "comment" : "Thanks!"
  } ]
}

CommentLog.Entry (object) [Javadoc]

user
string
timestamp
Date
comment
string

Computed (object) [Javadoc]

operation
Computed.Operation
parameter
string

Computed.Operation (string) [Javadoc]

SERVER_UNMANAGED_METADATA_BY_KEY
Server performs a key lookup in the unmanaged metadata.
SERVER_UNMANAGED_METADATA_BY_JSON_PATH
Server performs a lookup in the unmanaged metadata using a JSON path.
CLIENT_EXPRESSION
Client evaluates an expression.
SERVER_EXPRESSION
Server evaluates an expression.

ComputedMap (object{ string : string }) [Javadoc]

Config (object) [Javadoc]

enumTranslations
EnumTranslations
graph
Graph
schemaMap
AttributeSchema.Map
taskLists
array[ TaskList ]
forms
array[ Form ]
fields
array[ Field ]

ConformRequest (object) [Javadoc]

destType
string
destName
string
destAssetType
AssetType
destAssetId
string
filename
string

Counter (object) [Javadoc]

count
number

Cvl (object) [Javadoc]

remoteId
string
type
Cvl.Type
defaultValue
string
entries
array[ Cvl.Entry ]

Cvl.Entry (object) [Javadoc]

text
TranslatedString
value
string
id
string

Cvl.Type (string) [Javadoc]

ENUM
ENUM_SUBSET
STATIC
SITE
USER_SITE
MAM
MAM_GROUP
MAM_USER
FORM
AD

Date (string) [Javadoc]

Examples

An XML schema dateTime string with milliseconds and time zone
"2014-05-26T17:44:20.123+02:00"

DeleteMedia (string) [Javadoc]

KEEP
Keep media, no delete to be performed
UNINGEST
Uningest media and keep placeholder
DELETE
Delete placeholder including any media
DELETE_PRIMARY_MEDIA
Delete all copies of the primary media file, e.g. hires
SET_DELETE_TS
Mark for future deletion
MOVE_TO_SCRATCH
Move media to new placeholder item. May be paired with a site activity to create a task for unknown media

DetailsCategory (object) [Javadoc]

viewGroup
string
activationExpression
string
label
TranslatedString
fields
array[Ref[ Field ]]

DetailsSection (object) [Javadoc]

categories
array[ DetailsCategory ]
fields
array[Ref[ Field ]]

Divider (object) [Javadoc]

activated
boolean
excludes
boolean
pattern
string
label
TranslatedString

EmbedContext (string) [Javadoc]

FULL
Full screen width, or nearly full screen if embedded.
HALF
Half screen width; typically case: embedded within software having split-screen support.
ADOBE_AE
Embedded into Adobe After Effects as an HTML5 extension.
ADOBE_PR
Embedded into Adobe Premiere Pro as an HTML5 extension.
ADOBE_PS
Embedded into Adobe Photoshop as an HTML5 extension.

EnumTranslations (object) [Javadoc]

entries
array[ EnumTranslations.TranslatedEnum ]

EnumTranslations.TranslatedEnum (object) [Javadoc]

translations
object{ string : TranslatedString }
valueClass
class

ExceptionBean (object) [Javadoc]

links
array[ ExceptionBean.Link ]

ExceptionBean.Link (object) [Javadoc]

trace
array[ StackTraceElement ]
message
string
className
string

Field (object) [Javadoc]

labelWidth
string
shortLabel
TranslatedString
hint
TranslatedString
viewGroup
string
editGroup
string
displayChars
number
displayRows
number
listColumnWidth
number
displayMode
Field.DisplayMode
filterMode
Field.FilterMode
cvl
Cvl
minConstraint
number
maxConstraint
number
patternConstraint
string
formHeight
string
formWidth
Field.FormWidth
embedContexts
array[ EmbedContext ]
hierarchyLevel
Field.HierarchyLevel
normalizationFn
string
computed
Computed
iconMap
StyledIcon.Map
dividers
array[ Divider ]
attribute
Attribute
label
TranslatedString
id
string
defaultValue
string

Examples

Sample field based on ASSET_TITLE
{
  "id" : "title",
  "attribute" : "asset_title",
  "label" : {
    "sv" : "Titel",
    "en" : "Title"
  },
  "readOnly" : false,
  "mandatory" : false,
  "displayChars" : 20,
  "displayRows" : 0,
  "cvl" : {
    "entries" : [ ]
  },
  "formWidth" : "DEFAULT",
  "hierarchyLevel" : "DEFAULT"
}

Field.DisplayMode (string) [Javadoc]

SHORT
MEDIUM
LONG
DATE_ONLY_SHORT
DATE_ONLY_MEDIUM
DATE_ONLY_LONG
SHOW_NEWLINES
ICON_LIST
RIO_DRAGABLE
STRIP_DOMAIN
BUTTON

Field.FilterMode (string) [Javadoc]

LIKE
EQUALS
RANGE
ALTERNATIVES

Field.FormWidth (string) [Javadoc]

DEFAULT
NARROW
WIDE
FULL

Field.HierarchyLevel (string) [Javadoc]

DEFAULT
PARENT
GRANDPARENT

FileFormatInfo (object) [Javadoc]

fileSize
number
mediaUrls
array[ string ]
dataUrls
array[ string ]
urls
array[ string ]
audioBitrate
number
audioChannels
number
audioEncoding
string
audioFormat
string
audioMime
string
audioSamplerate
number
audioSamplewidth
number
audioTracks
number
durationFrames
number
frameRate100
number
imageSizeX
number
imageSizeY
number
tcIn
string
tcOut
string
videoAspect
string
videoBitrate
number
videoBitrateType
string
videoChroma
string
videoEncoding
string
videoFormat
string
videoGopsize
number
videoMime
string
videoStdDesc
string
wrapperFormat
string
wrapperMime
string

FilterCriteria (object) [Javadoc]

sortOrders
array[ FilterCriteria.SortOrder ]
filterEqualities
AttributeMap
filterSimilarities
AttributeMap
filterRanges
AttributeRangeMap
filterAlternatives
AttributeMultiMap
searchEqualities
AttributeMap
searchSimilarities
AttributeMap
searchRanges
AttributeRangeMap
searchAlternatives
AttributeMultiMap

FilterCriteria.SortOrder (object) [Javadoc]

nullBehavior
FilterCriteria.SortOrder.NullBehavior
attribute
Attribute
direction
FilterCriteria.SortOrder.Direction

FilterCriteria.SortOrder.Direction (string) [Javadoc]

ASC
Ascending, starting with the lowest value
DESC
Descending, starting with the highest value

FilterCriteria.SortOrder.NullBehavior (string) [Javadoc]

ALWAYS_FIRST
Nulls are returned first, regardless of sort direction.
ALWAYS_LAST
Nulls are returned last, regardless of sort direction.
INVERTED
Nulls are returned first on DESC and last on ASC, the inverse of default.

FilterExpression (object) [Javadoc]

expressionObjects
object{ string : Object }
sortOrders
array[ FilterCriteria.SortOrder ]
expression
string

FilterSection (object) [Javadoc]

fields
array[Ref[ Field ]]

Form (object) [Javadoc]

okText
TranslatedString
cancelText
TranslatedString
breakText
TranslatedString
breakPolicy
ActivityFlowControl
prevText
TranslatedString
prevPolicy
ActivityFlowControl
labelWidth
string
title
TranslatedString
format
string
fields
array[Ref[ Field ]]
id
string

Gauge (object) [Javadoc]

value
any

GenericTable (object) [Javadoc]

rows
array[ GenericTable.Row ]
columnNames
array[ string ]

GenericTable.Row (array[ string ]) [Javadoc]

Graph (object) [Javadoc]

edges
array[ Graph.Edge ]

Graph.AttributeSource (string) [Javadoc]

FROM_VERTEX
TO_VERTEX
EDGE

Graph.Edge (object) [Javadoc]

sortOrders
array[ Graph.EdgeSortOrder ]
toVertex
Graph.Vertex
fromVertex
Graph.Vertex
label
TranslatedString
fields
array[Ref[ Field ]]
id
string

Graph.EdgeSortOrder (object) [Javadoc]

source
Graph.AttributeSource
nullBehavior
FilterCriteria.SortOrder.NullBehavior
attribute
Attribute
direction
FilterCriteria.SortOrder.Direction

Graph.Vertex (object) [Javadoc]

taskListId
string
fields
array[Ref[ Field ]]

HeaderSection (object) [Javadoc]

fields
array[Ref[ Field ]]

Histogram (object) [Javadoc]

snapshot
Snapshot
count
number

ImageDimensions (object) [Javadoc]

height
number
width
number

ImportRequest (object) [Javadoc]

filePath
string
fileSize
string
mediaType
string
checksum
string
storage
string
priority
number
fileName
string

Examples

{
  "storage" : "autoimp0",
  "filePath" : "videos/newsworthy.mxf"
}

Invoker (string) [Javadoc]

APPLE_FCP
ASSET_WEB_PAGE
ASSET_WEB_PAGE_FOLDER
ASSET_WEB_PAGE_FILES
ASSET_WEB_PAGE_LOGDATA
ASSET_WEB_PAGE_METADATA
ASSET_WEB_PAGE_RELATIONS
ASSET_WEB_PAGE_TASKS
BPMS_VIEW
VIZ_CAPTURE
VIZ_CAPTURE_OUTGEST
VIZ_CAPTURE_PLAYOUT
VIZ_EASYCUT
VIZ_IMPORTER
VIZ_MEDIALOGGER
VIZ_PRECUT
VIZ_PREVIEW
VIZ_PRESEG
VIZ_SHOTCUT
VLC

InvokerUrls (object{ Invoker : string }) [Javadoc]

Job (object) [Javadoc]

jobId
string

Examples

{
  "jobId" : "19293"
}

ListSection (object) [Javadoc]

fields
array[Ref[ Field ]]

Examples

Two fields to be shown in the list view of the user interface
{
  "fields" : [ "title", "owner" ]
}

MamOpMode (string) [Javadoc]

NORMAL
Default mode - applies to 99.9% of all operations. Default if null
SKIP_RELATED
Skip fetching of processing of related data, typically to improve performance
VERBOSE_LOG
Extra verbose logging requested
SKIP_AND_VERBOSE
Extra verbose logging requested and skip fetching of processing of related data

ManagedFile (object) [Javadoc]

category
string
pictureHeight
number
pictureWidth
number
filename
string
codec
string
mimeType
string
relativePath
string
comment
string
created
Date
type
ManagedFile.ManagedFileType
size
number

ManagedFile.ManagedFileType (string) [Javadoc]

VIDEO
A video file; mp4, mxf etc.
AUDIO
An audio file; mp3, wav etc.
SUBTITLE
Subtitle file; stl, 890 etc.
SCRIPT
Script file.
DOCUMENT
A generic document; xlsx, docx, pdf etc.
PLACEHOLDER
Placeholder. No actual file contents stored.
UNKNOWN
Anything currently not covered by the enum or unknown (temporarily or permanently).

ManagedFolder (object) [Javadoc]

storage
string
rootPath
string
files
array[ ManagedFile ]

ManagedFolderDefinition (object) [Javadoc]

categoryCvl
Cvl
fileFields
array[ ManagedFolderDefinition.ManagedFileField ]
label
TranslatedString

ManagedFolderDefinition.ManagedFileField (string) [Javadoc]

CREATED
Date and time of file creation or association with task.
TYPE
Primary type of the managed file.
RELATIVE_PATH
Path relative to the root path of the managed folder excluding file name.
FILENAME
File name.
SIZE
File size in bytes.
MIME_TYPE
Media type / MIME type.
CATEGORY
Category, as specified via configured CVL.
COMMENT
User comment.
CODEC
File codec if applicable.
PICTURE_HEIGHT
Picture height if applicable.
PICTURE_WIDTH
Picture width if applicable.

ManagedFolderDefinition.Map (object{ Attribute : ManagedFolderDefinition }) [Javadoc]

Marker (object) [Javadoc]

title
string
typeStr
string
mediaId
string
in
Timecode
duration
Timecode
id
string
type
number

MediaStatus (string) [Javadoc]

MISSING
Missing. Currently not available.
ERROR
Error. Media corrupt or missing due to error in processing.
READY
Ready. Available for immediate use.
ACTIVE
Active. Currently being transfered and/or transcoded.
NEARLINE
Nearline. Available but access is likely to require time.
VAULTED
Media resides on vaulted tape
DELETED
Media has been deleted

Meter (object) [Javadoc]

fifteenMinuteRate
number
fiveMinuteRate
number
meanRate
number
oneMinuteRate
number
count
number

Metric (object) [Javadoc]

MetricRegistry (object) [Javadoc]

gauges
object{ string : Gauge }
counters
object{ string : Counter }
histograms
object{ string : Histogram }
meters
object{ string : Meter }
timers
object{ string : Timer }
metrics
object{ string : Metric }
names
array[ string ]

MoveMediaRequest (object) [Javadoc]

srcAssetType
AssetType
srcAssetId
string

NotificationEvent (string) [Javadoc]

CLOSE_TASK
CREATE_ASSET
CREATE_TASK
NOTIFICATION_TEST
CANCEL_TASK
JOB_DONE
JOB_FAILED
REJECT_TASK
RESUME_TASK
SUSPEND_TASK
UPDATE_ASSET
UPDATE_TASK
DELETE_ASSET
DELETE_TASK
DELIVERED
HAS_MEDIA
ERROR
XFER_ERROR
XFER_CANCEL
TX_READY
QC_PASS
NOTIFICATION_FAIL
REPORT_DONE

QCRequestOptions (object) [Javadoc]

profile
string
qcType
string
qcContext
string
priority
string

QcStatus (string) [Javadoc]

FAIL
QC failed
PASS
QC pass
TBD
QC status not yet known
PASS_MANUAL
Manually passed. Fail overwritten
SKIPPED
Skipped
WARNING
Warning
EDIT
Edit

Query (object) [Javadoc]

search
array[ Query.Entry ]
tasklist
string
filter
array[ Query.Entry ]

Query.Entry (object) [Javadoc]

value
Query.ValueType
field
string

Query.ValueType (object) [Javadoc]

type
string

Ref (string) [Javadoc]

Examples

Configuration types, such as Field, have identifiers
{
  "id" : "title",
  "attribute" : "asset_title",
  "label" : {
    "sv" : "Titel",
    "en" : "Title"
  },
  "readOnly" : false,
  "mandatory" : false,
  "displayChars" : 20,
  "displayRows" : 0,
  "cvl" : {
    "entries" : [ ]
  },
  "formWidth" : "DEFAULT",
  "hierarchyLevel" : "DEFAULT"
}
A Ref[..] refers to the identifier of such a type
"title"

Relation (object) [Javadoc]

sortOrders
array[ FilterCriteria.SortOrder ]
expression
string
label
TranslatedString
fields
array[Ref[ Field ]]

ReportOutputType (string) [Javadoc]

CSV
Comma-separated values.
EXCEL
Excel Spreadsheet.
HTML
HTML.
PDF
PDF.

RevisionState (string) [Javadoc]

OPEN
LOCKED
DISABLED

RichText (object) [Javadoc]

deltas
object{ string : Object }
html
string

SearchSection (object) [Javadoc]

fields
array[Ref[ Field ]]

SearchView (object) [Javadoc]

sortOrders
array[ FilterCriteria.SortOrder ]
name
string
query
Query

Segment (object) [Javadoc]

title
string
in
Timecode
duration
Timecode
id
string
type
Segment.Type
number
number

Segment.Type (string) [Javadoc]

BREAK
SEGMENT

SegmentList (object) [Javadoc]

attributeMap
AttributeMap
id
string
entries
array[ Segment ]

ServerActivity (string) [Javadoc]

ADD_ASSET_ACL
Add an ACL entry to an asset
ADD_TASK_STYLES
Adds task styling. May override existing styling.
ASSIGN_TO_GROUP
Assign the task to a specific group.
ASSIGN_TO_USER
Assign the task to a specific user.
CHANGE_PARENT_TASK
Update the task parent and update parent/grandparent child counters
CLEAR_TASK_STYLES
Resets all styling for the task.
CLOSE_TASK
Closes the task.
COMMIT
CONDITIONAL_DELETE_ASSET
Perform conditional asset or media deletetion, us
CREATE_ASSET
Creates a new asset.
CREATE_TASK
Creates a new task.
CREATE_SUBTASK
Creates a sub task, specifying the existing task.
CREATE_BPMS_PROCESS_INSTANCE
Create a BPMS process instance
DELETE_ASSET
Deletes the asset.
DELETE_TASK
Deletes the task.
EDIT
ESCALATE
Make changes to escalation level.
EXTEND
Postpone the media expiration date or other due date.
FETCH_FROM_MAM
Fetches attribute values reflecting the current state of the associated asset in MAM.
FIND_UNIQUE_TASK_FOR_ASSET
Find the task that matches the provided asset.
JAVASCRIPT
KEEP
LINK
Links a task to an asset.
MATCH
MOVE_TO_ARCHIVE
PARSE_ATTACHMENTS
Parses attachments for the purposes of validation and preliminary metadata extraction.
PROCESS_ATTACHMENTS
Perform activities based on the contents of the attachments, such as creating new tasks.
PICKUP
Assign task to the calling user.
REJECT
REJECT_HIERARCHY
REMOVE
REMOVE_ASSET_ACL
Remove an ACL entry from an asset
RETURN
RETIRE_ASSET
Retires an asset SITE_ACTIVITY_PARAM will contain the ID of the scratch item after this is used
RETIRE_ASSET_OMS
REVERT
REQUEST_REPORT
Requests a report to be generated.
SAVE
Stores a subject in MAM and/or tasks database. Used by daemons and actions that need to save in the middle of the work order.
SAVE_ASSET
The pseudo activity of updating an asset in the mam at the end of a runners order.
SAVE_TASK
The pseudo activity of saving a task to the database at the end of a runners order.
SET_TASK_STATE
Sets the current state of the task.
CONFORM
Performs a simple conform.
FILE_TRANSFER
Performs a simple file transfer.
TRANSCODE
Performs a simple transcode.
SITE_ACTIVITY
Performs a site specific activity.
UNASSIGN
Remove user assignment.
UNINGEST_ASSET
Remove media from an asset.
UNLINK
UPDATE_BPMS_PROCESS_INSTANCE
Update a BPMS process instance
VERIFY_SUBJECT
The pseudo activity of verifying a task and/or asset before activity starts.

Snapshot (object) [Javadoc]

ts
Date
value
string

Snapshot (object) [Javadoc]

median
number
mean
number
min
number
stdDev
number
max
number

SortOrderPreset (object) [Javadoc]

label
TranslatedString
id
string
entries
array[ FilterCriteria.SortOrder ]

SortSection (object) [Javadoc]

orders
array[ SortOrderPreset ]
selection
SortSection.PresetSelection

SortSection.PresetSelection (string) [Javadoc]

SINGLE_PRESET
A single preset is chosen in the UI
MULTI_SORT
Multiple presets (typically with only one attribute each) can be chosen

StringList (array[ string ]) [Javadoc]

Style (string) [Javadoc]

COLOR_BLUE
COLOR_GREY
COLOR_GREEN
COLOR_ORANGE
COLOR_PURPLE
COLOR_RED
COLOR_YELLOW
STYLE_BOLD
STYLE_ITALIC
STYLE_UNDERLINE
STYLE_STRIKETHROUGH
SIZE_SMALL
SIZE_LARGE
INVERT_COLOR

StyleMap (object{ Attribute : StyleSet }) [Javadoc]

Examples

Describes styling per attribute.
{
  "asset_title" : [ "STYLE_UNDERLINE", "COLOR_BLUE" ],
  "complete_by_date" : [ "COLOR_RED" ]
}

StyleSet (array[ Style ]) [Javadoc]

Examples

Only foreground colors are specifed, and they are mutually exclusive. Other styles can be combined arbitrarily.
[ "STYLE_UNDERLINE", "COLOR_BLUE" ]

StyledIcon (object) [Javadoc]

color
StyledIcon.Color
icon
string
text
TranslatedString

StyledIcon.Color (string) [Javadoc]

BLUE
GREY
GREEN
ORANGE
PURPLE
RED
YELLOW

StyledIcon.Map (object{ string : StyledIcon }) [Javadoc]

SystemInfo (object) [Javadoc]

serverVersion
string
time
Date

TableSchemaDetails (object) [Javadoc]

min
number
columns
array[ TableSchemaDetails.ColumnDefinition ]
ordering
TableSchemaDetails.Ordering
primaryColumn
string
max
number

TableSchemaDetails.ColumnDefinition (object) [Javadoc]

cvl
Cvl
minConstraint
number
maxConstraint
number
patternConstraint
string
valueClass
class
mamMapping
string
label
TranslatedString
name
string

TableSchemaDetails.Ordering (string) [Javadoc]

APPEND_ONLY
Strictly append only, no reordering or deletes.
DELETE_ONLY
Allows deletions of existing rows, but no reordering or insertions.
FIXED_ROWS
If primaryColumn is set and is associated with a Cvl, one row is created for each and every value. No inserts, reordering, or deletes allowed. If the two conditions are not met, FIXED_ROWS will maintain TableSchema#max rows; any value of max <1 (including null) denotes an illegal configuration.
REORDER_ALLOWED
Rows may be freely reordered, inserted, and deleted.

TaskList (object) [Javadoc]

viewGroup
string
sortSection
SortSection
filterCriteria
FilterCriteria
relations
array[ Relation ]
taskActions
array[ Action ]
mediaActions
array[ Action ]
externalActions
array[ Action ]
approvalRoles
ApprovalRole.RoleList
userFacingAttribute
Attribute
assetConstraint
TaskList.AssetConstraint
managedFolderDefinitions
ManagedFolderDefinition.Map
historyViewWindow
number
attachmentConstraints
AttachmentConstraints
imageDimensions
ImageDimensions
cardView
CardView
title
TranslatedString
navigationMode
TaskList.NavigationMode
listSection
ListSection
headerSection
HeaderSection
detailsSection
DetailsSection
filterSection
FilterSection
searchSection
SearchSection
id
string

TaskList.AssetConstraint (string) [Javadoc]

UNIQUE
An asset is required; it may not be shared with any active task in the list.
FULLY_UNIQUE
An asset is requires; it may not be shared with any other task in the list - active or closed.
NON_UNIQUE
An asset is required; sharing between tasks is allowed.
OPTIONAL
An asset is allowed, but not required. This is the default if no explicit constraint is specified.

TaskList.NavigationMode (string) [Javadoc]

HIDDEN
List is not available to the user as a direct choice.
PRIMARY
Default list given that the user has not actively chosen. Only one list can have this mode at any given time.
STANDARD
List is a valid user choice.
ASSET
List is StandaloneSystem asset.

TaskState (string) [Javadoc]

ACTIVE
Task is active
ASSIGNED
Task assigned to user
DONE
Work done, but task should remain in the task list
DRAFT
Task represents work or data in a draft state
CANCELLED
Closed: Cancelled.
EXPIRED
Closed: Expired.
FINISHED
Closed: Finished.
FINISHED_FAILED
Closed: Finished unsuccessfully.
FINISHED_RETURNED
Closed: Finished and returned to a previous workstep
REVERTED
Reverted, NOT closed
REJECTED
Closed: Rejected.
REJECTED_POST_FIN
Closed: Finished successfully first, then rejected through an override operation
REMOVED
Closed: Removed.
APPROVED
Approved.
APPROVAL_PART
Partially approved.
APP_PENDING
Approval pending.
APP_PENDING2
Approval pending 2.
ERROR
ERROR2
Alternate error code 2
ERROR3
Alternate error code 3
ERROR4
Alternate error code 4
ESCALATED
EXTENDED
Extended; due date postponed.
FEEDBACK
Task is awaing feedback
INACTIVE
Task is inactive
INGEST_DONE
Ingest has been performed.
IN_PROGRESS
Task is in progress
OPEN
PENDING
Task in pending state, waiting for activation
PENDING_INFO
Task in pending state, waiting for additional information
PROCESSING
A request is being processed
READY
Task preparations done, task is ready for processing
SUBMITTED
Task/request submitted
SUSPENDED
Task execution suspended
SYS_WAIT
JOB
Task waiting for some JOB to be done
BILLING_WAIT
Waiting for a billing operation to finish
INPUT_WAIT
Waiting for input from peer system or user
FILE_WAIT
Waiting for file to become available
LOWRES_WAIT
Waiting for lowres media to become available
HIGHRES_WAIT
Waiting for highres media to become available
METADATA_WAIT
Metadata update wait
TX_MEDIA_WAIT
Waiting for TX prepared media to become available
UPDATE_WAIT
Waiting for a peer user or system to provide update
UPDATE_WAIT2
Waiting for a peer user or system to provide update
WARNING
WARNING2
XFER

TechReport (object) [Javadoc]

events
object{ string : number }

Examples

The technical report is comprised of QC event/count pairs.
{
  "events" : {
    "Timecode / VITC discontinuity" : 1
  }
}

TimeLog (object) [Javadoc]

entries
array[ TimeLog.TimeEntry ]

TimeLog.TimeEntry (object) [Javadoc]

user
string
timestamp
Date
overrideCost
number
extraCost
number
comment
string
duration
number

Timecode (object) [Javadoc]

fps
number
dropframe
boolean
totalFrames
number
intFps
number

Timer (object) [Javadoc]

fifteenMinuteRate
number
fiveMinuteRate
number
meanRate
number
oneMinuteRate
number
snapshot
Snapshot
count
number

TranscodeRequest (object) [Javadoc]

destName
string
profile
string
filename
string
priority
number

TransferRequest (object) [Javadoc]

destType
string
destName
string
filename
string
language
string
priority
number

TranslatedString (object{ string : string }) [Javadoc]

Examples

Map from language code to translation
{
  "sv" : "Titel",
  "en" : "Title"
}

TxStatus (string) [Javadoc]

COMPLETE
Approved for TX, and all secondary elements are in place
NEVER
Rejected, may not be used
NOT_READY
Pending decision, material is being processed
READY
Approved for TX
TBD
No information available

UiActivity (string) [Javadoc]

ASSIGN_VALUES
Assigns values to the subject(s). Can thought of as having an InputAttributes#value() set to all of Attribute.values().
BPMS_VIEW
Displays a view of the current BPMS state.
DIALOG
FORM
Displays the form specified in Attribute.FORM_ID, merging any changed made to the subjects.
TASK_HISTORY
Displays the history view
PRINT
Displays the print view
HIGHLIGHT_TASK
Ensures that a task is visible in the task list and makes it stand out temporarily.
REFRESH_TASKLIST
Updates the current tasklist. Use after creating new task if you want it to show instantly
INVOKE
Invokes an external application for the primary asset. The choice will be made based on the value of Attribute.LAST_USER_ACTION which is set upon clicking a user action button. Supported are only the values of UserAction that begin with INVOKE_.
PEER_INVOKE
Invokes an external application for the peer asset. The choice will be made based on the value of Attribute.LAST_USER_ACTION which is set upon clicking a user action button. Supported are only the values of UserAction that begin with PEER_INVOKE_.
ATTACH
Allows the user to upload file attachments. Prior to 2.6, this functionality was called UPLOAD.
UPLOAD
Allows the user to upload files to a ManagedFolder. The specific folder is specified by its attribute name (eg. MANAGED_FOLDER_3) in ACTIVITY_PARAM.
ADD_TO_ADOBE_PROJECT
Adds media in the current task to a project in Adobe Premiere Pro or Photoshop
ADD_PEER_TO_ADOBE_PROJECT
Adds peer item media in the current task to a project in Adobe Premiere Pro or Photoshop
INVOKE_ADOBE_EXPORT
Invoke a media export operation in Adobe Premiere or Photoshop. The target is the ASSET_SITE_ID of the selected task
INVOKE_BIRT
Invoke the BIRT viewer, allowing reports to be viewed and/or exported.
INVOKE_EXCEL_EXPORT
Invoke the synchronous Excel export with http download to from browser
INVOKE_ACCURATE_PLAYER
Invokes the Accurate Player.
FILTER_RELATED
Causes tasks to be filtered using a set of attributes, values of which are taken from the currently selected task. Format for ACTIVITY_PARAM is a comma separated list of attributes or colon separated pairs (target:source). Each target attribute MUST also be configured as a search/filter attribute in the target task list.
FILTER_CHILDREN
Causes tasks to be filtered by a given set of values for PARENT_TASK_ID.
DISCUSSION
Allows the user to take an active part in a discussion.
SPLIT_VIEW
Splits the view, showing Viz One asset to the right.
RIO_TAKE
Timeline will be setup with a blank 1 minute clip of the specified resolution and all sources placed into a project folder in the RIO Editor’s clips bin
RIO_PARK
Parks the current timeline clip and produces a BOM (Bill of Materials) for the clip.
RIO_PUBLISH_SQ
The timeline clip will be published to the configured SQ server and produces a BOM for the clip.
RIO_PUBLISH_FILE
The timeline clip will be published to the configured SQ server and produces a BOM for the clip.
TO_MATCHBOX
Causes task to be activated in the match box.
FROM_MATCHBOX
Causes TASK_PEER_ID to be set to the task active in the task box, if any.
GET_MAM_BOOKMARKS
Causes MAM_BOOKMARKS to be set based on the Viz One stack or equivalent.
NAVIGATE
Navigates to the specified screen. Format of the ACTIVITY_PARAM the same as a crumb in the trail url representation, e.g. "server;tasklist:import".
GET_SEARCH_VIEW
Sets SEARCH_VIEW to the current search view, including changes made since last save.
TEMPORARY_SEARCH_VIEW
If SEARCH_VIEW is set, creates a temporary search view. Should only be used with task multiplicity of ZERO or EXACTLY_ONE.
TABLE_SUBSET
Allows the user to define a subset of the rows of one table which will then make up the rows of a second table. The attributes of the two tables are to be provided, separated by comma, in ACTIVITY_PARAM, e.g. "TABLE8,TEMP_TABLE_1".

UnmanagedMetadata (object) [Javadoc]

values
object{ string : Object }
form
string

UserAction (string) [Javadoc]

ACKNOWLEDGE
Typically acknowledges an issue shown on an error task list.
ADD_TO_ADOBE_PROJECT
Add media in Task to Project in Premiere Pro
APPROVE
Approve request.
ARCHIVE
Archive content referenced by task.
ASSIGN
Task is assigned to a user/group.
ATTACH
Attaches a file to a task.
CANCEL
Cancel a task/request
CHECKIN
CLONE
CLOSE
Close a task. Relevant in the context of projects etc.
COMMENT
Add a comment to the task, typically shows a form with a CommentLog.
COMMIT
Commit a pending request, typically delete.
CONFIRM
Confirm notification and/or request.
CREATE
A new task is registered with the system.
DEBUG_CREATE
Debug: A new task is registered with the system.
DEBUG_EDIT
Debug: Task data is modified.
DISCUSSION
Discussion.
EDIT
Task data is modified.
EDIT_A
Task data is modified.
EDIT_B
Task data is modified.
ESCALATE
Task escalation level is set, which means assigned to a manager.
ESCALATE_A
Extra: Task escalation typically set to a predefined level.
ESCALATE_B
Extra: Task escalation typically set to a predefined level.
EXTEND
Extends expiry date.
EXPORT_TO_EXCEL
Extends expiry date.
FAIL
Flags the task as failed, typically by modifying asset metadata.
FAIL_A
Extra: Flags the task as failed.
FAIL_B
Extra: Flags the task as failed.
FILTER_A
Causes some filtering to be applied; typically via UiActivity.FILTER_CHILDREN.
FILTER_B
Causes some filtering to be applied.
FILTER_C
Causes some filtering to be applied.
FINISH
Task is closed with state finished.
IMPORT_INTO_ADOBE
Import media into an Adobe composition or project
KEEP
Finish expiry-like task, keeping the asset.
LINK
An asset is associated with the task.
LOAD_IN_ADOBE
Load task media into an Adobe application, used by PS
MATCH
An asset is matched with a peer asset within the task.
MARK
Mark an asset or task
MOVE_TO_ARCHIVE
Moves the current (expiry) task as a new task to the archive task list.
NOTIFY
Sends a notification, mail or otherwise
OPEN
Open a task. Relevant in the context of projects etc.
PASS
Flags the task as successful, typically by modifying asset metadata.
PASS_A
EXTRA: Flags the task as successful, typically by modifying asset metadata.
PASS_B
EXTRA: Flags the task as successful, typically by modifying asset metadata.
PREPARE_MATCH
Triggers the start of a matching process.
PICKUP
Task is assigned to a user at his/her request.
PLAY
Media for the asset is played.
REASSIGN
Reassign user or other related entity
REJECT
Task is closed with state rejected.
REMOVE
Task is deleted, optionally keeping history.
REQUEST
Raise a request based on the selected task(s)
RESUME
Suspend a task
RETRY
Task gets flagged for retry, likely by setting state to something other than ERROR.
RETURN
Return a previously escalated task, resetting escalation level.
REVERT
Task is reverted to a previous state.
RIO_TAKE
RIO Take
RIO_PARK
RIO Park
RIO_PUBLISH_SQ
RIO Publish SQ
RIO_PUBLISH_FILE
RIO Publish File
SAVE_IN_ADOBE
Save active docment to task placeholder in an Adobe application, used by PS
SPECIAL
Generally used for site specific server activities
SPECIAL_A
Generally used for site specific server activities
SPECIAL_B
Generally used for site specific server activities
SPECIAL_C
Generally used for site specific server activities
SPECIAL_D
Generally used for site specific server activities
STAGE
Generally used to stage media as part of a task
SUSPEND
Suspend a task
TRANSFER
Transfer a task (for example to another parent task)
UNASSIGN
Task assignment is cleared.
UPLOAD
Uploads files directly to file system or via a remote fileop.
TRANSCODE
A transcode is requested.
INVOKE_ADOBE_EXPORT
INVOKE_APPLE_FCP
INVOKE_ASSET_WEB_PAGE
INVOKE_ASSET_WEB_PAGE_FOLDER
INVOKE_ASSET_WEB_PAGE_FILES
INVOKE_ASSET_WEB_PAGE_LOGDATA
INVOKE_ASSET_WEB_PAGE_METADATA
INVOKE_ASSET_WEB_PAGE_RELATIONS
INVOKE_ASSET_WEB_PAGE_TASKS
INVOKE_VIZ_CAPTURE
INVOKE_VIZ_CAPTURE_OUTGEST
INVOKE_VIZ_CAPTURE_PLAYOUT
INVOKE_VIZ_EASYCUT
INVOKE_VIZ_MEDIALOGGER
PEER_INVOKE_VIZ_MEDIALOGGER
INVOKE_VIZ_PRECUT
INVOKE_VIZ_PREVIEW
INVOKE_VIZ_PRESEG
INVOKE_VIZ_IMPORTER
PEER_ADD_TO_ADOBE_PROJECT
Add peer asset media in Task to Project in Premiere Pro
PEER_IMPORT_INTO_ADOBE
Import peer asset media into an Adobe composition or project
PEER_LOAD_IN_ADOBE
Load peer asset task media into an Adobe application, used by PS
PEER_INVOKE_ASSET_WEB_PAGE
PEER_INVOKE_ASSET_WEB_PAGE_FOLDER
PEER_INVOKE_ASSET_WEB_PAGE_FILES
PEER_INVOKE_ASSET_WEB_PAGE_LOGDATA
PEER_INVOKE_ASSET_WEB_PAGE_METADATA
PEER_INVOKE_ASSET_WEB_PAGE_RELATIONS
PEER_INVOKE_ASSET_WEB_PAGE_TASKS
PEER_INVOKE_VIZ_EASYCUT
PEER_INVOKE_VIZ_PRECUT
INVOKE_VLC
REPORT
Report generation / request.
MULTI_INVOKE_VIZ_EASYCUT
SPLIT_VIEW
TASK_HISTORY
PRINT

Instructions

Most resources require the client to be authenticated using an API token. This can be set either as a cookie (TasksToken) or as a separate header (X-ApiToken). The prefered way of setting the cookie is by updating the client resource, which will log client versions for troubleshooting purposes and then set the cookie.

For each HTTP method of a resource, there is a section detailing the interaction. Below follows a brief description of each topic heading within.

Consumes
The media type of the request body of a POST or PUT. Specified as Content-Type header.
Produces
The media type of the response body. Specified as Accept header.
Path Parameters
Lists parameters that are part of the resource URL itself. For exampe, given asset-{type}-{id}, the bracketed names type and id correspond to parameters.
Body Parameters
Describes the request body.
Request Examples
Provides one or more request body examples.
Response
Describes the response body.
Request Examples
Provides one or more response body examples.
Response Codes
Lists HTTP return codes and their causes. When an error code is returned, a response body containing a stack trace is returned, even for requests that normally does not yield responses.

Media types found in Consumes and Produces are versioned. Clients should be made compatible with the latest possible version, but the server may retain compatibility with older versions.

The Path Parameters and Response headings link to data type descriptions. They correspond to four basic JSON types, described below. The category for each data type can be found in its heading, within parenthesis.

object
Described by a full list of named properties and their corresponding value types.
object{keyType : valueType}
Properties vary as much as the key type allows, each property sharing the same value type.
array[dataType]
An array where each item is of the same data type.
string
A string either specified by its format or by a list of valid values.
©2021 by Mayam AB. All rights reserved.