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.
openapi: 3.1.0
info:
title: Cognite 3D Asset Mapping Transformation Schedules API
description: "# Introduction\nThis is the reference documentation for the Cognite API with\nan overview of all the available methods.\n\n# Postman\nSelect the **Download** button to download our OpenAPI specification to get started.\n\nTo import your data into Postman, select **Import**, and the Import modal opens.\nYou can import items by dragging or dropping files or folders. You can choose how to import your API and manage the import settings in **View Import Settings**.\n\nIn the Import Settings, set the **Folder organization** to **Tags**, select\n**Enable optional parameters** to turn off the settings, and select **Always inherit authentication** to turn on the settings. Select **Import**.\n\nSet the Authorization to **Oauth2.0**. By default, the settings are for Open Industrial Data. Navigate to [Cognite Hub](https://hub.cognite.com/open-industrial-data-211) to understand how to get the credentials for use in Postman.\n\nFor more information, see [Getting Started with Postman](https://developer.cognite.com/dev/guides/postman/).\n\n# Pagination\nMost resource types can be paginated, indicated by the field `nextCursor` in the response.\nBy passing the value of `nextCursor` as the cursor you will get the next page of `limit` results.\nNote that all parameters except `cursor` has to stay the same.\n\n# Parallel retrieval\nAs general guidance, Parallel Retrieval is a technique that should be used when due to query complexity, retrieval of data in a single request is significantly slower than it would otherwise be for a simple request. Parallel retrieval does not act as a speed multiplier on optimally running queries. By parallelizing such requests, data retrieval performance can be tuned to meet the client application needs. \n\nCDF supports parallel retrieval through the `partition` parameter, which has the format `m/n` where `n` is the amount of partitions you would like to split the entire data set into.\nIf you want to download the entire data set by splitting it into 10 partitions, do the following in parallel with `m` running from 1 to 10:\n - Make a request to `/events` with `partition=m/10`.\n - Paginate through the response by following the cursor as explained above. Note that the `partition` parameter needs to be passed to all subqueries.\n\nProcessing of parallel retrieval requests is subject to concurrency quota availability. The request returns the `429` response upon exceeding concurrency limits. See the Request throttling chapter below.\n\nTo prevent unexpected problems and to maximize read throughput, you should at most use 10 partitions. \nSome CDF resources will automatically enforce a maximum of 10 partitions.\nFor more specific and detailed information, please read the ```partition``` attribute documentation for the CDF resource you're using. \n\n# Requests throttling\nCognite Data Fusion (CDF) returns the HTTP `429` (too many requests) response status code when project capacity exceeds the limit.\n\nThe throttling can happen:\n - If a user or a project sends too many (more than allocated) concurrent requests.\n - If a user or a project sends a too high (more than allocated) rate of requests in a given amount of time.\n\nCognite recommends using a retry strategy based on truncated exponential backoff to handle sessions with HTTP response codes 429.\n\nCognite recommends using a reasonable number (up to 10) of `Parallel retrieval` partitions.\n\nFollowing these strategies lets you slow down the request frequency to maximize productivity without having to re-submit/retry failing requests.\n\nSee more [here](https://docs.cognite.com/dev/concepts/resource_throttling).\n\n# API versions\n## Version headers\nThis API uses calendar versioning, and version names follow the `YYYYMMDD` format.\nYou can find the versions currently available by using the version selector at the top of this page.\n\nTo use a specific API version, you can pass the `cdf-version: $version` header along with your requests to the API.\n\n## Beta versions\nThe beta versions provide a preview of what the stable version will look like in the future.\nBeta versions contain functionality that is reasonably mature, and highly likely to become a part of the stable API.\n\nBeta versions are indicated by a `-beta` suffix after the version name. For example, the beta version header for the\n2023-01-01 version is then `cdf-version: 20230101-beta`.\n\n## Alpha versions\nAlpha versions contain functionality that is new and experimental, and not guaranteed to ever become a part of the stable API.\nThis functionality presents no guarantee of service, so its use is subject to caution.\n\nAlpha versions are indicated by an `-alpha` suffix after the version name. For example, the alpha version header for\nthe 2023-01-01 version is then `cdf-version: 20230101-alpha`."
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: Transformation Schedules
description: 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.
paths:
/transformations/schedules:
get:
tags:
- Transformation Schedules
summary: List all schedules
description: '
> **Required capabilities:** `transformationsAcl:READ`
List all transformation schedules. Use nextCursor to paginate through the results.'
operationId: getTransformationSchedules
parameters:
- name: limit
in: query
description: Limits the number of results to be returned. The maximum is 1000, default limit is 100.
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 1000
- name: cursor
in: query
description: Cursor for paging through results.
required: false
schema:
type: string
- name: includePublic
in: query
description: Whether public transformations should be included in the results. The default is true.
required: false
schema:
type: boolean
responses:
'200':
description: Response with list of schedules.
content:
application/json:
schema:
$ref: '#/components/schemas/ItemsWithCursor_Schedule'
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'409':
description: The response for a conflict.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
x-capability: transformationsAcl:READ
x-code-samples:
- lang: Python
label: Python SDK
source: 'schedules_list = client.transformations.schedules.list()
'
- lang: Java
label: Java SDK
source: "Iterator<List<Transformation.Schedule>> it = \n client.transformations().schedules().list();\n\n"
post:
tags:
- Transformation Schedules
summary: Schedule transformations
description: '
> **Required capabilities:** `transformationsAcl:WRITE`
Schedule transformations with the specified configurations.'
operationId: createTransformationSchedules
requestBody:
description: List of the schedules to create. Must be up to a maximum of 1000 items.
content:
application/json:
schema:
$ref: '#/components/schemas/Items_ScheduleParameters'
required: true
responses:
'201':
description: Response with list of schedules.
content:
application/json:
schema:
$ref: '#/components/schemas/Items_Schedule'
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'409':
description: The response for a conflict.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
x-capability: transformationsAcl:WRITE
x-code-samples:
- lang: Python
label: Python SDK
source: 'from cognite.client.data_classes import TransformationScheduleWrite
schedules = [TransformationScheduleWrite(id = 1, interval = "0 * * * *"), TransformationScheduleWrite(external_id="transformation2", interval = "5 * * * *"))]
res = client.transformations.schedules.create(schedules)
'
- lang: Java
label: Java SDK
source: "List<Transformation.Schedule> objects = new ArrayList<>(); \nobjects.add(Transformation.Schedule.newBuilder() \n .setExternalId(\"10\") \n .setInterval(\"*/5 * * * *\") \n .setIsPaused(false) \n .build());\nList<Transformation.Schedule> createdListSchedules = \n client.transformations().schedules().schedule(objects);\n\n"
/transformations/schedules/byids:
post:
tags:
- Transformation Schedules
summary: Retrieve schedules
description: '
> **Required capabilities:** `transformationsAcl:READ`
Retrieve transformation schedules by transformation IDs or external IDs.'
operationId: getTransformationSchedulesByIds
requestBody:
description: List of transformation IDs of schedules to retrieve. Must be up to a maximum of 1000 items and all of them must be unique.
content:
application/json:
schema:
$ref: '#/components/schemas/ItemsWithIgnoreUnknownIds_CogniteId'
required: true
responses:
'200':
description: Response with list of schedules.
content:
application/json:
schema:
$ref: '#/components/schemas/Items_Schedule'
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'409':
description: The response for a conflict.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
x-capability: transformationsAcl:READ
x-code-samples:
- lang: Python
label: Python SDK
source: 'res = client.transformations.schedules.retrieve(id=1)
res = client.transformations.schedules.retrieve(external_id="1")
res = client.transformations.schedules.retrieve_multiple(ids=[1, 2, 3])
res = client.transformations.schedules.retrieve_multiple(external_ids=["t1", "t2"])
'
- lang: Java
label: Java SDK
source: "List<Item> itemsToRetrieve = List.of(Item.newBuilder() \n .setExternalId(\"10\") \n .build());\nList<Transformation.Schedule> retrievedItems = \n client.transformations().schedules().retrieve(itemsToRetrieve);\n\n"
/transformations/schedules/delete:
post:
tags:
- Transformation Schedules
summary: Unschedule transformations
description: '
> **Required capabilities:** `transformationsAcl:WRITE`
Unschedule transformations by IDs or externalIds.'
operationId: deleteTransformationSchedules
requestBody:
description: List of transformation IDs of schedules to delete. Must be up to a maximum of 1000 items and all of them must be unique.
content:
application/json:
schema:
$ref: '#/components/schemas/ItemsWithIgnoreUnknownIds_CogniteId'
required: true
responses:
'200':
description: Empty response.
content:
application/json:
schema:
type: object
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'409':
description: The response for a conflict.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
x-capability: transformationsAcl:WRITE
x-code-samples:
- lang: Python
label: Python SDK
source: 'client.transformations.schedules.delete(id=[1,2,3], external_id="3")
'
- lang: Java
label: Java SDK
source: "List<Item> deleteSchedule = List.of(Item.newBuilder() \n .setExternalId(\"10\") \n .build());\nBoolean isUnSchedule = \n client.transformations().schedules().unSchedule(deleteSchedule);\n\n"
/transformations/schedules/update:
post:
tags:
- Transformation Schedules
summary: Update schedules
operationId: updateTransformationSchedules
requestBody:
description: List of schedule updates. Must be up to a maximum of 1000 items.
content:
application/json:
schema:
$ref: '#/components/schemas/Items_UpdateItem_ScheduleUpdate'
required: true
responses:
'200':
description: Response with list of schedules.
content:
application/json:
schema:
$ref: '#/components/schemas/Items_Schedule'
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cognite/refs/heads/main/openapi/cognite-transformation-schedules-api-openapi.yml