Cognite Transformation Notifications API

openapi: 3.2.0
info:
  title: Cognite Transformation Notifications API
  description: '# Introduction

    This is the reference documentation for the Cognite API with

    an overview of all the available methods.'
  version: v1
  contact:
    name: Cognite Support
    url: https://support.cognite.com
    email: support@cognite.com
servers:
- url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
  description: The URL for the CDF cluster to connect to
  variables:
    cluster:
      enum:
      - api
      - az-tyo-gp-001
      - az-eastus-1
      - az-power-no-northeurope
      - westeurope-1
      - asia-northeast1-1
      - gc-dsm-gp-001
      default: api
      description: The CDF cluster to connect to
    project:
      default: publicdata
      description: The CDF project name.
security:
- oidc-token:
  - https://{cluster}.cognitedata.com/.default
- oauth2-client-credentials:
  - https://{cluster}.cognitedata.com/.default
- oauth2-open-industrial-data:
  - https://api.cognitedata.com/.default
- oauth2-auth-code:
  - https://{cluster}.cognitedata.com/.default
tags:
- name: Transformation Notifications
  description: Transformation notifications let users know when a job fails if subscribed.
paths:
  /transformations/notifications:
    get:
      tags:
      - Transformation Notifications
      summary: List notification subscriptions
      operationId: getTransformationNotifications
      parameters:
      - name: transformationId
        in: query
        description: List only notifications for the specified transformation. The transformation is identified by ID.
        required: false
        schema:
          type: integer
          format: int32
      - name: transformationExternalId
        in: query
        description: List only notifications for the specified transformation. The transformation is identified by external ID.
        required: false
        schema:
          type: string
      - name: destination
        in: query
        description: Filter by notification destination.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Limits the number of results to be returned. The maximum is 1000, default limit is 100.
        required: false
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
      - name: cursor
        in: query
        description: Cursor for paging through results.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Response with paged list of notification subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsWithCursor_NotificationRead'
        '400':
          description: The response for a failed request.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
        '403':
          description: The response for a forbidden request.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
      x-capability: transformationsAcl:READ
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: 'notifications_list = client.transformations.notifications.list()


          notifications_list = client.transformations.notifications.list(transformation_id = 1)

          '
      - lang: Java
        label: Java SDK
        source: "Iterator<List<Transformation.Notification>> itNotifications =   \n          client.transformations().notifications().list();\n\n"
      description: '> **Required capabilities:** `transformationsAcl:READ`'
    post:
      tags:
      - Transformation Notifications
      summary: Subscribe for notifications
      description: '> **Required capabilities:** `transformationsAcl:WRITE`


        Subscribe for notifications on the transformation errors.'
      operationId: createTransformationNotifications
      requestBody:
        description: List of the notifications for new subscriptions. Must be up to a maximum of 1000 items.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Items_NotificationCreate'
        required: true
      responses:
        '200':
          description: Response with list of created notification subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Items_NotificationRead'
        '400':
          description: The response for a failed request.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
        '403':
          description: The response for a forbidden request.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
        '409':
          description: The response for a conflict.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
      x-capability: transformationsAcl:WRITE
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: 'from cognite.client.data_classes import TransformationNotification

          notifications = [TransformationNotification(transformation_id = 1, destination="my@email.com"), TransformationNotification(transformation_external_id="transformation2", destination="other@email.com"))]

          res = client.transformations.notifications.create(notifications)

          '
      - lang: Java
        label: Java SDK
        source: "List<Transformation.Notification.Subscription> subscribes =  \n          List.of(Transformation.Notification.Subscription.newBuilder()  \n          .setDestination(\"test@test.com\")  \n          .setTransformationId(10)  \n          .build());\nList<Transformation.Notification> createdSubscribes =  \n          client.transformations().notifications().subscribe(subscribes);\n\n"
  /transformations/notifications/delete:
    post:
      tags:
      - Transformation Notifications
      summary: Delete notification subscriptions by notification ID
      description: '> **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.'
      operationId: deleteTransformationNotifications
      requestBody:
        description: List of IDs to be deleted.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Items_CogniteInternalId'
        required: true
      responses:
        '200':
          description: Empty response.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: The response for a failed request.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
        '403':
          description: The response for a forbidden request.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
        '409':
          description: The response for a conflict.
          content:
            application/json:
              schema:
                required:
                - error
                type: object
                properties:
                  error:
                    required:
                    - code
                    - message
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code.
                      message:
                        type: string
                        description: Error message.
                      missing:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of lookup objects that do not match any results.
                      duplicated:
                        type: array
                        items:
                          oneOf:
                          - $ref: '#/components/schemas/TransformationCogniteExternalId'
                          - $ref: '#/components/schemas/TransformationCogniteInternalId'
                        description: List of objects that are not unique.
      x-capability: transformationsAcl:WRITE
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: 'client.transformations.notifications.delete(id=[1,2,3])

          '
      - lang: Java
        label: Java SDK
        source: "List<Item> deleteNotification = List.of(Item.newBuilder()  \n          .setId(10)  \n          .build());\nList<Item> deletedItems =   \n          client.transformations().notifications().delete(deleteNotification);\n\n"
components:
  schemas:
    Items_NotificationRead:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/NotificationRead'
    NotificationCreateWithId:
      required:
      - destination
      - transformationId
      type: object
      properties:
        destination:
          type: string
          description: Email address where notifications should be sent.
        transformationId:
          type: integer
          description: Transformation ID to subscribe.
          format: int32
    Items_CogniteInternalId:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TransformationCogniteInternalId'
    Items_NotificationCreate:
      type: object
      properties:
        items:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/NotificationCreateWithExternalId'
            - $ref: '#/components/schemas/NotificationCreateWithId'
          maxItems: 1000
    NotificationRead:
      required:
      - id
      - createdTime
      - lastUpdatedTime
      - transformationId
      - destination
      type: object
      properties:
        id:
          type: integer
          description: Id of the notification subscription. Required for deleting the subscription.
          format: int32
        createdTime:
          type: integer
          description: 'Time when the notification subscription was created: The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.'
          format: int64
        lastUpdatedTime:
          type: integer
          description: 'Time when the notification subscription was last updated: The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.'
          format: int64
        transformationId:
          type: integer
          description: Id of the transformation for which the notifications are sent.
          format: int32
        destination:
          type: string
          description: Email address where notifications should be sent.
    TransformationCogniteExternalId:
      required:
      - externalId
      type: object
      properties:
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
    ItemsWithCursor_NotificationRead:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/NotificationRead'
        nextCursor:
          type: string
          description: Cursor to get the next page of results (if available).
    CogniteExternalId:
      description: The external ID provided by the client. Must be unique for the resource type.
      type: string
      maxLength: 255
      example: my.known.id
    NotificationCreateWithExternalId:
      required:
      - destination
      - transformationExternalId
      type: object
      properties:
        destination:
          type: string
          description: Email address where notifications should be sent.
        transformationExternalId:
          type: string
          description: Transformation external ID to subscribe.
    TransformationCogniteInternalId:
      required:
      - id
      type: object
      properties:
        id:
          type: integer
          description: A server-generated ID for the object.
          format: int32
  securitySchemes:
    oidc-token:
      type: http
      scheme: bearer
      bearerFormat: OpenID Connect or OAuth2 token
      description: Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
    oauth2-client-credentials:
      type: oauth2
      description: Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
      flows:
        clientCredentials:
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-auth-code:
      type: oauth2
      description: Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
      flows:
        authorizationCode:
          authorizationUrl: https://your-idps.authorization.url/
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-open-industrial-data:
      type: oauth2
      description: Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token
          scopes:
            default: https://api.cognitedata.com/.default
    org-oidc-token:
      type: openIdConnect
      openIdConnectUrl: https://auth.cognite.com/.well-known/openid-configuration
      description: 'Access token issued by the Cognite authorization server, and valid for the target organization. The token must

        be an OpenID Connect token, and it can be obtained by performing an OIDC login flow toward `auth.cognite.com`.

        This is a single URL for all CDF organizations.'
x-tagGroups:
- name: Changelog
  tags:
  - Changelog
- name: Organizations and projects
  tags:
  - Organizations
  - Projects
- name: Identity and access management
  tags:
  - Principals
  - Groups
  - Security categories
  - Sessions
  - Token
  - User profiles
  - Project Deletion Reporting
- name: Data modeling
  tags:
  - Data Modeling
  - Data models
  - Spaces
  - Views
  - Containers
  - Nodes
  - Instances
  - Statistics
  - Streams
  - Records
- name: Asset-centric data model
  tags:
  - Assets
  - Time series
  - Synthetic Time Series
  - Data point subscriptions
  - Events
  - Files
  - Sequences
  - Geospatial
  - Seismic
- name: 3D
  tags:
  - 3D Models
  - 3D Model Revisions
  - 3D Files
  - 3D Asset Mapping
  - 3D Contextualization
  - 3D Jobs
  - 3D Migration
  - 3D Scenes
- name: Contextualization
  tags:
  - Entity matching
  - Entity matching pipelines
  - Engineering diagrams
  - Vision
  - Advanced joins
- name: Cognite AI
  tags:
  - Agents
  - Skills
  - Chat Completions
  - Document AI
  - Models
- name: Documents
  tags:
  - Documents
  - Document preview
- name: Data ingestion
  tags:
  - Raw
  - Extraction Pipelines
  - Extraction Pipelines Runs
  - Extraction Pipelines Config
  - Extractors
- name: Data organization
  tags:
  - Data sets
  - Data domains
  - Data products
  - Rule sets
  - Labels
  - Relationships
  - Annotations
- name: Transformations
  tags:
  - Transformations
  - Transformation Jobs
  - Transformation Schedules
  - Transformation Notifications
  - Query
  - Schema
- name: Functions
  tags:
  - Functions
  - Function calls
  - Function schedules
- name: Hosted Extractors
  tags:
  - Sources
  - Jobs
  - Destinations
  - Mappings
- name: PostgreSQL Gateway
  tags:
  - Postgres Gateway Users
  - Postgres Gateway Tables
- name: SAP Writeback
  tags:
  - SAP Instances
  - SAP Endpoints
  - Schema Mappings
  - Writeback Requests
- name: Data workflows
  tags:
  - Workflows
  - Workflow versions
  - Workflow executions
  - Workflow triggers
  - Tasks
  - Workers
- name: Simulators
  tags:
  - Simulators
  - Simulator Integrations
  - Simulator Models
  - Simulator Routines
  - Simulation Runs
  - Simulator Logs
- name: Units
  tags:
  - Units
  - Unit Systems
- name: ''
  tags:
  - ''