API docs by Redocly

Unit Catalog API (0.1.0)

Download OpenAPI specification:Download

Unit Catalog API

Units API provides an standardized list of units that can be used in Cognite Data Fusion. The content this API will serve is based on the CDF Units Catalog.

Units

Retrieve Units By Ids

Retrieve units

header Parameters
cdf-version
string (Cdf-Version)
Examples: alpha beta
X-Cdp-App (string) or X-Cdp-App (null) (X-Cdp-App)
Examples: cdf-test-app

A name of the API client

Request Body schema: application/json
required
required
Array of objects (Items)
Ignoreunknownids (boolean) or Ignoreunknownids (null) (Ignoreunknownids)
Default: false

Ignore IDs and external IDs that are not found

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "ignoreUnknownIds": false
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

List Unit Systems

Get all systems

header Parameters
cdf-version
string (Cdf-Version)
Examples: alpha beta
X-Cdp-App (string) or X-Cdp-App (null) (X-Cdp-App)
Examples: cdf-test-app

A name of the API client

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Unit By External Id

Retrieve unit by externalId

path Parameters
external_id
required
string (External Id)
header Parameters
cdf-version
string (Cdf-Version)
Examples: alpha beta
X-Cdp-App (string) or X-Cdp-App (null) (X-Cdp-App)
Examples: cdf-test-app

A name of the API client

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

List Units

List all the available units in the units-catalog repository.

header Parameters
cdf-version
string (Cdf-Version)
Examples: alpha beta
X-Cdp-App (string) or X-Cdp-App (null) (X-Cdp-App)
Examples: cdf-test-app

A name of the API client

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}