Changelog

This article documents all notable changes to the Cognite Data Fusion (CDF) API v1.

2024-06-17

Data Modeling

Added

  • Support for creating properties of type direct_relation[], allowing direct relations to point to multiple nodes.
  • /containers/inspect endpoint to retrieve information about which views map a container.
  • /instances/inspect endpoint to retrieve information about which containers an instance has data in.

2024-06-13

Organizations and Projects

Added

  • Projects API (Beta): Allow for parametrization of the initial admin group when creating a project.

Time Series

Added

  • Time zone aware aggregate queries. Align aggregates with a given time zone. Also works with half-hour offsets like Asia/Kolkata (UTC+5:30). Takes DST transitions into account.
  • New month (mo) granularity.
  • Also applies to synthetic time series.

2024-05-24

Organizations and Projects

Added

  • Organizations API (Beta): create, list, and delete CDF organizations
  • Organizations API (Alpha): update CDF organizations
  • Projects API (Beta): create and list projects in CDF organizations

User profiles

Added

  • Organization user profiles (Beta): list users in CDF organizations

Projects

Removed

  • Removed the previous Projects API from public documentation, as those endpoints are available to Cognite and resellers only.

2024-05-23

Time series

Added

  • Beta support for time zone aware aggregate queries. Align aggregates with a given time zone. Also works with half-hour offsets like Asia/Kolkata (UTC+5:30). Takes DST transitions into account.
  • Beta support for new month (mo) granularity.
  • Also applies to synthetic time series.

2024-05-02

Postgres gateway

Added

  • Endpoints for managing PostgreSQL gateway

2024-05-01

Time series

Added

2024-04-02

Groups

Added

  • Introduce the option to manage members of a group through CDF instead of through external groups in the identity provider. This is done through the new members field on the group object. Members can either be explicitly enumerated or one declare a group to include all users accounts. The latter is useful if one wants all existing users and new users who joins a project to automatically receive certain capabilities.

2024-03-19

Engineering diagrams (beta)

Added

  • Beta endpoint for retrieving ocr data for a file per page. Currently, only files that have been run through diagram/detect will give any results. This may be up for change in the future. The endpoint replaces a previous playground endpoint which is no longer documented.

2024-03-11

Default runtime in Cognite functions

Changed

  • Default Python runtime in Cognite functions has been updated from Python 3.8 (py38) to Python 3.11 (py311) in response to the upcoming end of community support for Python 3.8 in October 14, 2024.

2024-03-06

Files

Updated

  • Files API rate and concurrency limits have been documented. -- Service layer request rate and concurrency limits added -- CRUD endpoints request rate, concurrency and items rate limits added -- Analytic endpoints request rate, concurrency rate limits added

2024-02-29

Assets

Updated

  • Assets API rate and concurrency limits have been documented. -- Service layer request rate and concurrency limits added -- CRUD endpoints request rate, concurrency and items rate limits added -- Analytic endpoints request rate, concurrency and items rate limits added

2024-02-20

Data Modeling

Added

Conversion between unit types for returned values during filter and query operations.

  • Trigger conversion by setting the targetUnit by externalId or unitSystemName parameters for the data source in a query.
  • When using filters with unit conversion, the unit for filter value is determined by the corresponding property in the source object. When querying data in centimeters by setting targetUnit on a property in the source, the filter value for that property will also be considered to be in centimeters.
  • typing - type.unit on a property in a typing object is now always the same as the unit for the returned data.
  • Added typing to following endpoints:
    • query
    • sync
    • aggregate
    • search

2024-02-19

Time series

Added

  • Data point subscriptions reaches General Availability (GA).
    • Use the new Data point subscriptions feature to configure a subscription to listen to changes in one or more time series (in ingestion order). The feature is intended to be used where data points consumers need to keep up to date with changes to one or more time series without the need to read the entire time series again.

2024-02-08

Hosted Extractors

Changed

  • host in kafka sources has been replaced with bootstrapBrokers, which is an array of objects with host and port.

2024-02-01

Synthetic time series

Added

  • Support for unit conversion by setting targetUnit or targetUnitSystem on time series or aggregates with a compatible unitExternalId field.

2024-01-16

Sessions

Added

  • Support for creating one-shot sessions by setting the oneshotTokenExchange flag. One-shot sessions are short-lived sessions that are not refreshed and do not require support for token exchange from the identity provider.

2024-01-02

Data Modeling

Added

  • Support for a bySpace flag on btree indexes and uniqueness constraints.

2023-12-12

Data Modeling

Added

  • Units catalog support for container properties: You can now specify a unit from CDF units catalog on float32 and float64 properties in containers.

2023-12-11

Time series

Changed

  • Data point subscriptions list data (beta) now supports long polling through the pollTimeoutSeconds parameter. The request will be kept active for the specified number of seconds, or until new data is available, whichever comes first.

2023-12-06

Time series

Added

2023-11-30

Hosted extractors

Changed

  • Hosted extractors API (Beta)
    • Updates hosted extractor schema with tls certificate details hence users can now provide CA and authentication certificates for connection to MQTT brokers.
    • Now includes schema requirements for connection to Kafka brokers i.e. connection to and extraction from Kafka brokers to Cognie Data fusion is not possible.

2023-11-21

Units Catalog

Added

  • Added the Units Catalog API. The Units Catalog is a collection of units of measurement and their conversion factors. The Units Catalog is used within Cognite Data Fusion to easily convert between different units and unit systems when retrieving Time Series and Data Models.

2023-11-17

Documents

Added

  • Added support for sorting in the /documents/list endpoint. It works exactly the same as the sorting in /documents/search except that you can not sort on search relevance.

2023-11-08

Engineering diagrams

Changed

  • Optional token mechanism for accessing detected results of engineering diagrams without read all access to assets. See diagram/detect for details.

2023-10-23

Files

Added

  • Added multipart upload endpoints for the files API. This enables upload of files larger than 5 GiB, in a uniform way for all CDF cloud environments. Optionally use parallel part upload, for greater upload speed. See the documentation for the new endpoints at:

2023-10-17

Events

Added

  • New and old but previously undocumented API rate and concurrency limits have been documented. Overrides have been specified for existing customers, so that the new limits would not affect them.
    • Service layer request rate and concurrency limits added.
    • CRUD endpoints request rate and concurrency and items rate limits added

2023-10-10

Entity matching

Added

  • Entity matching pipelines are now in v1. We resuscitated the old playground API and made some changes. We will keep the new v1 API in beta for the foreseeable future.

Vision (Contextualization)

Added

  • New computer vision models (beta) are available in Vision extract service, including digital, dial and level gauge readers, valve state detection (open/closed) and model to segment objects in images.

2023-10-05

Hosted extractors

Added

  • Hosted extractors API (Beta)
    • Use the new Hosted extractors feature to create simple streaming extractors running inside CDF, streaming data from sources available on the internet directly into CDF. Currently supports Azure Event Hub and MQTT. Support is planned for Kafka and REST APIs.

2023-09-27

3D

Changed

  • If the 3d model processing is ongoing or has failed, the 3d api nodes endpoints will now return error code 400 with the response body "Revision processing is not yet complete" or "Revision processing failed" respectively. The previous behavior was to return an empty or partial items list in these cases. Before calling any 3d api nodes endpoints, clients should check that the model revision has "status":"Done".

2023-08-25

Transformations

Changed

  • Fixed wrong description for fields in "transformations/update" and "/transformations/schedules/update"

2023-08-22

Functions

Changed

  • Remove Functions runtime "py37".

2023-08-22

Time series

Added

  • Data point subscriptions (Beta)
    • Use the new Data point subscriptions feature to configure a subscription to listen to changes in one or more time series (in ingestion order). The feature is intended to be used where data points consumers need to keep up to date with changes to one or more time series without the need to read the entire time series again. (Beta)

2023-08-10

Time series

Added

  • Advanced query language support reaches General Availability (GA).

Sequences

Added

  • Advanced query language support reaches General Availability (GA).

2023-08-08

Assets

Added

  • Advanced query language support reaches General Availability (GA).
    • Advanced search, filtering, and sorting capabilities in the Filter assets endpoint.
    • Advanced aggregation capabilities in the Aggregate assets endpoint.

Events

Added

  • Advanced query language support reaches General Availability (GA).
    • Advanced search, filtering, and sorting capabilities in the Filter events endpoint.
    • Advanced aggregation capabilities in the Aggregate events endpoint.

Documents

Added

  • Advanced query language support reaches General Availability (GA).

2023-06-27

IAM (Identity and access management)

Changed

  • Identity providers (IdP) are required to be compatible with the OpenID Connect Discovery 1.0 standard, and compliance will now be enforced by the Projects API.

    • The oidcConfiguration.jwksUrl and oidcConfiguration.tokenUrl can be entirely omitted when updating the OIDC configuration for a project.
    • The oidcConfiguration.jwksUrl and oidcConfiguration.tokenUrl are preserved for backwards compatibility of the API. However, if these are specified as part of the request body, the value must match excatly the values that are specified in the OpenID provider configuration document for the configured issuer (can be found at https://{issuer-url}/.well-known/openid-configuration). If the values does not match, the API will return an error message.
  • The oidcConfiguration.skewMs has been deprecated but remains part of the API for backwards compatibility. It can be omitted from the request. If included, it must always be set to 0.

  • The oidcConfiguration.isGroupCallbackEnabled has been deprecated but remains part of the API for backwards compatibility. It can be omitted from the request.

    • For projects configured to use Azure Active Directory as the identity provider, if this value is specified in the request, it must always be set to true.

2023-06-05

Data Modeling

Added

  • Added support for an autoCreateDirectRelations option on the endpoint for ingesting instances. This option lets the user specify whether to create missing target nodes of direct relations.

Removed

  • Removed support for the deprecated per-item sources field on the /instances/byids endpoint.

Time series

Added

  • Added advanced query language support (Beta).

Sequences

Added

  • Added advanced query language support (Beta).

2023-05-19

Transformations

Added

  • Adding support for data model centric and view centric schema.

2023-04-24

Transformations

Removed

  • Removing support for authentication via API keys when creating or updating transformations.

2023-05-04

Annotations

Added

  • Added image.InstanceLink and diagrams.InstanceLink annotation types to allow you to link from objects discovered in images and engineering diagrams to data model instances.

2023-04-18

All resources

Added

Changed

  • Updated the Parallel retrieval documentation.
  • Aligned endpoint naming within Assets, Data sets, Events, and Files.

Assets

Added

  • Added advanced query language support (Beta).
    • Advanced search, filtering, and sorting capabilities in the Filter assets endpoint.
    • Advanced aggregation capabilities in the Aggregate assets endpoint.

Events

Added

  • Added advanced query language support (Beta).
    • Advanced search, filtering, and sorting capabilities in the Filter events endpoint.
    • Advanced aggregation capabilities in the Aggregate events endpoint.

Documents

Added

  • Added advanced query language support (Beta).

2023-04-12

Sessions

Fixed

  • Fixed the API documentation for the request body of the POST /projects/{project}/sessions/byids endpoint. The documentation incorrectly stated the request body schema as specifying the list of session IDs to retrieve, in the form {"items": [42]} - it should in fact be {"items": [{"id": 42}]}. The documentation has been updated to reflect this.

  • Fixed the API documentation for the response body of the POST /projects/{project}/sessions/byids endpoint. The documentation incorrectly stated nextCursor and previousCursor fields as being returned from the response, which was not the case, and these fields have now been removed from the API documentation.

2023-04-04

Transformations

Change

  • Transformations support new target types for view-centric data model instances.

Added

  • Added target types nodes and edges.

2023-03-06

Documents

Change

  • Renamed "approximateCardinality" aggregate to "cardinalityValues" to unify the search spec in Cognite.
  • "uniqueProperties" aggregate no longer supports pagination. It returns unique properties (up to 10000) in the specified path. The results are sorted by frequency.

Added

  • Added "allUniqueProperties" aggregate that returns all unique properties. The response contains a cursor that can be used to fetch all pages of data.

2023-02-03

Seismic

Added

  • Batch downloading of seismics as a ZIP archive is now an experimental v1 endpoint. A user requires the experimental ACL to use this endpoint, and any other ACLs and scopes to read the downloadable seismics.

Fixed

  • The documentation for downloading seismics as SEG-Y files is part of v1. The API documentation didn't reflect that the endpoint had been promoted to version 1.

2023-02-07

Documents

Added

  • Added highlight field in the search endpoint to indicate whether matches in search results should be highlighted.

2023-01-18

3D

Added

  • Added support for using names filter in list nodes endpoint.

2023-01-17

Authentication

Removed

We've removed authentication via CDF service accounts and API keys, and user sign-in via /login.

3D

Added

  • Added support for storing translation and scale for model revision.

2023-01-12

Documents

Added

  • Added support for approximateCardinality aggregate.

2023-01-10

Documents

Added

  • Added the search leaf filter, to allow filtering by searching through specified properties.

2023-01-09

Documents

Added

  • Added the uniqueProperties aggregation, which can be used to find all the metadata keys in use.

2023-01-06

Documents

Added

  • Added inAssetSubtree filter to filter documents that have a related asset in a subtree rooted at any of the specified IDs.

2023-01-02

Documents

Added

  • Added advanced filters for metadata (prefix, in, equals)

2022-12-06

3D

Added

  • Added get3DNodesById endpoint to be able to fetch 3D nodes mapped to an asset.

2022-12-16

Time series

Changed

  • Timestamps of data points may now be as large as 4102444799999 (23:59:59.999, December 31, 2099). The previous limit was the year 2050.

2022-11-29

Events

Added

  • Added nulls field to the sort property specification

2022-11-17

Time series

Added

2022-10-14

Geospatial

2022-10-11

Transformations

Added

  • Added capability to run a transformation with Nonce credentials provided through the Run endpoint.

2022-10-06

IAM (Identity and access management)

Added

2022-09-09

Vision (Contextualization)

Added

  • Move Vision extract service from playground to V1.

2022-08-12

Time series

Changed

2022-07-21

Transformations

Added

  • Added authentication using nonce for transformation's exisiting endpoints.

2022-06-21

Annotations (Data organization)

Added

  • Moved the annotation service from playground to v1.

2022-07-07

Events

Removed

2022-06-13

IAM (Identity and access management)

Added

2022-05-20

Documents

Added

  • Added the POST /documents/aggregate endpoint. The endpoint allows you to count documents optionally grouped by a property and also to retrieve all unique values of a property.

2022-05-12

Documents

Added

  • Added the POST /documents/list endpoint. The endpoint allows you to iterate through all the documents in a project.
  • Added the POST /documents/{documentId}/content endpoint. The endpoint lets you download the entire extracted plain text of a document.

2022-04-11

2022-03-15

Sequences

Changed

  • Changed sequences column limits. Old limit of maximum total 200 columns limits is updated to maximum 400 total columns, maximum 400 numeric columns and maximum 200 string columns.

2022-03-02

Sequences

Added

2022-02-08

Time series

Changed

  • Marked isStep parameter to be editable (i.e. removed description stating it is not updatable) in POST /timeseries/create.

Added

2022-02-07

Documents

Added

2022-01-25

Documents

Added

2022-01-24

Time series

Added

  • Added optional ignoreUnknownIds parameter to POST /sequences/delete. Setting this to true will prevent the operation from failing if one or more of the given sequences do not exist; instead, those given sequences that do exist will be deleted.

2021-12-07

Transformations

Added

2021-11-22

Contextualization

Added

  • Added diagram detect endpoint to v1 to detect annotations in engineering diagrams
  • Added diagram detect results endpoint to v1 to get the results from an engineering diagram detect job
  • Added diagram convert endpoint to v1 to create interactive engineering diagrams in SVG format with highlighted annotations
  • Added diagram convert results endpoint to v1 to get the results for a job converting engineering diagrams to SVGs

2021-11-17

3D

Added

  • Added dataSetId support to 3D models enabling data access scoping of 3D data

2021-10-13

Raw

Changed

  • To align with Microsoft Azure clusters, table and database names are now sensitive to trailing spaces also in Google Cloud Platform clusters.

2021-10-05

Extraction Pipelines

Added

  • New Extraction Pipelines resource to document extractors and monitor the status of data ingestion to make sure reliable and trustworthy data are flowing into the CDF data sets.
  • API endpoints for creating, managing, and deleting extraction pipelines. Capture common attributes around extractors such as owners, contacts, schedule, destination RAW databases, and data set. Document structured metadata in the form of key-value attributes as well unstructured documentation attribute that supports Markdown (rendered as Markdown in Fusion).
  • Extraction Pipelines Runs are CDF objects to store statuses related to an extraction pipeline. The supported statuses are: success, failure and seen. They enable extractor developers to report status and error message after ingesting data. As well enables for reporting heartbeat through seen status by the extractor to easily identify issues related to crushed applications and scheduling issues.

2021-09-28

Sequences

Added

Time series

Added

2021-08-18

IAM (Identity and access management)

Added

Added sessions to v1. Sessions let you securely delegate access to CDF resources for CDF services (such as Functions) by an external principal and for an extended time.

2021-08-12

Relationships

Added

2021-07-01

3D

Added

  • Added filter3dNodes endpoint to allow for more advanced filtering on node metadata

2021-06-29

Labels

Added

2021-06-08

Sequences

Added

2021-06-01

Assets

Added

2021-04-28

Time series

Changed granularity limits on hour aggreagates

You can now ask for a granularity of up to 100000 hours (previously 48 hours), both in normal aggregates and in synthetic time series.

2021-04-12

IAM (Identity and access management)

Added

2021-04-06

Authentication

Deprecated

We are deprecating authentication via CDF service accounts and API keys, and user sign-in via /login, in favor of registering applications and services with your IdP (identity provider) and using OpenID Connect and the IdP framework to manage CDF access securely.

The legacy authentication flow is available for customers using Cognite Data Fusion (CDF) on GCP until further notice. We strongly encourage customers to adopt the new authentication flows as soon as possible.

The following API endpoints are deprecated:

  • /api/v1/projects/*/apikeys
  • /api/v1/projects/*/serviceaccounts
  • /login
  • /logout
  • /api/v1/projects/*/groups/serviceaccounts *

*only the sub-resources for listing, adding, and removing members of groups.

2021-03-22

CDF API 0.5, 0.6 reached their end-of-life after its initial deprecation announcement in Summer 2019.

2021-03-10

3D

Added

  • Added partition parameter to the List 3D Nodes endpoint for supporting parallel requests.
  • Added sortByNodeId parameter to the List 3D Nodes endpoint, improving request latency in most cases if set to true.

2021-02-26

Entity matching

Fixed

  • Fixed a bug in the documentation for Entity matching. The (job) status shall be capitalized string.

2020-12-22

Files

Added

  • New field fileType inside derivedFields to refer to a pre-defined subset of MIME types.
  • New filter fileType inside derivedFields to find files with a pre-defined subset of MIME types.

2020-10-20

Files

Added

  • New field geoLocation to refer to the geographic location of the file.
  • New filter geoLocation to find files matching a certain geographic location.

To learn how to leverage new geoLocation features, follow our guide.

2020-08-29

Files

Added

  • New field directory referring to the directory in the source containing the file.
  • New filter directoryPrefix allows you to find Files matching a certain directory prefix.

2020-08-05

Files

Added

  • New field labels allows you to attach labels to Files upon creation or updating.
  • New filter labels allows you to find Files that have been annotated with specific labels.

2020-07-08

IAM (Identity and access management)

Added

  • New project field applicationDomains. If this field is set, users only sign in to the project through applications hosted on a whitelisted domain. Read more.

2020-07-01

Events

Added

  • New aggregation uniqueValues allows you to find different types, subtypes of events in your project.

2020-06-29

Labels

Added

  • New data organization resource: labels. Manage terms that you can use to annotate and group assets.

Assets

Added

  • New filter labels allows you to find resources that have been annotated with specific labels.

Time series

Added

2020-04-28

Events

Added

  • New filtering capabilities to find open events endTime=null.
  • New filtering capabilities to find all events intersecting a timespan using activeAtTime.

2020-03-12

General

Added

  • New data organization resource: data sets. Document and track data lineage, ensure data integrity, and allow 3rd parties to write their insights securely back to your Cognite Data Fusion (CDF) project.
  • New attribute datasetId introduced in assets, files, events, time series and sequences.
  • New filter dataSetIds allows you to narrow down results to resources containing datasetId by a list of ids or externalIds of a data set. Supported by assets, files, events, time series and sequences.
  • We have added a new aggregation endpoint for time series. With this endpoint, you can find out how many results in a tenant meet the criteria of a filter. We will expand this feature to add more aggregates than count.

Groups

Added

  • Introduced a new capability: datasetsAcl for managing access to data set resources.
  • New scope datasetScope for assets, files, events, time series and sequences ACLs. Allows you to scope down access to resources contained within a specified set of data sets.

2020-03-10

3D

Fixed

  • We fixed a bug in the documentation of 3D model revisions. Applications should anticipate that 3D nodes may not have a bounding box.

2020-02-25

Assets

Added

  • We have added a new aggregation endpoint for assets. With this endpoint, you can find out how many assets in a tenant meet the criteria of a filter. We will expand this feature to add more aggregates than count.

Events

Added

  • We have added a new aggregation endpoint for events. With this endpoint, you can find out how many events in a tenant meet the criteria of a filter. We will expand this feature to add more aggregates than count.

2020-02-12

Assets

Added

  • We have added new aggregation properties: depth and path. You can use the properties in the filter and retrieve endpoints.

2020-02-10

Assets

Added

  • Added the property parentExternalId which is returned for all assets which have a parent with a defined externalId.

2019-12-09

General

Added

  • Added assetSubtreeIds as a parameter to filter, search, and list endpoints for all core resources. assetSubtreeIds allows you to specify assets that are subtree roots, and then only retrieve resources that are related to assets within those subtrees.

2019-12-04

Assets

Added

  • Added the ability to filter assets by parent external IDs.

2019-11-18

2019-11-12

Access control

Removed

  • Groups can no longer be created with a permissions field in v0.5.

2019-10-31

Assets

Added

  • Asset search now has a search.query parameter. This uses an improved search algorithm that tries a wider range of variations of the input terms and gives much better relevancy ranking than the existing search.name and search.description fields.

Time Series

Changed

  • The search.query parameter for time series search now uses an improved search algorithm that tries a wider range of variations of the input terms, and gives much better relevancy ranking.

2019-10-23

Files

Added

  • Added support for updating the mimeType for existing files in files/update requests.

2019-10-18

Time Series

Added

  • Time series expanded their filtering capabilities with new Filter time series endpoint, allowing for additional filtering by:

    • Name
    • Unit
    • Type of time series: string or step series
    • Metadata objects
    • ExternalId prefix filtering
    • Create and last updated time ranges

    Endpoint in addition support pagination and partitioning. Check out detailed API documentation here.

2019-10-16

2019-10-02

Sequences

Added

  • Introducing the new sequences core resource type that lets you store numerically indexed multi-column rows of data. Connect your sequences to physical assets and to their source systems through externalId and metadata support. Read more here.

2019-09-30

3D

Added

  • Added endpoint to get multiple nodes for a 3D model by their IDs.
  • Added endpoint to get asset mappings for multiple node IDs or asset IDs.

2019-09-23

Files

Added

  • Added support for filter on rootAssetIds in files GET /files (using query parameter) and POST /files/list (in request body).

2019-09-16

Assets and Events

Added

  • Added support for partition in /assets and /events to support parallel retrieval. See guide for usage here

2019-08-22

3D

Added

  • Added the query parameter intersectsBoundingBox to the list asset mappings endpoint. The parameter filters asset mappings to the assets where the bounding box intersects (or is contained within) the specified bounding box.

2019-08-21

Files

Added

  • Added support for sourceCreatedTime and sourceModifiedTime fields in files v1 endpoints.

Assets

Added

  • Allow the parent asset ID to be updated. The root asset ID must be preserved, and you can not convert a non-root asset to a root asset or vice versa.
  • Support for ignoreUnknownIds when deleting assets.

2019-08-15

3D

Added

  • Properties field for 3D nodes, extracted from uploaded 3D files.
  • Ability to filter nodes with a specific set of properties.

2019-07-24

Files

Changed

  • Allow lookup of names with length up to 256 characters (was 50) for GET /files and POST /files/search operations.
  • Allow creating and retrieving files with mimeType length up to 256 characters (was 64).

2019-07-15

Time series

Added

  • Added query parameter rootAssetIds to list time series endpoint. Returns time series that are linked to an asset that has one of the root assets as an ancestor.

2019-07-11

List of changes for initial API v1 release in comparison to previous version - API 0.5

General

Added

  • Support for externalId added across resource types. externalId lets you define a unique ID for a data object. Learn more: External IDs
  • externalIdPrefix added as a parameter to the list events, assets and files operations.
  • Richer filtering on the list assets, files and events operations.
  • Search, list and filter operations for assets, events and files now support filtering on source and metadata field values.

Changed

  • Core resources standardize on HTTP methods and URI naming for common operations such as search, partial updates, delete, list and filter
  • API responses are no longer wrapped in a top level data object.
  • Standardized pagination across resources through limit, cursor and nextCursor parameters.
  • The limit parameter no longer implicitly rounds down requested page size to maximum page size.
  • Standardized error responses and codes across all resources. Errors across CDF can be parsed into a single model.
  • Overall improvements to reference documentation. Including documented input constraints, required fields, individual attribute descriptions.

Removed

  • The sourceId field has been removed from resources. Use externalId instead of sourceId+source to define unique IDs for data objects.
  • Sorting is removed from the search operations for files, assets, events and time series. Results are sorted by relevance.
  • offset and previousCursor parameters are no longer supported for pagination across resources.
  • Fetching an asset subtree is no longer supported by files, assets, events and time series.

Assets

Added

  • Ability to select only root assets though new root filter.
  • Added the rootId field to specify the top element in an asset hierarchy.
  • Added the ability to filter by the root asset ID. This allows you to scope queries for one or many asset hierarchies.
  • List Assets allows for filtering assets belonging to set of root assets, specified by list of asset internal ids. New query parameter: rootIds.
  • Filter and Search Assets allows or filtering assets belonging to a set of root assets, specified by combination of internal and external asset identifiers. New body attribute: rootIds.

Changed

  • Updating a single asset is no longer supported through a separate endpoint. Use the update multiple endpoint instead.
  • Delete assets by default removes only leaf assets (assets without children). New parameter 'recursive' allows for enabling recursive removal of the entire subtree of the asset pointed by ID (API 0.5 behaviour).

Removed

  • Overwriting assets is no longer supported.
  • Filtering assets by their complete description is no longer supported.
  • Locating assets fuzzily by name has been removed. Instead, search for assets on the name property.
  • When searching assets, querying over both name and description in the same query is no longer supported.
  • The experimental query parameter boostName has been removed from the search for assets operation.
  • Removed the path and depth fields.

Events

Added

  • Events can now be filtered on asset ID in combination with other filters.
  • New filter rootAssetIds allows for narrowing down events belonging only to list or specified root assets. Supported by Filter and Search API

Removed

  • Events can no longer be filtered by empty description.
  • The 'dir' parameter has been removed from the search events operation.

Files

Added

  • Filtering files by assetIds in list files operations now support multiple assets in the same request.

Changed

  • Download file content has changed from HTTP GET to HTTP POST method.
  • We have renamed the fileType field to mimeType. The field now requires a MIME formatted string (e.g. text/plain).
  • We have renamed the uploadedAt field to uploadedTime.
  • Resumable is now the default behavior for file uploads.
  • Update metadata for single files is no longer supported by a separate operation. Instead, use the update multiple operation.

Removed

  • Replace files metadata endpoint has been removed.
  • Directory has been removed as a property of files.
  • Updating the name or mimeType of a file through the update multiple files operation is no longer supported.
  • Query parameter for specifying the sort direction has been removed from list all files operations.

Raw

Changed

  • Raw has changed structure to become resource-oriented. The URL structure has changed.
  • Recursively delete of tables and rows when deleting a database is now the default behavior without a control parameter.

Time series

Added

  • Support for adding datapoints by id and externalId of time series. Adding datapoints to time series by name has been removed.
  • Add ability to update the new externalId attribute for time series.
  • Allow to set externalId during creation of time series. ExternalId requires uniqueness across time series.
  • Consolidate multiple APIs to allow adding datapoints into a single endpoint. Allows datapoints to be added to multiple time series at the same time.
  • Retrieve data points by using id and externalId of the time series.
  • Time series created through API v1 are not discoverable by API 0.3, 0.4, 0.5 and 0.6 by default. Introduce the option to enable this compatibility by setting new attribute - legacyName on time series creation. Value is required to be unique.

Changed

  • Get latest datapoints has been reworked. Introduces support for id and externalId lookup as well retrieval for multiple time series within the same request.
  • Time series name is no longer limited by uniqueness. Note that time series (meta objects) created by API v1 will not be discoverable by older API versions.
  • Delete time series endpoint has been redesigned to allow deletion of multiple time series by id and externalId.
  • Delete single and multiple datapoints endpoint has been redesigned and consolidated into a single endpoint. New delete allows selection of multiple time series and time ranges by id and externalId. Selecting by name is no longer available.
  • Update multiple time series restructured to support lookup by externalId.
  • Retrieve time series by ID endpoint restructured adding the ability to get time series by externalId.
  • Set limit for data point value to min -1E100, max 1E100.

Removed

  • Experimental feature for performing calculations across multiple time series (synthetic time series), function and alias attributes are no longer available.
  • The experimental query parameter boostName has been removed from search operation.
  • Short names for aggregate functions are no longer supported.
  • Ability to remove time series by name have been removed as names are no longer unique identifiers.
  • Select multiple time series and time ranges by name is no longer available.
  • The ability to update isString and isStep attributes is removed. The attributes are not intended to be modified after creation of time series.
  • The endpoint for updating single time series is removed. Use the update multiple time series endpoint instead.
  • Remove ability to overwrite time series object by id. Use the update multiple time series endpoint instead.
  • The ability to retrieve time series matching by name has been removed. Use externalId instead.
  • The ability to retrieve by id from a single time series has been removed. Use retrieve multiple datapoints for multiple time series instead.
  • The ability to retrieve time-aligned datapoints through "dataframe" API has been removed. Similar functionality is available through our supported SDKs.
  • The ability to add datapoints to time series by name has been removed.
  • The ability to look up by time series name has been removed.

IAM (Identity and access management)

Added

  • The login status endpoint includes the ID of the API key making the request (new attribute: apiKeyId), if the request used an API key.

Changed

  • The user resource type has been replaced with service accounts. Users from previous API versions are equivalent to service accounts.
  • Adding, listing and removing users from a group has been replaced by equivalent operations for service accounts.
  • Retrieve project returns a single object instead of a list.
  • API keys endpoints for list/create rename userId attribute to serviceAccountId.

Removed

  • List and create groups no longer use the permissions and source attributes.

3D

Added

  • New 3D API lets you upload and process 3D models. Supported format: FBX.
  • Ability to create and maintain multiple revisions for the 3D models.
  • API for mapping relationships between 3D model nodes and asset hierarchy.