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 Transformation Schedules API

Transformation schedules allow you to run transformations with a specific input at intervals defined by a cron expression. These transformation jobs will be asynchronous and show up in the transformation job list. Visit http://www.cronmaker.com to generate a cron expression with a UI.

Cognite Transformation Schedules 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 Schedules. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 16 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}.

5 operations 4 paths 16 schemas 1 GET4 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 Transformation Schedules 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 5

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

Transformation Schedules 5

Transformation schedules allow you to run transformations with a specific input at intervals defined by a cron expression. These transformation jobs will be asynchronous and show…

GET
/transformations/schedules
List all schedules
getTransformationSchedules 3 params → 200400403409
POST
/transformations/schedules
Schedule transformations
createTransformationSchedules body → 201400403409
POST
/transformations/schedules/byids
Retrieve schedules
getTransformationSchedulesByIds body → 200400403409
POST
/transformations/schedules/delete
Unschedule transformations
deleteTransformationSchedules body → 200400403409
POST
/transformations/schedules/update
Update schedules
updateTransformationSchedules body → 200400403409

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Schedule (6 properties), ScheduleParametersWithExternalId (3 properties), ScheduleParametersWithId (3 properties), ScheduleUpdate (2 properties). Each schema is shown below with its type and property counts.

UpdateItemWithExternalId_ScheduleUpdate
object
2 properties 2 required
ScheduleParametersWithId
object
3 properties 2 required
ScheduleUpdate
object
2 properties
ItemsWithIgnoreUnknownIds_CogniteId
object
All provided IDs and external IDs must be unique.
2 properties
Items_ScheduleParameters
object
1 property
ScheduleParametersWithExternalId
object
3 properties 2 required
Items_Schedule
object
1 property
ItemsWithCursor_Schedule
object
2 properties
TransformationCogniteInternalId
object
1 property 1 required
Schedule
object
Details for the schedule if the transformation is scheduled
6 properties 6 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
UpdateItemWithId_ScheduleUpdate
object
2 properties 2 required
SetBooleanField
object
1 property 1 required
CronValue
string
Cron expression describes when the job should run.
TransformationCogniteExternalId
object
1 property 1 required
Items_UpdateItem_ScheduleUpdate
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-transformation-schedules-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 Transformation Schedules 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.