How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Transformations API

Transformations enable users to use Spark SQL queries to transformdata from the CDF staging area, RAW, into the CDF data model.### Concurrency limitsThe number of concurrent (parallel) jobs are governed by limits. If a request exceeds one of the limits,the job fails to run. This limitation also applies to scheduled transformations.The limits for the transformation service are described in the table below. Note that under high load,some deviation from the limits might occur for short periods as the service scales up.| Limit | Per project ||-----------------------|-----------------------|| Concurrency | 10 parallel jobs |

Cognite Transformations API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transformation. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 7 paths, and defines 54 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

8 operations 7 paths 54 schemas 1 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Transformations API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — 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 acce…
  • oauth2-client-credentials — 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 acce…
  • oauth2-auth-code — 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 acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — 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 obtain…

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Transformations 8

Transformations enable users to use Spark SQL queries to transform data from the CDF staging area, RAW, into the CDF data model. Concurrency limits The number of concurrent (paral…

GET
/transformations
List transformations
getTransformations 4 params → 200400403
POST
/transformations
Create transformations
createTransformations body → 200400403409
POST
/transformations/byids
Retrieve transformations
getTransformationsByIds body → 200400403409
POST
/transformations/filter
Filter transformations
filterTransformations body → 200400403
POST
/transformations/delete
Delete transformations
deleteTransformations body → 200400403409
POST
/transformations/update
Update transformations
updateTransformations body → 200400403409
POST
/transformations/run
Run a transformation
runTransformation body → 200400403
POST
/transformations/cancel
Cancel a transformation
postApiV1ProjectsProjectTransformationsCancel body → 200400403

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are TransformationRead (22 properties), JobRead (16 properties), TransformationCreate (13 properties), TransformationUpdate (13 properties). Each schema is shown below with its type and property counts.

UpdateItemWithId_TransformationUpdate
object
2 properties 2 required
SetValue_DataSource
object
Set a new value for the transformation destination type. Indicates result resource type.
1 property 1 required
SetNull_NonceCredentials
object
1 property 1 required
Items_TransformationCreate
object
1 property
Items_UpdateItem_TransformationUpdate
object
1 property
ItemsWithCursor_TransformationRead
object
Array of objects (Transformation).
2 properties
RawDataSource
object
3 properties 3 required
FlatOidcCredentialsUpdate
object
6 properties
FlatOidcCredentials
object
6 properties 4 required
TransformationJobStatus
string
Status of the job at the request time.
SetBooleanField
object
1 property 1 required
UpdateArray_String
object
2 properties
TransformationCogniteExternalId
object
1 property 1 required
CogniteIntId
object
A server-generated ID for the object.
1 property 1 required
ViewInfo
object
Target view info
3 properties 3 required
DataModelSource
object
4 properties 2 required
SetExternalId
object
1 property 1 required
UpdateItemWithExternalId_TransformationUpdate
object
2 properties 2 required
TransformBlockedInfo
object
Provides reason and time if the transformation is blocked.
2 properties 2 required
TransformationAdvancedList
object
3 properties 1 required
Schedule
object
Details for the schedule if the transformation is scheduled
6 properties 6 required
SetValue_Long
object
1 property 1 required
SetStringField
object
1 property 1 required
DataModelInfo
object
Target data model info
5 properties 4 required
ContainsAny
object
1 property
NonceCredentials
object
Credentials for a CDF session (sessionId, nonce, and project name). These are obtained when you create a session via the Sessions API. See [Sessions API](tag/S…
4 properties 3 required
EdgeType
object
Target type of the connection definition
2 properties 2 required
AssetCentricDataSource
object
1 property 1 required
JobRead
object
Details for the last finished job of this transformation
16 properties 12 required
SetValue_Seq_String
object
1 property
TransformationRead
object
22 properties 14 required
TransformationCogniteInternalId
object
1 property 1 required
MinMax
object
Range between two timestamps (inclusive).
2 properties
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
SetNull_FlatOidcCredentialsUpdate
object
1 property 1 required
TransformationFilter
object
11 properties
CronValue
string
Cron expression describes when the job should run.
TransformationRunWithId
object
2 properties 1 required
CogniteExtId
object
The external ID provided by the client. Must be unique for the resource type.
1 property 1 required
SetNull_Long
object
1 property 1 required
SetValue_NonceCredentials
object
1 property 1 required
TransformationCreate
object
13 properties 3 required
SessionInfo
object
Details for the session used to read from the source project.
3 properties
SetValue_FlatOidcCredentialsUpdate
object
1 property 1 required
ItemsWithByIdsFlags_CogniteId
object
All provided IDs and external IDs must be unique.
3 properties 1 required
SequenceRowDataSource
object
2 properties 2 required
SetValue_ConflictMode
object
Set a new value for the transformation conflictMode (action).
1 property 1 required
ItemsWithIgnoreUnknownIds_CogniteId
object
All provided IDs and external IDs must be unique.
2 properties
TransformationRunWithExternalId
object
2 properties 1 required
ConflictMode
string
Behavior when the data already exists.upsert - Create or Update,abort - Create and fail when already exists,update - update and fail if it does not exist,delet…
ViewDataSource
object
5 properties 1 required
AutoCreateOptions
object
Options to control the automatic creation of related instances when writing to data models. By default, all options are true.
3 properties
TransformationUpdate
object
13 properties
Items_TransformationRead
object
Array of objects (Transformation).
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-transformations-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Transformations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.