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 Data models API

The Data models API from Cognite — 3 operation(s) for data models.

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

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

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

4 operations 3 paths 70 schemas 1 GET3 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 Data models 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 4

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

Data models 4
POST
/models/datamodels
Create or update data models
createDataModels body → 200400409
GET
/models/datamodels
List data models defined in the project
listDataModels 6 params → 200400
POST
/models/datamodels/byids
Retrieve data models by their external ids
byExternalIdsDataModels 1 param body → 200400
POST
/models/datamodels/delete
Delete data models
deleteDataModels body → 200400

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are EdgeConnection (7 properties), CorePropertyCreateDefinition (6 properties), ViewCommon (6 properties), ReverseDirectRelationConnection (5 properties). Each schema is shown below with its type and property counts.

EqualsFilterV3
object
1 property 1 required
PropertyIdentifierV3
string
DataModelsNestedFilter
object
1 property 1 required
DataModelProperty
DirectRelationReference
object
Reference to the node pointed to by the direct relation. The reference consists of a space and an external-id.
2 properties 2 required
NextCursorV3
string
The cursor value used to return (paginate to) the next page of results, when more data is available.
DataModelCreateProperty
ThroughReference
object
Traverse from another table expression using a direct relation. Only applicable when from is specified. The view or container property to use when we traverse…
2 properties 2 required
ContainsAllFilterV3
object
1 property 1 required
InFilterV3
object
1 property 1 required
PrefixFilterV3
object
1 property 1 required
ListOfAllVersionsReferences
object
1 property 1 required
DataModelCreate
OverlapsFilterV3
object
1 property 1 required
SourceReference
Reference to a view, or a container
DataModelCreateCollection
object
1 property 1 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
UpsertConflict
object
1 property 1 required
DMSFilterProperty
array
A reference to either a DMS base property or a container property. For nodes the DMS base properties are instanceType, version, space, externalId, type, create…
NodeOrEdgeExternalId
string
ContainsAnyFilterV3
object
1 property 1 required
ViewCreateDefinitionProperty
A reference to a container property or a connection describing edges that are expected to exist (ConnectionDefinition). If the referenced container property is…
DMSVersion
string
DirectNodeRelation
object
Direct node relation
4 properties 1 required
FilterDefinition
object
A filter Domain Specific Language (DSL) used to create advanced filter queries.
DataModelCore
object
5 properties 3 required
CreateViewProperty
object
5 properties 2 required
FilterValue
DataModelsLeafFilter
object
Leaf filter
TextProperty
object
Text type
5 properties 1 required
CorePropertyCreateDefinition
object
6 properties
DataModel
ReverseDirectRelationConnection
object
Describes the direct relation(s) pointing to instances read through this view. This connection type is used to aid in discovery and documentation of the view.
5 properties 3 required
RawPropertyValueV3
A value matching the data type of the defined property
CDFExternalIdReference
object
An external-id reference to an existing CDF resource type item, such as a time series. An example could be that for an existing time series stored in the CDF t…
3 properties 1 required
UsedFor
string
Should this operation apply to nodes, edges, records, or both nodes and edges. NB! Currently all applies to nodes and edges, but not records.
HasExistingDataFilterV3
object
1 property 1 required
MatchAllFilter
object
1 property 1 required
DataModelsBoolFilter
object
Build a new query by combining other queries, using boolean operators. We support the and, or, and not boolean operators.
CorePropertyDefinition
ConstraintOrIndexState
string
ListOfVersionReferences
object
1 property 1 required
ViewPropertyDefinition
Property definition
ViewReference
object
Reference to a view
4 properties 4 required
ReverseDirectRelationConnectionRead
ViewDirectNodeRelation
Direct node relation. Can include a hint to specify the view that this direct relation points to. This hint is optional.
ViewDefinition
FilterValueRange
RangeFilterV3
object
1 property 1 required
ContainerReference
object
Reference to an existing container
3 properties 3 required
InstanceReferenceFilterV3
object
1 property 1 required
EdgeConnection
object
Describes the edge(s) that are likely to exist to aid in discovery and documentation of the view. A listed edge is not required. i.e. It does not have to exist…
7 properties 2 required
SpaceSpecification
string
DMSExternalId
string
EnumProperty
object
An enum type property. An enum property can only consist of predefined values.
3 properties 2 required
ViewCorePropertyDefinition
RangeValue
Value you wish to find in the provided property using a range clause.
ParameterizedPropertyValueV3
object
A parameterized value
1 property 1 required
ViewCommon
object
6 properties 2 required
ConnectionDefinitionRead
ConnectionDefinition
RawPropertyValueListV3
array
A list of values
FilterValueList
PrimitiveProperty
object
Primitive types for the property. We expect dates to be in the ISO-8601 format, while timestamps are expected to be an epoch value with millisecond precision.…
4 properties 1 required
ReferencedPropertyValueV3
object
A property reference value
1 property 1 required
DMSExistsFilter
object
1 property 1 required
ViewCreateDefinition
Error
object
Cognite API error.
4 properties 2 required
EnumValueProperties
object
Metadata of the enum value.
2 properties
ViewDefinitionProperty

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-data-models-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 point subscriptions API
Cognite Data products API
Where this information came from

This is an independent, third-party profile of Cognite Data models 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.