Transformation Notifications

Transformation notifications let users know when a job fails if subscribed.

List notification subscriptions

Required capabilities: transformationsAcl:READ

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
transformationId
integer <int32>

List only notifications for the specified transformation. The transformation is identified by ID.

transformationExternalId
string

List only notifications for the specified transformation. The transformation is identified by external ID.

destination
string

Filter by notification destination.

limit
integer <int32> [ 1 .. 1000 ]

Limits the number of results to be returned. The maximum is 1000, default limit is 100.

cursor
string

Cursor for paging through results.

Responses
200

Response with paged list of notification subscriptions.

400

The response for a failed request.

403

The response for a forbidden request.

get/transformations/notifications
Request samples
notifications_list = client.transformations.notifications.list()

notifications_list = client.transformations.notifications.list(transformation_id = 1)
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Subscribe for notifications

Required capabilities: transformationsAcl:WRITE

Subscribe for notifications on the transformation errors.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of the notifications for new subscriptions. Must be up to a maximum of 1000 items.

Array of NotificationCreateWithExternalId (object) or NotificationCreateWithId (object) <= 1000 items
Responses
200

Response with list of created notification subscriptions.

400

The response for a failed request.

403

The response for a forbidden request.

409

The response for a conflict.

post/transformations/notifications
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete notification subscriptions by notification ID

Required capabilities: transformationsAcl:WRITE

Deletes the specified notification subscriptions on the transformation. Requests to delete non-existing subscriptions do nothing, but do not throw an error.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of IDs to be deleted.

Array of objects (TransformationCogniteInternalId)
Responses
200

Empty response.

400

The response for a failed request.

403

The response for a forbidden request.

409

The response for a conflict.

post/transformations/notifications/delete
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{ }