Audit
Download OpenAPI specification:Download
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
- 200
- 400
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": [
- {
- "message": "string",
- "type": "OK"
}
], - "organization": "string",
- "resourceExtension": "string",
- "resourceLink": "string",
- "serviceProviderId": "string",
- "status": "PENDING",
- "uniqueId": "string",
- "userId": "string"
}
]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
- 200
- 400
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": [
- {
- "message": "string",
- "type": "OK"
}
], - "organization": "string",
- "resourceExtension": "string",
- "resourceLink": "string",
- "serviceProviderId": "string",
- "status": "PENDING",
- "uniqueId": "string",
- "userId": "string"
}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
- 200
- 400
Content type
application/json
{- "content": [
- {
- "data": "string",
- "eventTimeStamp": "2019-08-24T14:15:22Z",
- "executionDuration": 0,
- "id": "string",
- "messages": [
- {
- "message": "string",
- "type": "OK"
}
], - "objectId": "string",
- "objectName": "string",
- "objectType": "CHANNEL",
- "operation": "string",
- "organizationId": "string",
- "result": "SUCCESS",
- "service": "NIMBUS",
- "serviceProviderId": "string",
- "superAdmin": true,
- "userId": "string",
- "userName": "string"
}
], - "empty": true,
- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "pageable": {
- "offset": 0,
- "pageNumber": 0,
- "pageSize": 0,
- "paged": true,
- "sort": [
- {
- "ascending": true,
- "direction": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "property": "string"
}
], - "unpaged": true
}, - "size": 0,
- "sort": [
- {
- "ascending": true,
- "direction": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "property": "string"
}
], - "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/jsonrequired
| 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
- Payload
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
- 200
- 400
Content type
application/json
{- "content": [
- {
- "data": "string",
- "eventTimeStamp": "2019-08-24T14:15:22Z",
- "executionDuration": 0,
- "id": "string",
- "messages": [
- {
- "message": "string",
- "type": "OK"
}
], - "objectId": "string",
- "objectName": "string",
- "objectType": "CHANNEL",
- "operation": "string",
- "organizationId": "string",
- "result": "SUCCESS",
- "service": "NIMBUS",
- "serviceProviderId": "string",
- "superAdmin": true,
- "userId": "string",
- "userName": "string"
}
], - "empty": true,
- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "pageable": {
- "offset": 0,
- "pageNumber": 0,
- "pageSize": 0,
- "paged": true,
- "sort": [
- {
- "ascending": true,
- "direction": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "property": "string"
}
], - "unpaged": true
}, - "size": 0,
- "sort": [
- {
- "ascending": true,
- "direction": "string",
- "ignoreCase": true,
- "nullHandling": "string",
- "property": "string"
}
], - "totalElements": 0,
- "totalPages": 0
}exportEvents
Event search export , Returns CSV file of events according to specified search and sorting parameters
query Parameters
required | Array of objects (SortObject) 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 |
| organization | Array of strings Organization Id |
| providerId | string Provider Id |
Request Body schema: application/jsonrequired
object Object containing required fields and their names: {'name': 'Asset Name', 'metadata.fps': 'FPS'} | |
| fieldOrder | Array of strings List containing required fields in specified order |
| 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
- Payload
Content type
application/json
{- "fieldNames": {
- "property1": "string",
- "property2": "string"
}, - "fieldOrder": [
- "string"
], - "from": "2019-08-24T14:15:22Z",
- "includeSystemEvents": true,
- "message": "Playlist applied",
- "objectId": "11AB423",
- "objectName": "user",
- "objectType": "CHANNEL",
- "operation": "LOGIN",
- "result": "SUCCESS",
- "service": "ACCOUNTS",
- "to": "2019-08-24T14:15:22Z",
- "userId": "11AB423",
- "userName": "user"
}Response samples
- 200
- 400
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": [
- {
- "message": "string",
- "type": "OK"
}
], - "organization": "string",
- "resourceExtension": "string",
- "resourceLink": "string",
- "serviceProviderId": "string",
- "status": "PENDING",
- "uniqueId": "string",
- "userId": "string"
}