Equinor Uid API

openapi: 3.2.0
info:
  title: Equinor Uid API
  version: '1.0'
  description: 'Operations tagged Uid across 2 of this provider''s published API definitions: equinor-ims-export-subscriptions-openapi.yml, equinor-ims-metadata-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.gateway.equinor.com/plant/ims-subscriptions
- url: https://api-ncc.gateway.equinor.com/plant/ims-subscriptions
- url: https://api.gateway.equinor.com/plant/ims-metadata
- url: https://api-ncc.gateway.equinor.com/plant/ims-metadata
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Uid
paths:
  /uid:
    post:
      operationId: GetSubscriptionByUIds
      summary: Get a specific subscription by Multiple unique Id
      description: Get a specific subscription by Multiple unique Id.
      parameters:
      - name: destination
        in: query
        required: false
        description: The destination filter for subscriptions, default is all. (tsdb, datalake, all).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UidPostRequest'
            example:
            - uId: string
          text/json:
            schema:
              $ref: '#/components/schemas/UidPostRequest-1'
            example:
            - uId: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/UidPostRequest-2'
            example:
            - uId: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsCompleteDto'
              example:
                data:
                  items:
                  - uId: string
                    timeseriesId: string
                    name: string
                    plantSapCode: 0
                    plantStidCode: string
                    terminal: string
                    fieldId: string
                    createdBy: string
                    created: string
                    tsdbExportEnabled: true
                    tsdbBackfilled: true
                    tsdbEventsExported: 0
                    tsdbFirstExportedTime: string
                    tsdbLastExportedTime: string
                    dlExportEnabled: true
                    dlBackfilled: true
                    dlEventsExported: 0
                    dlFirstExportedTime: string
                    dlLastExportedTime: string
                    dlParquetFirstExportedTime: string
                    dlParquetLastExportedTime: string
                    sourceFirstCountedTime: string
                    sourceLastCountedTime: string
                    rtLastExpirationDate: string
                errors: {}
                continuationToken: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
      x-source: https://api.equinor.com/developer/apis/ims-export-subscriptions-v1-2/operations/GetSubscriptionByUIds?api-version=2022-04-01-preview
      tags:
      - Uid
    servers:
    - url: https://api.gateway.equinor.com/plant/ims-subscriptions
    - url: https://api-ncc.gateway.equinor.com/plant/ims-subscriptions
  /uid/{uId}:
    get:
      operationId: GetSubscriptionByUId
      summary: Get a specific subscription by unique Id
      description: Get a specific subscription by unique Id.
      parameters:
      - name: uId
        in: path
        required: true
        description: Unique Id from the IMS Metadata API
        schema:
          type: string
      - name: destination
        in: query
        required: false
        description: The destination filter for subscriptions, default is all. (tsdb, datalake, all).
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsCompleteDto'
              example:
                data:
                  items:
                  - uId: string
                    timeseriesId: string
                    name: string
                    plantSapCode: 0
                    plantStidCode: string
                    terminal: string
                    fieldId: string
                    createdBy: string
                    created: string
                    tsdbExportEnabled: true
                    tsdbBackfilled: true
                    tsdbEventsExported: 0
                    tsdbFirstExportedTime: string
                    tsdbLastExportedTime: string
                    dlExportEnabled: true
                    dlBackfilled: true
                    dlEventsExported: 0
                    dlFirstExportedTime: string
                    dlLastExportedTime: string
                    dlParquetFirstExportedTime: string
                    dlParquetLastExportedTime: string
                    sourceFirstCountedTime: string
                    sourceLastCountedTime: string
                    rtLastExpirationDate: string
                errors: {}
                continuationToken: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageModel'
              example:
                statusCode: 0
                message: string
                traceId: string
      x-source: https://api.equinor.com/developer/apis/ims-export-subscriptions-v1-2/operations/GetSubscriptionByUId?api-version=2022-04-01-preview
      tags:
      - Uid
    servers:
    - url: https://api.gateway.equinor.com/plant/ims-subscriptions
    - url: https://api-ncc.gateway.equinor.com/plant/ims-subscriptions
  /uid/{uid}:
    get:
      operationId: get-uid-uid
      summary: Gets a specific tag specified by tag unique identifier
      description: Gets a specific tag specified by tag unique identifier.
      parameters:
      - name: uid
        in: path
        required: true
        description: The unique identifier of the tag
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataItemResponse_v2'
              example:
                links:
                - relationship: string
                  reference: string
                data:
                  id: string
                  uid: string
                  imsType: string
                  systemCode: string
                  recordID: string
                  plantSAPCode: string
                  plantSTIDCode: string
                  denyDataShare: string
                  tag: string
                  terminal: string
                  isDefaultTerminal: true
                  description: string
                  engUnits: string
                  standardUnit: string
                  source: string
                  type: string
                  sourceTag: string
                  stepped: true
                  changeDate: string
                  creationDate: string
                  currentValueDate: string
                  plantArea: string
                  significantDigit: string
                  maxTimeInterval: string
                  fieldId: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
              example:
                statusCode: 0
                message: string
                traceId: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
              example:
                statusCode: 0
                message: string
                traceId: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
              example:
                statusCode: 0
                message: string
                traceId: string
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
              example:
                statusCode: 0
                message: string
                traceId: string
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
              example:
                statusCode: 0
                message: string
                traceId: string
      x-source: https://api.equinor.com/developer/apis/ims-metadata-api-v1-3/operations/get-uid-uid?api-version=2022-04-01-preview
      tags:
      - Uid
    servers:
    - url: https://api.gateway.equinor.com/plant/ims-metadata
    - url: https://api-ncc.gateway.equinor.com/plant/ims-metadata
components:
  schemas:
    SubscriptionCompleteItems:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SubscriptionCompleteModel'
      additionalProperties: false
    MessageModel:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        traceId:
          type:
          - string
          - 'null'
      additionalProperties: false
    UidPostRequest-1:
      type: array
      items:
        $ref: '#/components/schemas/SubscriptionSearchRequestModel'
      x-apim-inline: true
    UidPostRequest-2:
      type: array
      items:
        $ref: '#/components/schemas/SubscriptionSearchRequestModel'
      x-apim-inline: true
    SubscriptionsCompleteDto:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SubscriptionCompleteItems'
        errors:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        continuationToken:
          type:
          - string
          - 'null'
      additionalProperties: false
    UidPostRequest:
      type: array
      items:
        $ref: '#/components/schemas/SubscriptionSearchRequestModel'
      x-apim-inline: true
    SubscriptionCompleteModel:
      type: object
      properties:
        uId:
          type:
          - string
          - 'null'
        timeseriesId:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        plantSapCode:
          type:
          - integer
          - 'null'
          format: int32
        plantStidCode:
          type:
          - string
          - 'null'
        terminal:
          type:
          - string
          - 'null'
        fieldId:
          type:
          - string
          - 'null'
        createdBy:
          type:
          - string
          - 'null'
        created:
          type: string
          format: date-time
        tsdbExportEnabled:
          type: boolean
        tsdbBackfilled:
          type: boolean
        tsdbEventsExported:
          type: integer
          format: int64
        tsdbFirstExportedTime:
          type:
          - string
          - 'null'
          format: date-time
        tsdbLastExportedTime:
          type:
          - string
          - 'null'
          format: date-time
        dlExportEnabled:
          type: boolean
        dlBackfilled:
          type: boolean
        dlEventsExported:
          type: integer
          format: int64
        dlFirstExportedTime:
          type:
          - string
          - 'null'
          format: date-time
        dlLastExportedTime:
          type:
          - string
          - 'null'
          format: date-time
        dlParquetFirstExportedTime:
          type:
          - string
          - 'null'
          format: date-time
        dlParquetLastExportedTime:
          type:
          - string
          - 'null'
          format: date-time
        sourceFirstCountedTime:
          type:
          - string
          - 'null'
          format: date-time
        sourceLastCountedTime:
          type:
          - string
          - 'null'
          format: date-time
        rtLastExpirationDate:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    SubscriptionSearchRequestModel:
      type: object
      properties:
        uId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ErrorDetails:
      type: object
      properties:
        statusCode:
          type: integer
          description: The HTTP status code
          format: int32
        message:
          type:
          - string
          - 'null'
          description: The error message
        traceId:
          type:
          - string
          - 'null'
          description: Trace ID that can be used by support to determine root cause
      additionalProperties: false
      description: Describes the error returned by the server
    Hyperlink:
      type: object
      properties:
        relationship:
          type:
          - string
          - 'null'
          description: The relationship the current resource has to the reference resource
        reference:
          type:
          - string
          - 'null'
          description: The reference resource hyperlink
          format: uri
      additionalProperties: false
      description: Holds a hyperlink to a resource and what relationship the current resource has to it
    MetadataItem_v2:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: SHA1 hash of the UId
        uid:
          type:
          - string
          - 'null'
          description: A unique id of the tag (plant + a counter)
        imsType:
          type:
          - string
          - 'null'
          description: The type of this IMS tag
        systemCode:
          type:
          - string
          - 'null'
          description: The name of the IMS System
        recordID:
          type:
          - string
          - 'null'
          description: The ID of the record from the IMS system
        plantSAPCode:
          type:
          - string
          - 'null'
          description: The SAP code of the plant
        plantSTIDCode:
          type:
          - string
          - 'null'
          description: The STID code of the plant
        denyDataShare:
          type:
          - string
          - 'null'
          description: Reason for denied access where null means access allowed
        tag:
          type:
          - string
          - 'null'
          description: The name of the tag
        terminal:
          type:
          - string
          - 'null'
          description: The name of the terminal
        isDefaultTerminal:
          type:
          - boolean
          - 'null'
          description: Is the terminal default
        description:
          type:
          - string
          - 'null'
          description: The description of the tag
        engUnits:
          type:
          - string
          - 'null'
          description: The measurement unit of the tag in English
        standardUnit:
          type:
          - string
          - 'null'
          description: The standard unit of measurement from commonlib
        source:
          type:
          - string
          - 'null'
          description: The source of the data
        type:
          type:
          - string
          - 'null'
          description: The type of the signal data
        sourceTag:
          type:
          - string
          - 'null'
          description: The original tag name if the signal data comes from another tag
        stepped:
          type:
          - boolean
          - 'null'
          description: Whether or not the signal data is stepped or raw
        changeDate:
          type:
          - string
          - 'null'
          description: The date/time when this tag was last changed
          format: date-time
        creationDate:
          type:
          - string
          - 'null'
          description: The date/time when this tag was created
          format: date-time
        currentValueDate:
          type:
          - string
          - 'null'
          description: The date/time of the last/current value of the tag
          format: date-time
        plantArea:
          type:
          - string
          - 'null'
          description: The area of the plant
        significantDigit:
          type:
          - string
          - 'null'
          description: A string specifying the significant digits of the data-points
        maxTimeInterval:
          type:
          - string
          - 'null'
          description: The maximum time interval in which the data-points are valid
        fieldId:
          type:
          - string
          - 'null'
          description: The field ID
      additionalProperties: false
      description: The metadata information of a tag
    MetadataItemResponse_v2:
      type: object
      properties:
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlink'
          description: Links that can be used to get related resources
        data:
          $ref: '#/components/schemas/MetadataItem_v2'
      additionalProperties: false
      description: Metadata list response model
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: sub
      in: header
    apiKeyQuery:
      type: apiKey
      name: sub
      in: query
x-refined-from:
- equinor-ims-export-subscriptions-openapi.yml
- equinor-ims-metadata-openapi.yml