Job

Job API

Returns queued jobs that match search criteria

Search for jobs

query Parameters
organization
Array of strings

Organization Id

providerId
string

Provider Id

userId
string

User ID

status
Array of strings
Items Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"

Job status filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getJob

Get job

path Parameters
jobId
required
integer <int64>

Job id

query Parameters
organization
Array of strings

Organization Id

providerId
string

Provider Id

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Audit

Audit API

Get audit events

Returns audit events as a page

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service provider Id

required
object (AuditEventSearch)
Example: eventSearch={ "userId": "11AB423", "userName": "user", "from": 1687851558774, "to": 97851558774, "service": "ACCOUNTS", "operation": "LOGIN", "result": "SUCCESS" + }

Search data

required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "size": 0,
  • "sort": {
    },
  • "totalElements": 0,
  • "totalPages": 0
}

Get audit events

Returns audit events as a page

query Parameters
organization
Array of strings

Organization Id

providerId
string

Service provider Id

required
object (Pageable)
Request Body schema: application/json
required
from
string <date-time>

From date, in MS

includeSystemEvents
boolean

Include system events

message
string

Message of the audit action

objectId
string

Id of the object in the audit log

objectName
string

Name of the object in the audit log

objectType
string (ObjectType)
Enum: "CHANNEL" "SCHEDULE" "QUEUE_OBJECT" "PLAYOUT" "ASSET" "INGEST_SOURCE" "MEDIA_STORE" "USER" "ORGANIZATION" "RESOURCE_PACK" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SECURITY_ROLE" "SECONDARY_EVENT_TEMPLATE" "MONITORING_EVENT" "COMPLIANCE_RECORDING" "CLOUD_CONFIGURATION" "BLOCK" "HLS_STEERING"

Type of the object in the audit log

operation
string

Operation of the audit action

result
string (ActionResult)
Enum: "SUCCESS" "SUCCESS_WITH_WARNING" "FAILED"

Result of the audit action

service
string (ServiceType)
Enum: "NIMBUS" "CIRRUS" "STRATUS" "CHANNEL" "INGEST" "LISTING" "AUDIT" "SCHEDULE" "PLAYOUT_MGMT" "METRICS_SERVICE" "CONFIGURATION" "ACCOUNTS" "LIBRARY" "MONITORING"

Service type

to
string <date-time>

To date, in MS

userId
string

User id

userName
string

User name

Responses

Request samples

Content type
application/json
"{\n \"userId\": \"11AB423\",\n \"userName\": \"user\",\n \"from\": 1687851558774,\n \"to\": \u000e97851558774,\n \"service\": \"ACCOUNTS\",\n \"operation\": \"LOGIN\",\n \"result\": \"SUCCESS\" +\n}"

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "size": 0,
  • "sort": {
    },
  • "totalElements": 0,
  • "totalPages": 0
}

exportEvents

Event search export , Returns CSV file of events according to specified search and sorting parameters

query Parameters
organization
Array of strings

Organization Id

providerId
string

Provider Id

sort
any

Properties that should be sorted by in the format property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc

Request Body schema: application/json
required
object (AuditExportSearch)
object (Sort)

Responses

Request samples

Content type
application/json
{
  • "search": {
    },
  • "sort": {
    }
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Download run as log (url or data) CSV file , Returns CSV file containing run as log

path Parameters
fileName
required
string

File name

query Parameters
organization
Array of strings

Organization Id

providerId
string

ProviderId Id

Responses

Response samples

Content type
{ }