Cognite SVG Data API

openapi: 3.2.0
info:
  title: Cognite SVG Data 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: SVG Data
paths:
  /diagram-parsing/svg-data/diagram/{diagramId}:
    get:
      tags:
      - SVG Data
      summary: Get SVG data by diagramId
      description: '> **Required capabilities:** `diagramParsingAcl:READ` `dataModelInstancesAcl:READ`


        Get the SVG data of a file by externalId of a diagram.'
      operationId: getSVGDataByDiagramId
      parameters:
      - $ref: '#/components/parameters/diagramIdPath'
      x-capability:
      - diagramParsingAcl:READ
      - dataModelInstancesAcl:READ
      responses:
        '200':
          $ref: '#/components/responses/GetSVGDataResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/svg-data/file/{fileSpace}/{fileExternalId}/{pageNumber}:
    get:
      tags:
      - SVG Data
      summary: Get SVG data by file reference
      description: '> **Required capabilities:** `diagramParsingAcl:READ` `dataModelInstancesAcl:READ`


        Get the SVG data of a file by file instanceId and pageNumber.'
      operationId: getSVGDataByDocument
      parameters:
      - $ref: '#/components/parameters/fileSpace'
      - $ref: '#/components/parameters/fileExternalId'
      - $ref: '#/components/parameters/pageNumber'
      x-capability:
      - diagramParsingAcl:READ
      - dataModelInstancesAcl:READ
      responses:
        '200':
          $ref: '#/components/responses/GetSVGDataResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    diagramIdPath:
      name: diagramId
      description: External ID of a diagram
      required: true
      in: path
      schema:
        $ref: '#/components/schemas/CogniteExternalId'
    pageNumber:
      name: pageNumber
      description: The file's page number
      required: true
      in: path
      schema:
        type: integer
    fileExternalId:
      name: fileExternalId
      description: Retrieve data related to a file
      required: true
      in: path
      schema:
        type: string
    fileSpace:
      name: fileSpace
      description: A DMS space where the files reside
      required: true
      in: path
      schema:
        type: string
  schemas:
    Path:
      description: SVG path in a custom format
      type: object
      required:
      - id
      - d
      properties:
        id:
          type: string
        d:
          description: The d attribute of an SVG path
          type: string
        styleId:
          description: The id of the style used for this path
          type: string
    SvgData:
      description: SVG data extracted for a file.
      type: object
      required:
      - height
      - paths
      - pathStyles
      - viewBox
      - width
      properties:
        height:
          description: Height attribute of the SVG diagram
          type: number
        paths:
          $ref: '#/components/schemas/PathsDict'
        pathStyles:
          $ref: '#/components/schemas/PathStylesDict'
        viewBox:
          description: ViewBox attribute of the SVG diagram
          type: string
        width:
          description: Width attribute of the SVG diagram
          type: number
    Error:
      type: object
      required:
      - code
      - message
      description: Cognite API error.
      properties:
        code:
          type: integer
          description: HTTP status code.
          format: int32
          example: 401
        message:
          type: string
          description: Error message.
          example: Could not authenticate.
        missing:
          type: array
          description: List of lookup objects that do not match any results.
          items:
            type: object
            additionalProperties: true
        duplicated:
          type: array
          description: List of objects that are not unique.
          items:
            type: object
            additionalProperties: true
    PathsDict:
      description: Map representation of paths
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Path'
    PathStylesDict:
      description: Map linking styleIds to SVG path style properties
      type: object
      additionalProperties:
        $ref: '#/components/schemas/PathStyle'
    PathStyle:
      description: Representation of an SVG path style attribute
      type: object
      required: []
      properties:
        fill:
          type: string
        fillOpacity:
          type: string
        fillRule:
          type: string
          enum:
          - nonzero
          - evenodd
          default: nonzero
        stroke:
          type: string
        strokeDasharray:
          type: string
        strokeDashoffset:
          type: string
        strokeLinecap:
          type: string
          enum:
          - butt
          - round
          - square
          default: butt
        strokeLinejoin:
          type: string
          enum:
          - bevel
          - miter
          - round
          default: miter
        strokeMiterlimit:
          type: string
        strokeOpacity:
          type: string
        strokeWidth:
          type: string
    CogniteExternalId:
      description: The external ID provided by the client. Must be unique for the resource type.
      type: string
      maxLength: 255
      example: my.known.id
  responses:
    GetSVGDataResponse:
      description: The SVG data for a file
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SvgData'
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
  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:
  - ''