Cognite Data Fusion (Preview)

Connect to your Cognite Data Fusion project using the Cognite Data Fusion API endpoints found at https://api-docs.cognite.com/ Documentation: https://docs.cognite.com/ Developer: https://developer.cognite.com/
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Cognite Support |
URL | https://support.cognite.com |
support@cognite.com |
Connector Metadata | |
---|---|
Publisher | Cognite AS |
Website | https://api-docs.cognite.com/ |
Privacy policy | https://www.cognite.com/en/policy |
Categories | AI; Data |
Connect to your Cognite Data Fusion project using the Cognite Data Fusion API endpoints found at https://api-docs.cognite.com/
Documentation: https://docs.cognite.com/ Developer: https://developer.cognite.com/
Prerequisites
You will need the following to proceed:
- A Cognite Data Fusion Project
- OAuth2 configured with your Cognite Data Fusion Project (see below)
How to get credentials
Please contact your Cognite Project representative to set up your Cognite Data Fusion Project and Active Directory credentials.
Get started with your connector
Explore the Cognite Data Fusion API endpoints found at https://api-docs.cognite.com/ Using the documentation as guide for parameters, you can use this connector to access, modify, and delete data in your Cognite Data Fusion Project.
Known issues and limitations
This is a partial connector containing Time Series and Data Modeling endpoints to the Cognite Data Fusion API with ongoing development for all other endpoints.
Common errors and remedies
Most syntax and typings are set for the Cognite Data Fusion Platform connector, however for the more complex parameters, please consult the Cognite Data Fusion API documentation. For additional support, please contact Cognite Support at support@cognite.com.
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Enter your Cognite Data Fusion Cluster. | string | Enter your Cognite Data Fusion Cluster. | True |
Enter your Client ID. | string | Enter your Client ID. | True |
Enter your Client Secret. | securestring | Enter your Client Secret. | True |
Enter your Cognite Data Fusion Scope. | string | Enter your Cognite Data Fusion Scope. | True |
Enter your AuthorizationUrl. | string | Enter your AuthorizationUrl. | True |
Enter your TokenUrl. | string | Enter your TokenUrl. | True |
Enter your RefreshUrl. | string | Enter your RefreshUrl. | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Aggregate data across nodes or edges |
Aggregate data for nodes or edges in a project. You can use an optional query or filter specification to limit the result. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Aggregate time series |
The aggregation API allows you to compute aggregated results from a set of time series, such as
getting the number of time series in a project or checking what assets the different time series
in your project are associated with (along with the number of time series for each asset).
By specifying
The default behavior, when the
|
Limit | Per project | Per user (identity) |
---|---|---|
Rate | 15 requests per second | 10 requests per second |
Concurrency | 6 concurrent requests | 4 concurrent requests |
Add or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for containers that remain unchanged.
Add or update (upsert) data models. For unchanged data model specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for models that remain unchanged.
Create or update nodes and edges in a transaction. The items
field of the payload is an array of objects
where each object describes a node or an edge to create, patch or replace. The instanceType
field of
each object must be node
or edge
and determines how the rest of the object is interpreted.
This operation is currently limited to 1000 nodes and/or edges at a time.
Individual nodes and edges are uniquely identified by their externalId and space.
Creating new instances
When there is no node or edge with the given externalId in the given space, a node will be created and the
properties provided for each of the containers or views in the sources
array will be populated for the
node/edge. Nodes can also be created implicitly when an edge between them is created (if
autoCreateStartNodes
and/or autoCreateEndNodes
is set), or when a direct relation
property is set, the target node does not exist and autoCreateDirectRelations
is set.
To add a node or edge, the user must have capabilities to access (write to) both the view(s) referenced in
sources
and the container(s) underlying these views, as well as any directly referenced containers.
Updating (patching) or replacing instances
When a node or edge (instance) with the given externalId already exists in a space, the
properties named in the sources
field will be written to the instance. Other properties will remain
unchanged. To replace the whole set of properties for an instance (a node or an edge) rather than patch the
instance, set the replace
parameter to true
.
If you use a writable view to update properties (that is, the source you are referring to in sources
is a view), you must have write access to the view as well as all of its backing containers.
No-change patch operations
When a node/edge item has no changes compared to the existing instance - that is, when the supplied property
values are equal to the corresponding values in the existing node/edge, the node/edge will stay unchanged.
In this case, the lastUpdatedTime
values for the nodes or edges in question will not change.
Add or update (upsert) spaces. For unchanged space specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for spaces that remain unchanged.
Add or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for views that remain unchanged.
Creates one or more time series.
Delete one or more container constraints. Currently limited to 10 constraints at a time.
Delete one or more containers. Currently limited to 100 containers at a time. You cannot delete a container when one or more data model(s) or view(s) references it.
Delete one or more data models. Currently limited to 100 models at a time. This does not delete the views, nor the containers they reference.
Delete data points from time series.
Delete one or more container indexes. Currently limited to 10 indexes at a time.
Delete nodes and edges in a transaction. Limited to 1000 nodes or edges at a time.
When a node is selected for deletion, all connected incoming and outgoing edges that point to or from it are also deleted. However, please note that the operation might fail if the node has a high number of edge connections. If this is the case, consider deleting the edges connected to the node before deleting the node itself.
Delete one or more spaces. Currently limited to 100 spaces at a time.
If an existing data model references a space, you cannot delete that space. Nodes, edges and other data types that are part of a space will no longer be available.
Deletes the time series with the specified IDs and their data points.
Delete one or more views. Currently limited to 100 views at a time. The service cannot delete a view referenced by a data model.
Filter the instances - nodes and edges - in a project.
Retrieves a list of time series that match the given criteria.
Advanced filtering
The advancedFilter
field lets you create complex filtering expressions that combine simple operations,
such as equals
, prefix
, and exists
, by using the Boolean operators and
, or
, and not
.
Filtering applies to basic fields as well as metadata. See the advancedFilter
syntax in the request example.
Supported leaf filters
Leaf filter | Supported fields | Description and example |
---|---|---|
containsAll |
Array type fields | Only includes results which contain all of the specified values. {"containsAll": {"property": ["property"], "values": [1, 2, 3]}} |
containsAny |
Array type fields | Only includes results which contain at least one of the specified values. {"containsAny": {"property": ["property"], "values": [1, 2, 3]}} |
equals |
Non-array type fields | Only includes results that are equal to the specified value. {"equals": {"property": ["property"], "value": "example"}} |
exists |
All fields | Only includes results where the specified property exists (has a value). {"exists": {"property": ["property"]}} |
in |
Non-array type fields | Only includes results that are equal to one of the specified values. {"in": {"property": ["property"], "values": [1, 2, 3]}} |
prefix |
String type fields | Only includes results which start with the specified text. {"prefix": {"property": ["property"], "value": "example"}} |
range |
Non-array type fields | Only includes results that fall within the specified range. {"range": {"property": ["property"], "gt": 1, "lte": 5}} Supported operators: gt , lt , gte , lte |
search |
["name"] and ["description"] |
Introduced to provide functional parity with the /timeseries/search endpoint. {"search": {"property": ["property"], "value": "example"}} |
Supported properties
Property | Type |
---|---|
["description"] |
string |
["externalId"] |
string |
["metadata", "<someCustomKey>"] |
string |
["name"] |
string |
["unit"] |
string |
["assetId"] |
number |
["assetRootId"] |
number |
["createdTime"] |
number |
["dataSetId"] |
number |
["id"] |
number |
["lastUpdatedTime"] |
number |
["isStep"] |
Boolean |
["isString"] |
Boolean |
["accessCategories"] |
array of strings |
["securityCategories"] |
array of numbers |
Limits
- Filter query max depth: 10.
- Filter query max number of clauses: 100.
and
andor
clauses must have at least one element (and at most 99, since each element counts towards the total clause limit, and so does theand
/or
clause itself).- The
property
array of each leaf filter has the following limitations:- Number of elements in the array is 1 or 2.
- Elements must not be null or blank.
- Each element max length is 256 characters.
- The
property
array must match one of the existing properties (static top-level property or dynamic metadata property).
containsAll
,containsAny
, andin
filtervalues
array size must be in the range [1, 100].containsAll
,containsAny
, andin
filtervalues
array must contain elements of number or string type (matching the type of the given property).range
filter must have at lest one ofgt
,gte
,lt
,lte
attributes. Butgt
is mutually exclusive togte
, whilelt
is mutually exclusive tolte
.gt
,gte
,lt
,lte
in therange
filter must be of number or string type (matching the type of the given property).search
filtervalue
must not be blank, and the length must be in the range [1, 128], and there may be at most twosearch
filters in the entire filter query.- The maximum length of the
value
of a leaf filter that is applied to a string property is 256.
Sorting
By default, time series are sorted by their creation time in ascending order.
Sorting by another property or by several other properties can be explicitly requested via the
sort
field, which must contain a list
of one or more sort specifications. Each sort specification indicates the property
to sort on
and, optionally, the order
in which to sort (defaults to asc
). If multiple sort specifications are
supplied, the results are sorted on the first property, and those with the same value for the first
property are sorted on the second property, and so on.
Partitioning is done independently of sorting; there is no guarantee of sort order between elements from different partitions.
Null values
In case the nulls
field has the auto
value, or the field isn't specified, null (missing) values
are considered bigger than any other values. They are placed last when sorting in the asc
order and first in the desc
order. Otherwise, missing values are placed according to
the nulls
field (last
or first
), and their placement won't depend on the order
field. Note that the number zero, empty strings, and empty lists are all considered
not null.
Example
{
"sort": [
{
"property" : ["createdTime"],
"order": "desc",
"nulls": "last"
},
{
"property" : ["metadata", "<someCustomKey>"]
}
]
}
Properties
You can sort on the following properties:
Property |
---|
["assetId"] |
["createdTime"] |
["dataSetId"] |
["description"] |
["externalId"] |
["lastUpdatedTime"] |
["metadata", "<someCustomKey>"] |
["name"] |
Limits
The sort
array must contain 1 to 2 elements.
Insert data points into a time series. You can do this for multiple time series. If you insert a data point with a timestamp that already exists, it will be overwritten with the new value.
List of containers defined in the current project. You can filter the list by specifying a space.
List data models defined in the project. You can filter the returned models by the specified space.
List spaces defined in the current project.
List time series. Use nextCursor
to paginate through the results.
List of views defined in the current project. You can filter the list by specifying a space.
Query_GraphQL
Querying
The Data Modelling API exposes an advanced query interface. The query interface supports parameterization, recursive edge traversal, chaining of result sets, and granular property selection.
A query is composed of a with section defining result set expressions that describe the input to the query, a set of optional parameter placeholders if the query is parameterized, and then the select section that defines which properties are to be returned back as part of the result.
Imagine you have a data set with airplanes and airports, represented as two sets of nodes with edges between them indicating in which airports the airplanes land. Here is an example of a query which fetches a specific airplane as well as the airports it lands in:
with:
airplanes:
nodes:
filter:
equals:
property: ["node", "externalId"]
value: {"parameter": "airplaneExternalId"}
limit: 1
lands_in_airports:
edges:
from: airplanes
maxDistance: 1
direction: outwards
filter:
equals:
property: ["edge", "type"]
value: ["aviation", "lands-in"]
airports:
nodes:
from: lands_in_airports
parameters:
airplaneExternalId: myFavouriteAirplane
select:
airplanes: {}
airports: {}
Result Set Expressions
Result set expressions appear directly below with
in a query, and define a set of either nodes or edges.
The set may be used to return results, as stepping stones to derive other sets from, or both.
Result set expressions are named and can be chained as we'll see examples of later.
A result set expression may also define sort
order and a limit
. See sorting for more
details.
While result set expressions may relate to each other via chaining, they don't have to. You can query for entirely unrelated things in the same query, but different sets are generally used to power graph traversals.
A set either queries nodes or it queries edges, possibly recursively.
All fields:
nodes
: An object to specify a result set of matching nodes.edges
: An object to specify a result set of matching edges.sort
: A list of sort configurationslimit
: How many nodes or edges to return in the result. Default: 100
Pagination
The max limit you can set for any table expression is 10,000. In order to support retrieving the entire result set, pagination cursors are emitted for each result set expression, allowing you to page through everything. Pagination cursors cannot be combined with custom sorts. If no pagination cursor is present for a given result set expression in the response, then there is guaranteed no more data that matches.
Node result set expressions
A nodes
statement in your result set expression will make the set contain nodes.
A node result set can be chained off both node and edge result set expressions. When chaining off another node result
set you will retrieve the nodes pointed to by a given direct relation property, this direct relation
property is defined using the through
field. When chaining off an edge result set, you will retrieve the end nodes
defined by the edges in the set.
from
: A different result set expression to chain fromthrough
: What property to join thefrom
"through". Thethrough
property must be a direct relation.chainTo
: Control which side of the edge to chain to. This option is only applicable if the view referenced in thefrom
field consists of edges.chainTo
can be one of:source
will chain tostart
if you're following edges outwards i.edirection=outwards
. If you're following edges inwards i.edirection=inwards
, it will chain toend
.destination (default)
will chain toend
if you're following edges outwards i.edirection=outwards
. If you're following edges inwards i.edirection=inwards
, it will chain tostart
.
filter
: A filter to determine which nodes to match and thus be returned in the respective result set.
Edge result set expressions
An edges
statement in a result set expression will make the set contain edges, and the statement defines the rules
the graph traversal will follow.
A graph traversal can start from some initial set. This can be defined by from
, which will name another result
set expression.
The graph traversal follows edges in a particular direction, controlled by direction
, which defaults to outwards
.
Alice -is_parent-> Bob
Bob -fancies-> Mallory
Given the above graph, if you follow any edge from Bob
outwards (which is default), you'll get the edges
Bob -fancies-> Mallory
. If you follow edges inwards, i.e. direction=inwards
, you'll get Alice -is-parent-> Bob
.
The traversal happens breadth first. See limitations for more details.
A traversal is defined by what edges to follow, what nodes to match, and what nodes to terminate traversal at.
This is controlled by filter
, nodeFilter
and terminationFilter
.
filter
is a filter on edges. You would typically filter on the property [edge, type]
, but any property on an edge
can be filtered on.
nodeFilter
is a node filter, which the node on the "other" side must match. With direction: outwards
, that means
the "end node" of the edge must match. With direction: inwards
, the "start node" must match.
terminationFilter
is similar to nodeFilter
, except if it matches, traversal will end. A node must also match
nodeFilter
(if any) to steer the traversal to the node to terminate at in the first place.
maxDistance
controls how many hops away from the initial set traversal will go. maxDistance
defaults to unlimited
(but the set must respect its limit
, defined on the result set expression). If maxDistance
is 1, execution might
be faster, so if you know there will only be one level, it's worth configuring maxDistance: 1
.
Full options:
from
: Result set expression to chain from.filter
: Edges traversed must match this filter.nodeFilter
: Nodes on the "other" side of the edge must match this filter.terminationFilter
. Do not traverse beyond nodes matching this filter.maxDistance
: How many levels to traverse. Default unlimited.direction
: Whether to traverse edges pointing out of the initial set, or into the initial set.limitEach
: Limit the number of returned edges for each of the source nodes in the result set. The indicated uniform limit applies to the result set from the referenced from. limitEach only has meaning when you also specify maxDistance=1 and from.
Selects
Select configurations appear directly below select
in a query. These specify which data to retrieve for the respective
result set expression. It specifies a number of sources (views) and a property selector for each of these. The property
selectors define which view properties will be emitted in the query result.
It's possible to have sets whose properties are not emitted. This can be useful if the sets are necessary for chaining, but not actually interesting to include in the final results. Sets that are neither chained nor selected will not be executed (but will cause very slight query processing overhead)
Results are grouped by their respective sets, and the results contain properties that match the property selectors for the set.
Filters
Filters define what a part of the query matches. Filters are tree structures where the operator comes first, and then the parameters for that operator.
A simple example is the in
filter:
in:
property: [node, name]
values: [movie]
If the property node.name
, which is text property, is equal to any of the values in the provided list, the node will
match. Properties are typed. What query operators you can use on a property depends on its type.
An exhaustive list of filters and their descriptions can be found by examining the request body schema below.
Compound filters
Filters can be combined with and
/or
/not
:
and:
- not:
in:
property: [node, type]
values: [movie]
- range:
property: [imdb, movie, released]
gte: {parameter: start}
This would correspond to (NOT node.type in ('movie')) AND imdb.movie.released >= $start
.
HasData filter
Although this filter is documentented in the request body schema, it merits a more detailed explanation.
A hasData
filters will match if data is present in a given set of containers or views.
There is an implicit AND
between the containers and views referenced in the filter, so the filter will match
if and only if the node/edge has data in all of the specified containers and views.
When a container is specified, the filter will match if the instance has all required properties populated for that particular container.
When a view is specified, the filter will match nodes with data in all of the containers which the view references through properties, respecting the filters of the view if defined (and the filters of views implemented by the view).
Example:
hasData:
- type: container
space: my_space
externalId: my_container
- type: view
space: my_space
externalId: my_view
version: v1
If my_space.my_view.v1
maps properties in the containers my_space.c1
and my_space.c2
. The filter will match
if there is data in my_space.my_container AND (my_space.c1 AND my_space.c2)
if there is no filter defined on
my_space.my_view.v1
, and my_space.my_container AND my_space.my_view.v1.filter
if there is a filter defined on
my_space.my_view.v1
.
Parameters
Values in filters can be parameterised. Parameters are provided as part of the query object, and not in the filter itself.
This filter is parameterised:
range:
property: [imdb, movie, released]
gte: {parameter: start}
A query containing this filter will only run if the parameter start
is provided. The parameter must be compatible
with all the types and operators that refer to the parameter. In the above example, the "released" property is a date.
Thus, the start parameter must be compatible with the date type, or the query will fail completely, even if the range
filter is optional because it's OR-ed
TIP
Parameterise your filters!
It's a best practice to parameterise queries that take user input. This enables reusing query plans across queries, which will be noticable with read-heavy workloads.
Sorting and Limiting
Sorting and limiting can happen in multiple places in a query:
- In the result set expression, i.e. in the
with
object that defines a node or edge set. - In the result selection, i.e. under
select
where defined sets can be emitted as results.
Sorting and limiting the set definitions under with
will transitively affect dependent sets.
Changes to a set defined under with
will naturally affect sets that depend on it, transitively. If you only change
the sort order of a with
expression, dependent sets will not (necessarily) change (based on how the dependent sets
are defined), but if you put a limit on an expression, all dependent sets will inherit this and change as a consequence.
This is also true for sets that aren't actually emitted via select
, i.e. sets that are only defined as stepping-stones
for other sets.
Sorts and limits defined under select
changes the result appearing order for that set only, and not for depending
sets.
Example:
with:
some_nodes:
… # omitted. No sort here
some_edges:
from: some_nodes
# omitted. also no sorting
target_nodes:
from: some_edges
# …
select:
some_nodes:
properties: ...
sort:
- {property: [node, created], direction: descending}
limit: 100
The above query would still let some_edges
and target_nodes
pull from the full amount of nodes in some_nodes
,
even though what's returned as a result for some_nodes
is capped at 100.
Order of sorting and limiting
NOTE
A limit in an edge traversal applies to when to start traversing, which happens before sorting.
Nodes and edges have subtly different sorting and limiting behaviour: Nodes sort and limit simultaneously, while recursive edge exploration do limited traversal, then sort.
The top-n set of nodes sorted by some property will be guaranteed to have the top-n of that property for the set.
For edges found through traversal, i.e. via edges
, the limit
applies to how many edges to discover. This may not
be all the edges that could have been discovered in a full traversal. If you start traversing from some node and ask
for 100 edges sorted by creation timestamp, the 100 edges discovered before traversal stops get sorted. The full graph
is not traversed in order to find the 100 newest edges that exist in the graph defined by the traversal filters.
Therefore, to do sorting with a recursive graph traversal, you'll need to specify the sort configuration via postSort
.
An edge traversal with maxDistance=1
can take a normal sort
configuration, however.
Limitations
Graph traversal
Any query that involves a graph traversal will force nested loop-style execution. This will work well enough for traversals limited to a few hundred thousand unique paths.
The graph traversal is breadth first. All possible paths are traversed. This is important to keep in mind with traversals across loops. For example, a fully connected graph will not do well in a query that follows all possible paths, and is very likely to be terminated due to constraints on either time, memory, or temporary disk usage.
Timeout errors
Queries get cancelled with a 408 Request Timeout error if they take longer than the timeout. If hitting a timeout like this you will need to reduce load or contention, or optimise your query.
Retrieve up to 100 containers by their specified external ids.
Retrieve up to 100 data models by their external ids. Views can be auto-expanded when the InlineViews
query parameter is set.
Retrieves a list of data points from multiple time series in a project. This operation supports aggregation and pagination. Learn more about aggregation.
Note: when start
isn't specified in the top level and for an individual item, it will default to epoch 0, which is 1 January, 1970, thus
excluding potential existent data points before 1970. start
needs to be specified as a negative number to get data points before 1970.
Retrieves the latest data point in one or more time series. Note that the latest data point in a time series is the one with the highest timestamp, which is not necessarily the one that was ingested most recently.
Retrieve up to 1000 nodes or edges by their external ids.
Retrieve up to 100 spaces by specifying their space-ids.
Retrieves one or more time series by ID or external ID. The response returns the time series in the same order as in the request.
Retrieve up to 100 views by their external ids.
Search text fields in views for nodes or edge(s). The service will return up to 1000 results. This operation orders the results by relevance, across the specified spaces.
Fulltext search for time series based on result relevance. Primarily meant for human-centric use cases, not for programs, since matching and order may change over time. Additional filters can also be specified. This operation does not support pagination.
Subscribe to changes for nodes and edges in a project, matching a supplied filter. This endpoint will always return a NextCursor
. The sync specification mirrors the query interface, but sorting is not currently supported.
Updates one or more time series. Fields outside of the request remain unchanged.
For primitive fields (those whose type is string, number, or boolean), use "set": value
to update the value; use "setNull": true
to set the field to null.
For JSON array fields (for example securityCategories
), use "set": [value1, value2]
to
update the value; use "add": [value1, value2]
to add values; use
"remove": [value1, value2]
to remove values.
Aggregate data across nodes or edges
Aggregate data for nodes or edges in a project. You can use an optional query or filter specification to limit the result.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
view type
|
type | string |
type |
|
view space
|
space | string |
space |
|
view externalId
|
externalId | string |
externalId |
|
view version
|
version | string |
version |
|
query
|
query | string |
query |
|
properties
|
properties | array of string |
properties |
|
limit
|
limit | integer |
limit |
|
aggregates
|
aggregates | object | ||
groupBy
|
groupBy | array of string |
groupBy |
|
filter
|
filter | object |
filter |
|
instanceType
|
instanceType | string |
instanceType |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
instanceType
|
items.instanceType | string |
instanceType |
aggregates
|
items.aggregates | array of object |
aggregates |
aggregate
|
items.aggregates.aggregate | string |
aggregate |
property
|
items.aggregates.property | string |
property |
value
|
items.aggregates.value | float |
value |
name
|
items.group.name | string |
name |
tag
|
items.group.tag | string |
tag |
type
|
typing.dolore_7d.type.type | string |
type |
list
|
typing.dolore_7d.type.list | boolean |
list |
collation
|
typing.dolore_7d.type.collation | string |
collation |
nullable
|
typing.dolore_7d.nullable | boolean |
nullable |
autoIncrement
|
typing.dolore_7d.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.dolore_7d.defaultValue | string |
defaultValue |
description
|
typing.dolore_7d.description | string |
description |
name
|
typing.dolore_7d.name | string |
name |
type
|
typing.tempor560.type.type | string |
type |
list
|
typing.tempor560.type.list | boolean |
list |
collation
|
typing.tempor560.type.collation | string |
collation |
nullable
|
typing.tempor560.nullable | boolean |
nullable |
autoIncrement
|
typing.tempor560.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.tempor560.defaultValue | string |
defaultValue |
description
|
typing.tempor560.description | string |
description |
name
|
typing.tempor560.name | string |
name |
Aggregate time series
The aggregation API allows you to compute aggregated results from a set of time series, such as
getting the number of time series in a project or checking what assets the different time series
in your project are associated with (along with the number of time series for each asset).
By specifying filter
and/or advancedFilter
, the aggregation will take place only over those
time series that match the filters. filter
and advancedFilter
behave the same way as in the
list
endpoint.
The default behavior, when the aggregate
field is not specified the request body, is to return the
number of time series that match the filters (if any), which is the same behavior as when the
aggregate
field is set to count
.
The following requests will both return the total number of
time series whose name
begins with pump
:
{
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}}
}
and
{
"aggregate": "count",
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}}
}
The response might be:
{"items": [{"count": 42}]}
Setting aggregate
to uniqueValues
and specifying a property in properties
(this field is an array, but currently only supports one property) will
return all unique values (up to a maximum of 1000) that are taken on by that property
across all the time series that match the filters, as well as the number of time series that
have each of those property values.
This example request finds all the unique asset ids that are
referenced by the time series in your project whose name
begins with pump
:
{
"aggregate": "uniqueValues",
"properties": [{"property": ["assetId"]}],
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}}
}
The response might be the following, saying that 23 time series are associated with asset 18 and 107 time series are associated with asset 76:
{
"items": [
{"values": ["18"], "count": 23},
{"values": ["76"], "count": 107}
]
}
Setting aggregate
to cardinalityValues
will instead return the approximate number of
distinct values that are taken on by the given property among the matching time series.
Example request:
{
"aggregate": "cardinalityValues",
"properties": [{"property": ["assetId"]}],
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}}
}
The result is likely exact when the set of unique values is small. In this example, there are likely two distinct asset ids among the matching time series:
{"items": [{"count": 2}]}
Setting aggregate
to uniqueProperties
will return the set of unique properties whose property
path begins with path
(which can currently only be ["metadata"]
) that are contained in the time series that match the filters.
Example request:
{
"aggregate": "uniqueProperties",
"path": ["metadata"],
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}}
}
The result contains all the unique metadata keys in the time series whose name
begins with
pump
, and the number of time series that contains each metadata key:
{
"items": [
{"values": [{"property": ["metadata", "tag"]}], "count": 43},
{"values": [{"property": ["metadata", "installationDate"]}], "count": 97}
]
}
Setting aggregate
to cardinalityProperties
will instead return the approximate number of
different property keys whose path begins with path
(which can currently only be ["metadata"]
, meaning that this can only be used to count the approximate number of distinct metadata keys among the matching time series).
Example request:
{
"aggregate": "cardinalityProperties",
"path": ["metadata"],
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}}
}
The result is likely exact when the set of unique values is small. In this example, there are likely two distinct metadata keys among the matching time series:
{"items": [{"count": 2}]}
The aggregateFilter
field may be specified if aggregate
is set to cardinalityProperties
or uniqueProperties
. The structure of this field is similar to that of advancedFilter
, except that the set of leaf filters is smaller (in
, prefix
, and range
), and that none of the leaf filters specify a property. Unlike advancedFilter
, which is applied before the aggregation (in order to restrict the set of time series that the aggregation operation should be applied to), aggregateFilter
is applied after the initial aggregation has been performed, in order to restrict the set of results.
Click here for more details about aggregateFilter
.
When aggregate
is set to uniqueProperties
, the result set contains a number of property paths, each with an associated count that shows how many time series contained that property (among those time series that matched the filter
and advancedFilter
, if they were specified) . If aggregateFilter
is specified, it will restrict the property paths included in the output. Let us add an aggregateFilter
to the uniqueProperties
example from above:
{
"aggregate": "uniqueProperties",
"path": ["metadata"],
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}},
"aggregateFilter": {"prefix": {"value": "t"}}
}
Now, the result only contains those metadata properties whose key begins with t
(but it will be the same set of metadata properties that begin with t
as in the original query without aggregateFilter
, and the counts will be the same):
{
"items": [
{"values": [{"property": ["metadata", "tag"]}], "count": 43}
]
}
Similarly, adding aggregateFilter
to cardinalityProperties
will return the approximate number of properties whose property key matches aggregateFilter
from those time series matching the filter
and advancedFilter
(or from all time series if neither filter
nor aggregateFilter
are specified):
{
"aggregate": "cardinalityProperties",
"path": ["metadata"],
"advancedFilter": {"prefix": {"property": ["name"], "value": "pump"}},
"aggregateFilter": {"prefix": {"value": "t"}}
}
As we saw above, only one property matches:
{"items": [{"count": 1}]}
Note that aggregateFilter
is also accepted when aggregate
is set to cardinalityValues
or cardinalityProperties
. For those aggregations, the effect of any aggregateFilter
could also be achieved via a similar advancedFilter
. However, aggregateFilter
is not accepted when aggregate
is omitted or set to count
.
Rate and concurrency limits
Rate and concurrency limits apply this endpoint. If a request exceeds one of the limits,
it will be throttled with a 429: Too Many Requests
response. More on limit types
and how to avoid being throttled is described
here.
Limit | Per project | Per user (identity) |
---|---|---|
Rate | 15 requests per second | 10 requests per second |
Concurrency | 6 concurrent requests | 4 concurrent requests |
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
advancedFilter
|
advancedFilter | object |
advancedFilter |
|
filter name
|
name | string |
name |
|
filter unit
|
unit | string |
unit |
|
filter isString
|
isString | boolean |
isString |
|
filter isStep
|
isStep | boolean |
isStep |
|
filter metadata
|
metadata | object |
metadata |
|
filter assetIds
|
assetIds | array of integer |
assetIds |
|
filter assetExternalIds
|
assetExternalIds | array of string |
assetExternalIds |
|
filter rootAssetIds
|
rootAssetIds | array of integer |
rootAssetIds |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
filter externalIdPrefix
|
externalIdPrefix | string |
externalIdPrefix |
|
filter createdTime max
|
max | integer |
max |
|
filter createdTime min
|
min | integer |
min |
|
filter lastUpdatedTime max
|
max | integer |
max |
|
filter lastUpdatedTime min
|
min | integer |
min |
|
aggregateFilter
|
aggregateFilter | object |
aggregateFilter |
|
aggregate
|
aggregate | string |
aggregate |
|
properties
|
properties | object |
properties |
|
path
|
path | array of string |
path |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
count
|
items.count | integer |
count |
Create or update containers
Add or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for containers that remain unchanged.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
properties
|
properties | object |
properties |
|
name
|
name | string |
name |
|
description
|
description | string |
description |
|
usedFor
|
usedFor | string |
usedFor |
|
constraints
|
constraints | object |
constraints |
|
indexes
|
indexes | object |
indexes |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
type
|
items.properties.exercitation_98.type.type | string |
type |
list
|
items.properties.exercitation_98.type.list | boolean |
list |
collation
|
items.properties.exercitation_98.type.collation | string |
collation |
nullable
|
items.properties.exercitation_98.nullable | boolean |
nullable |
autoIncrement
|
items.properties.exercitation_98.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.exercitation_98.defaultValue | string |
defaultValue |
description
|
items.properties.exercitation_98.description | string |
description |
name
|
items.properties.exercitation_98.name | string |
name |
type
|
items.properties.do2.type.type | string |
type |
list
|
items.properties.do2.type.list | boolean |
list |
collation
|
items.properties.do2.type.collation | string |
collation |
nullable
|
items.properties.do2.nullable | boolean |
nullable |
autoIncrement
|
items.properties.do2.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.do2.defaultValue | string |
defaultValue |
description
|
items.properties.do2.description | string |
description |
name
|
items.properties.do2.name | string |
name |
type
|
items.properties.ad_8.type.type | string |
type |
list
|
items.properties.ad_8.type.list | boolean |
list |
collation
|
items.properties.ad_8.type.collation | string |
collation |
nullable
|
items.properties.ad_8.nullable | boolean |
nullable |
autoIncrement
|
items.properties.ad_8.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.ad_8.defaultValue | string |
defaultValue |
description
|
items.properties.ad_8.description | string |
description |
name
|
items.properties.ad_8.name | string |
name |
type
|
items.properties.eiusmod4c5.type.type | string |
type |
list
|
items.properties.eiusmod4c5.type.list | boolean |
list |
collation
|
items.properties.eiusmod4c5.type.collation | string |
collation |
nullable
|
items.properties.eiusmod4c5.nullable | boolean |
nullable |
autoIncrement
|
items.properties.eiusmod4c5.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.eiusmod4c5.defaultValue | string |
defaultValue |
description
|
items.properties.eiusmod4c5.description | string |
description |
name
|
items.properties.eiusmod4c5.name | string |
name |
space
|
items.space | string |
space |
usedFor
|
items.usedFor | string |
usedFor |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
type
|
items.constraints.adipisicingf92.require.type | string |
type |
space
|
items.constraints.adipisicingf92.require.space | string |
space |
externalId
|
items.constraints.adipisicingf92.require.externalId | string |
externalId |
constraintType
|
items.constraints.adipisicingf92.constraintType | string |
constraintType |
type
|
items.constraints.laborum_a.require.type | string |
type |
space
|
items.constraints.laborum_a.require.space | string |
space |
externalId
|
items.constraints.laborum_a.require.externalId | string |
externalId |
constraintType
|
items.constraints.laborum_a.constraintType | string |
constraintType |
type
|
items.constraints.adcb.require.type | string |
type |
space
|
items.constraints.adcb.require.space | string |
space |
externalId
|
items.constraints.adcb.require.externalId | string |
externalId |
constraintType
|
items.constraints.adcb.constraintType | string |
constraintType |
properties
|
items.indexes.aliqua_c.properties | array of string |
properties |
indexType
|
items.indexes.aliqua_c.indexType | string |
indexType |
cursorable
|
items.indexes.aliqua_c.cursorable | boolean |
cursorable |
properties
|
items.indexes.ut_d.properties | array of string |
properties |
indexType
|
items.indexes.ut_d.indexType | string |
indexType |
cursorable
|
items.indexes.ut_d.cursorable | boolean |
cursorable |
properties
|
items.indexes.elit13f.properties | array of string |
properties |
indexType
|
items.indexes.elit13f.indexType | string |
indexType |
cursorable
|
items.indexes.elit13f.cursorable | boolean |
cursorable |
properties
|
items.indexes.voluptate_903.properties | array of string |
properties |
indexType
|
items.indexes.voluptate_903.indexType | string |
indexType |
cursorable
|
items.indexes.voluptate_903.cursorable | boolean |
cursorable |
properties
|
items.indexes.magna_b9.properties | array of string |
properties |
indexType
|
items.indexes.magna_b9.indexType | string |
indexType |
cursorable
|
items.indexes.magna_b9.cursorable | boolean |
cursorable |
Create or update data models
Add or update (upsert) data models. For unchanged data model specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for models that remain unchanged.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
|
name
|
name | string |
name |
|
description
|
description | string |
description |
|
views
|
views | object |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
space
|
items.space | string |
space |
version
|
items.version | string |
version |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
views
|
items.views | array of object |
views |
type
|
items.views.type | string |
type |
space
|
items.views.space | string |
space |
externalId
|
items.views.externalId | string |
externalId |
version
|
items.views.version | string |
version |
Create or update nodes or edges
Create or update nodes and edges in a transaction. The items
field of the payload is an array of objects
where each object describes a node or an edge to create, patch or replace. The instanceType
field of
each object must be node
or edge
and determines how the rest of the object is interpreted.
This operation is currently limited to 1000 nodes and/or edges at a time.
Individual nodes and edges are uniquely identified by their externalId and space.
Creating new instances
When there is no node or edge with the given externalId in the given space, a node will be created and the
properties provided for each of the containers or views in the sources
array will be populated for the
node/edge. Nodes can also be created implicitly when an edge between them is created (if
autoCreateStartNodes
and/or autoCreateEndNodes
is set), or when a direct relation
property is set, the target node does not exist and autoCreateDirectRelations
is set.
To add a node or edge, the user must have capabilities to access (write to) both the view(s) referenced in
sources
and the container(s) underlying these views, as well as any directly referenced containers.
Updating (patching) or replacing instances
When a node or edge (instance) with the given externalId already exists in a space, the
properties named in the sources
field will be written to the instance. Other properties will remain
unchanged. To replace the whole set of properties for an instance (a node or an edge) rather than patch the
instance, set the replace
parameter to true
.
If you use a writable view to update properties (that is, the source you are referring to in sources
is a view), you must have write access to the view as well as all of its backing containers.
No-change patch operations
When a node/edge item has no changes compared to the existing instance - that is, when the supplied property
values are equal to the corresponding values in the existing node/edge, the node/edge will stay unchanged.
In this case, the lastUpdatedTime
values for the nodes or edges in question will not change.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
items
|
items | object | ||
autoCreateDirectRelations
|
autoCreateDirectRelations | boolean |
autoCreateDirectRelations |
|
autoCreateStartNodes
|
autoCreateStartNodes | boolean |
autoCreateStartNodes |
|
autoCreateEndNodes
|
autoCreateEndNodes | boolean |
autoCreateEndNodes |
|
skipOnVersionConflict
|
skipOnVersionConflict | boolean |
skipOnVersionConflict |
|
replace
|
replace | boolean |
replace |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
instanceType
|
items.instanceType | string |
instanceType |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
wasModified
|
items.wasModified | boolean |
wasModified |
version
|
items.version | integer |
version |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
Create or update spaces
Add or update (upsert) spaces. For unchanged space specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for spaces that remain unchanged.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
description
|
description | string |
description |
|
name
|
name | string |
name |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
space
|
items.space | string |
space |
description
|
items.description | string |
description |
name
|
items.name | string |
name |
Create or update views
Add or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the lastUpdatedTime
value for views that remain unchanged.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
externalId
|
externalId | string |
externalId |
|
space
|
space | string |
space |
|
version
|
version | string |
version |
|
name
|
name | string |
name |
|
description
|
description | string |
description |
|
filter
|
filter | object |
filter |
|
type
|
type | string |
type |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
|
properties
|
properties | object |
properties |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
type
|
items.properties.ea_603.container.type | string |
type |
space
|
items.properties.ea_603.container.space | string |
space |
externalId
|
items.properties.ea_603.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.ea_603.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.ea_603.type.type | string |
type |
list
|
items.properties.ea_603.type.list | boolean |
list |
collation
|
items.properties.ea_603.type.collation | string |
collation |
nullable
|
items.properties.ea_603.nullable | boolean |
nullable |
autoIncrement
|
items.properties.ea_603.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.ea_603.defaultValue | string |
defaultValue |
description
|
items.properties.ea_603.description | string |
description |
name
|
items.properties.ea_603.name | string |
name |
type
|
items.properties.Excepteurd7.container.type | string |
type |
space
|
items.properties.Excepteurd7.container.space | string |
space |
externalId
|
items.properties.Excepteurd7.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.Excepteurd7.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.Excepteurd7.type.type | string |
type |
list
|
items.properties.Excepteurd7.type.list | boolean |
list |
collation
|
items.properties.Excepteurd7.type.collation | string |
collation |
nullable
|
items.properties.Excepteurd7.nullable | boolean |
nullable |
autoIncrement
|
items.properties.Excepteurd7.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.Excepteurd7.defaultValue | string |
defaultValue |
description
|
items.properties.Excepteurd7.description | string |
description |
name
|
items.properties.Excepteurd7.name | string |
name |
type
|
items.properties.officia_6.container.type | string |
type |
space
|
items.properties.officia_6.container.space | string |
space |
externalId
|
items.properties.officia_6.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.officia_6.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.officia_6.type.type | string |
type |
list
|
items.properties.officia_6.type.list | boolean |
list |
collation
|
items.properties.officia_6.type.collation | string |
collation |
nullable
|
items.properties.officia_6.nullable | boolean |
nullable |
autoIncrement
|
items.properties.officia_6.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.officia_6.defaultValue | string |
defaultValue |
description
|
items.properties.officia_6.description | string |
description |
name
|
items.properties.officia_6.name | string |
name |
type
|
items.properties.nisidb.container.type | string |
type |
space
|
items.properties.nisidb.container.space | string |
space |
externalId
|
items.properties.nisidb.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.nisidb.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.nisidb.type.type | string |
type |
list
|
items.properties.nisidb.type.list | boolean |
list |
collation
|
items.properties.nisidb.type.collation | string |
collation |
nullable
|
items.properties.nisidb.nullable | boolean |
nullable |
autoIncrement
|
items.properties.nisidb.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.nisidb.defaultValue | string |
defaultValue |
description
|
items.properties.nisidb.description | string |
description |
name
|
items.properties.nisidb.name | string |
name |
type
|
items.properties.ut3.container.type | string |
type |
space
|
items.properties.ut3.container.space | string |
space |
externalId
|
items.properties.ut3.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.ut3.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.ut3.type.type | string |
type |
list
|
items.properties.ut3.type.list | boolean |
list |
collation
|
items.properties.ut3.type.collation | string |
collation |
nullable
|
items.properties.ut3.nullable | boolean |
nullable |
autoIncrement
|
items.properties.ut3.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.ut3.defaultValue | string |
defaultValue |
description
|
items.properties.ut3.description | string |
description |
name
|
items.properties.ut3.name | string |
name |
space
|
items.space | string |
space |
usedFor
|
items.usedFor | string |
usedFor |
version
|
items.version | string |
version |
writable
|
items.writable | boolean |
writable |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
and
|
items.filter.and | array of object |
and |
value
|
items.filter.and.value | string |
value |
implements
|
items.implements | array of object |
implements |
type
|
items.implements.type | string |
type |
space
|
items.implements.space | string |
space |
externalId
|
items.implements.externalId | string |
externalId |
version
|
items.implements.version | string |
version |
Create time series
Creates one or more time series.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
externalId
|
externalId | string |
externalId |
|
name
|
name | string |
name |
|
isString
|
isString | boolean |
isString |
|
metadata
|
metadata | object |
metadata |
|
unit
|
unit | string |
unit |
|
assetId
|
assetId | integer |
assetId |
|
isStep
|
isStep | boolean |
isStep |
|
description
|
description | string |
description |
|
securityCategories
|
securityCategories | array of integer |
securityCategories |
|
dataSetId
|
dataSetId | integer |
dataSetId |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
id
|
items.id | integer |
id |
isString
|
items.isString | boolean |
isString |
isStep
|
items.isStep | boolean |
isStep |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
externalId
|
items.externalId | string |
externalId |
name
|
items.name | string |
name |
cupidatat4b_
|
items.metadata.cupidatat4b_ | string |
cupidatat4b_ |
reprehenderit36
|
items.metadata.reprehenderit36 | string |
reprehenderit36 |
unit
|
items.unit | string |
unit |
assetId
|
items.assetId | integer |
assetId |
description
|
items.description | string |
description |
securityCategories
|
items.securityCategories | array of integer |
securityCategories |
dataSetId
|
items.dataSetId | integer |
dataSetId |
Delete constraints from containers
Delete one or more container constraints. Currently limited to 10 constraints at a time.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
containerExternalId
|
containerExternalId | string |
containerExternalId |
|
identifier
|
identifier | string |
identifier |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
space
|
items.space | string |
space |
containerExternalId
|
items.containerExternalId | string |
containerExternalId |
identifier
|
items.identifier | string |
identifier |
Delete containers
Delete one or more containers. Currently limited to 100 containers at a time. You cannot delete a container when one or more data model(s) or view(s) references it.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
Delete data models
Delete one or more data models. Currently limited to 100 models at a time. This does not delete the views, nor the containers they reference.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
version
|
items.version | string |
version |
Delete data points
Delete data points from time series.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
inclusiveBegin
|
inclusiveBegin | integer |
inclusiveBegin |
|
exclusiveEnd
|
exclusiveEnd | integer |
exclusiveEnd |
Returns
- response
- object
Delete indexes from containers
Delete one or more container indexes. Currently limited to 10 indexes at a time.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
containerExternalId
|
containerExternalId | string |
containerExternalId |
|
identifier
|
identifier | string |
identifier |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
space
|
items.space | string |
space |
containerExternalId
|
items.containerExternalId | string |
containerExternalId |
identifier
|
items.identifier | string |
identifier |
Delete nodes or edges
Delete nodes and edges in a transaction. Limited to 1000 nodes or edges at a time.
When a node is selected for deletion, all connected incoming and outgoing edges that point to or from it are also deleted. However, please note that the operation might fail if the node has a high number of edge connections. If this is the case, consider deleting the edges connected to the node before deleting the node itself.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
instanceType
|
instanceType | string |
instanceType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
instanceType
|
items.instanceType | string |
instanceType |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
Delete spaces
Delete one or more spaces. Currently limited to 100 spaces at a time.
If an existing data model references a space, you cannot delete that space. Nodes, edges and other data types that are part of a space will no longer be available.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
space
|
items.space | string |
space |
Delete time series
Deletes the time series with the specified IDs and their data points.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
ignoreUnknownIds
|
ignoreUnknownIds | boolean |
ignoreUnknownIds |
Returns
- response
- object
Delete views
Delete one or more views. Currently limited to 100 views at a time. The service cannot delete a view referenced by a data model.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
version
|
items.version | string |
version |
Filter nodes or edges
Filter the instances - nodes and edges - in a project.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
includeTyping
|
includeTyping | boolean |
includeTyping |
|
type
|
type | string |
type |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
|
instanceType
|
instanceType | string |
instanceType |
|
cursor
|
cursor | string |
cursor |
|
limit
|
limit | integer |
limit |
|
property
|
property | array of string |
property |
|
direction
|
direction | string |
direction |
|
nullsFirst
|
nullsFirst | boolean |
nullsFirst |
|
filter
|
filter | object |
filter |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
instanceType
|
items.instanceType | string |
instanceType |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.version | integer |
version |
deletedTime
|
items.deletedTime | integer |
deletedTime |
nisi1
|
items.properties.nostrudd.voluptate_9c9.nisi1 | string |
nisi1 |
anim2
|
items.properties.ex_3.Duis_45.anim2 | string |
anim2 |
pariature7e
|
items.properties.ex_3.Duis_45.pariature7e | string |
pariature7e |
dolor5
|
items.properties.ipsum_8.dolorc6.dolor5 | string |
dolor5 |
fugiat_f
|
items.properties.ipsum_8.dolorc6.fugiat_f | string |
fugiat_f |
Lorem_4
|
items.properties.ipsum_8.dolorc6.Lorem_4 | string |
Lorem_4 |
dolore72
|
items.properties.ipsum_8.ut_a8.dolore72 | string |
dolore72 |
deserunt_f3
|
items.properties.ipsum_8.anim01d.deserunt_f3 | string |
deserunt_f3 |
in_bbe
|
items.properties.ipsum_8.anim01d.in_bbe | string |
in_bbe |
in5
|
items.properties.ipsum_8.anim01d.in5 | string |
in5 |
culpa_858
|
items.properties.ad59.eiusmod__13.culpa_858 | string |
culpa_858 |
consequat0
|
items.properties.ad59.voluptate_8.consequat0 | string |
consequat0 |
culpa_e
|
items.properties.ad59.voluptate_8.culpa_e | string |
culpa_e |
aute__f9
|
items.properties.ad59.utc.aute__f9 | string |
aute__f9 |
minim_8a
|
items.properties.ad59.utc.minim_8a | string |
minim_8a |
do_5
|
items.properties.in_b_2.ut_.do_5 | string |
do_5 |
in8
|
items.properties.in_b_2.ut_.in8 | string |
in8 |
enim09
|
items.properties.in_b_2.aute_9.enim09 | string |
enim09 |
pariatur_2
|
items.properties.in_b_2.aute_9.pariatur_2 | string |
pariatur_2 |
nulla_6
|
items.properties.in_b_2.aute_9.nulla_6 | string |
nulla_6 |
type
|
typing.id58.dolor9.cillum_e1a.type.type | string |
type |
list
|
typing.id58.dolor9.cillum_e1a.type.list | boolean |
list |
collation
|
typing.id58.dolor9.cillum_e1a.type.collation | string |
collation |
nullable
|
typing.id58.dolor9.cillum_e1a.nullable | boolean |
nullable |
autoIncrement
|
typing.id58.dolor9.cillum_e1a.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.id58.dolor9.cillum_e1a.defaultValue | string |
defaultValue |
description
|
typing.id58.dolor9.cillum_e1a.description | string |
description |
name
|
typing.id58.dolor9.cillum_e1a.name | string |
name |
type
|
typing.id58.dolor9.nisi_6_3.type.type | string |
type |
list
|
typing.id58.dolor9.nisi_6_3.type.list | boolean |
list |
collation
|
typing.id58.dolor9.nisi_6_3.type.collation | string |
collation |
nullable
|
typing.id58.dolor9.nisi_6_3.nullable | boolean |
nullable |
autoIncrement
|
typing.id58.dolor9.nisi_6_3.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.id58.dolor9.nisi_6_3.defaultValue | string |
defaultValue |
description
|
typing.id58.dolor9.nisi_6_3.description | string |
description |
name
|
typing.id58.dolor9.nisi_6_3.name | string |
name |
type
|
typing.id58.dolor9.ex5fb.type.type | string |
type |
list
|
typing.id58.dolor9.ex5fb.type.list | boolean |
list |
collation
|
typing.id58.dolor9.ex5fb.type.collation | string |
collation |
nullable
|
typing.id58.dolor9.ex5fb.nullable | boolean |
nullable |
autoIncrement
|
typing.id58.dolor9.ex5fb.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.id58.dolor9.ex5fb.defaultValue | string |
defaultValue |
description
|
typing.id58.dolor9.ex5fb.description | string |
description |
name
|
typing.id58.dolor9.ex5fb.name | string |
name |
type
|
typing.id58.dolore_.eu164.type.type | string |
type |
list
|
typing.id58.dolore_.eu164.type.list | boolean |
list |
collation
|
typing.id58.dolore_.eu164.type.collation | string |
collation |
nullable
|
typing.id58.dolore_.eu164.nullable | boolean |
nullable |
autoIncrement
|
typing.id58.dolore_.eu164.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.id58.dolore_.eu164.defaultValue | string |
defaultValue |
description
|
typing.id58.dolore_.eu164.description | string |
description |
name
|
typing.id58.dolore_.eu164.name | string |
name |
type
|
typing.sint__.consequata.Loremd.type.type | string |
type |
list
|
typing.sint__.consequata.Loremd.type.list | boolean |
list |
collation
|
typing.sint__.consequata.Loremd.type.collation | string |
collation |
nullable
|
typing.sint__.consequata.Loremd.nullable | boolean |
nullable |
autoIncrement
|
typing.sint__.consequata.Loremd.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.sint__.consequata.Loremd.defaultValue | string |
defaultValue |
description
|
typing.sint__.consequata.Loremd.description | string |
description |
name
|
typing.sint__.consequata.Loremd.name | string |
name |
type
|
typing.sint__.consequata.enima.type.type | string |
type |
list
|
typing.sint__.consequata.enima.type.list | boolean |
list |
collation
|
typing.sint__.consequata.enima.type.collation | string |
collation |
nullable
|
typing.sint__.consequata.enima.nullable | boolean |
nullable |
autoIncrement
|
typing.sint__.consequata.enima.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.sint__.consequata.enima.defaultValue | string |
defaultValue |
description
|
typing.sint__.consequata.enima.description | string |
description |
name
|
typing.sint__.consequata.enima.name | string |
name |
type
|
typing.sint__.Duis_baa.reprehenderit_a.type.type | string |
type |
list
|
typing.sint__.Duis_baa.reprehenderit_a.type.list | boolean |
list |
collation
|
typing.sint__.Duis_baa.reprehenderit_a.type.collation | string |
collation |
nullable
|
typing.sint__.Duis_baa.reprehenderit_a.nullable | boolean |
nullable |
autoIncrement
|
typing.sint__.Duis_baa.reprehenderit_a.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.sint__.Duis_baa.reprehenderit_a.defaultValue | string |
defaultValue |
description
|
typing.sint__.Duis_baa.reprehenderit_a.description | string |
description |
name
|
typing.sint__.Duis_baa.reprehenderit_a.name | string |
name |
nextCursor
|
nextCursor | string |
nextCursor |
Filter time series
Retrieves a list of time series that match the given criteria.
Advanced filtering
The advancedFilter
field lets you create complex filtering expressions that combine simple operations,
such as equals
, prefix
, and exists
, by using the Boolean operators and
, or
, and not
.
Filtering applies to basic fields as well as metadata. See the advancedFilter
syntax in the request example.
Supported leaf filters
Leaf filter | Supported fields | Description and example |
---|---|---|
containsAll |
Array type fields | Only includes results which contain all of the specified values. {"containsAll": {"property": ["property"], "values": [1, 2, 3]}} |
containsAny |
Array type fields | Only includes results which contain at least one of the specified values. {"containsAny": {"property": ["property"], "values": [1, 2, 3]}} |
equals |
Non-array type fields | Only includes results that are equal to the specified value. {"equals": {"property": ["property"], "value": "example"}} |
exists |
All fields | Only includes results where the specified property exists (has a value). {"exists": {"property": ["property"]}} |
in |
Non-array type fields | Only includes results that are equal to one of the specified values. {"in": {"property": ["property"], "values": [1, 2, 3]}} |
prefix |
String type fields | Only includes results which start with the specified text. {"prefix": {"property": ["property"], "value": "example"}} |
range |
Non-array type fields | Only includes results that fall within the specified range. {"range": {"property": ["property"], "gt": 1, "lte": 5}} Supported operators: gt , lt , gte , lte |
search |
["name"] and ["description"] |
Introduced to provide functional parity with the /timeseries/search endpoint. {"search": {"property": ["property"], "value": "example"}} |
Supported properties
Property | Type |
---|---|
["description"] |
string |
["externalId"] |
string |
["metadata", "<someCustomKey>"] |
string |
["name"] |
string |
["unit"] |
string |
["assetId"] |
number |
["assetRootId"] |
number |
["createdTime"] |
number |
["dataSetId"] |
number |
["id"] |
number |
["lastUpdatedTime"] |
number |
["isStep"] |
Boolean |
["isString"] |
Boolean |
["accessCategories"] |
array of strings |
["securityCategories"] |
array of numbers |
Limits
- Filter query max depth: 10.
- Filter query max number of clauses: 100.
and
andor
clauses must have at least one element (and at most 99, since each element counts towards the total clause limit, and so does theand
/or
clause itself).- The
property
array of each leaf filter has the following limitations:- Number of elements in the array is 1 or 2.
- Elements must not be null or blank.
- Each element max length is 256 characters.
- The
property
array must match one of the existing properties (static top-level property or dynamic metadata property).
containsAll
,containsAny
, andin
filtervalues
array size must be in the range [1, 100].containsAll
,containsAny
, andin
filtervalues
array must contain elements of number or string type (matching the type of the given property).range
filter must have at lest one ofgt
,gte
,lt
,lte
attributes. Butgt
is mutually exclusive togte
, whilelt
is mutually exclusive tolte
.gt
,gte
,lt
,lte
in therange
filter must be of number or string type (matching the type of the given property).search
filtervalue
must not be blank, and the length must be in the range [1, 128], and there may be at most twosearch
filters in the entire filter query.- The maximum length of the
value
of a leaf filter that is applied to a string property is 256.
Sorting
By default, time series are sorted by their creation time in ascending order.
Sorting by another property or by several other properties can be explicitly requested via the
sort
field, which must contain a list
of one or more sort specifications. Each sort specification indicates the property
to sort on
and, optionally, the order
in which to sort (defaults to asc
). If multiple sort specifications are
supplied, the results are sorted on the first property, and those with the same value for the first
property are sorted on the second property, and so on.
Partitioning is done independently of sorting; there is no guarantee of sort order between elements from different partitions.
Null values
In case the nulls
field has the auto
value, or the field isn't specified, null (missing) values
are considered bigger than any other values. They are placed last when sorting in the asc
order and first in the desc
order. Otherwise, missing values are placed according to
the nulls
field (last
or first
), and their placement won't depend on the order
field. Note that the number zero, empty strings, and empty lists are all considered
not null.
Example
{
"sort": [
{
"property" : ["createdTime"],
"order": "desc",
"nulls": "last"
},
{
"property" : ["metadata", "<someCustomKey>"]
}
]
}
Properties
You can sort on the following properties:
Property |
---|
["assetId"] |
["createdTime"] |
["dataSetId"] |
["description"] |
["externalId"] |
["lastUpdatedTime"] |
["metadata", "<someCustomKey>"] |
["name"] |
Limits
The sort
array must contain 1 to 2 elements.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
filter name
|
name | string |
name |
|
filter unit
|
unit | string |
unit |
|
filter isString
|
isString | boolean |
isString |
|
filter isStep
|
isStep | boolean |
isStep |
|
filter metadata
|
metadata | object |
metadata |
|
filter assetIds
|
assetIds | array of integer |
assetIds |
|
filter assetExternalIds
|
assetExternalIds | array of string |
assetExternalIds |
|
filter rootAssetIds
|
rootAssetIds | array of integer |
rootAssetIds |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
filter externalIdPrefix
|
externalIdPrefix | string |
externalIdPrefix |
|
filter createdTime max
|
max | integer |
max |
|
filter createdTime min
|
min | integer |
min |
|
filter lastUpdatedTime max
|
max | integer |
max |
|
filter lastUpdatedTime min
|
min | integer |
min |
|
advancedFilter
|
advancedFilter | object |
advancedFilter |
|
limit
|
limit | integer |
limit |
|
cursor
|
cursor | string |
cursor |
|
partition
|
partition | string |
partition |
|
property
|
property | array of string |
property |
|
order
|
order | string |
order |
|
nulls
|
nulls | string |
nulls |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
id
|
items.id | integer |
id |
isString
|
items.isString | boolean |
isString |
isStep
|
items.isStep | boolean |
isStep |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
externalId
|
items.externalId | string |
externalId |
name
|
items.name | string |
name |
tempord
|
items.metadata.tempord | string |
tempord |
eiusmod_0_3
|
items.metadata.eiusmod_0_3 | string |
eiusmod_0_3 |
auteb
|
items.metadata.auteb | string |
auteb |
unit
|
items.unit | string |
unit |
assetId
|
items.assetId | integer |
assetId |
description
|
items.description | string |
description |
securityCategories
|
items.securityCategories | array of integer |
securityCategories |
dataSetId
|
items.dataSetId | integer |
dataSetId |
nextCursor
|
nextCursor | string |
nextCursor |
Insert data points
Insert data points into a time series. You can do this for multiple time series. If you insert a data point with a timestamp that already exists, it will be overwritten with the new value.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
timestamp
|
timestamp | integer |
timestamp |
|
value
|
value | float |
value |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
Returns
- response
- object
List containers defined in the project
List of containers defined in the current project. You can filter the list by specifying a space.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
limit
|
limit | integer |
Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit. |
|
cursor
|
cursor | string |
Cursor for paging through results. |
|
space
|
space | string |
The space to query. |
|
includeGlobal
|
includeGlobal | boolean |
If the global items of the entity should be returned. Defaults to false which excludes global items. |
|
Accept
|
Accept | string |
Accept Header MimeType |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
type
|
items.properties.amet__.type.type | string |
type |
list
|
items.properties.amet__.type.list | boolean |
list |
collation
|
items.properties.amet__.type.collation | string |
collation |
nullable
|
items.properties.amet__.nullable | boolean |
nullable |
autoIncrement
|
items.properties.amet__.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.amet__.defaultValue | string |
defaultValue |
description
|
items.properties.amet__.description | string |
description |
name
|
items.properties.amet__.name | string |
name |
type
|
items.properties.deserunt56.type.type | string |
type |
list
|
items.properties.deserunt56.type.list | boolean |
list |
collation
|
items.properties.deserunt56.type.collation | string |
collation |
nullable
|
items.properties.deserunt56.nullable | boolean |
nullable |
autoIncrement
|
items.properties.deserunt56.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.deserunt56.defaultValue | string |
defaultValue |
description
|
items.properties.deserunt56.description | string |
description |
name
|
items.properties.deserunt56.name | string |
name |
type
|
items.properties.ind19.type.type | string |
type |
list
|
items.properties.ind19.type.list | boolean |
list |
collation
|
items.properties.ind19.type.collation | string |
collation |
nullable
|
items.properties.ind19.nullable | boolean |
nullable |
autoIncrement
|
items.properties.ind19.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.ind19.defaultValue | string |
defaultValue |
description
|
items.properties.ind19.description | string |
description |
name
|
items.properties.ind19.name | string |
name |
type
|
items.properties.sedf.type.type | string |
type |
list
|
items.properties.sedf.type.list | boolean |
list |
collation
|
items.properties.sedf.type.collation | string |
collation |
nullable
|
items.properties.sedf.nullable | boolean |
nullable |
autoIncrement
|
items.properties.sedf.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.sedf.defaultValue | string |
defaultValue |
description
|
items.properties.sedf.description | string |
description |
name
|
items.properties.sedf.name | string |
name |
space
|
items.space | string |
space |
usedFor
|
items.usedFor | string |
usedFor |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
type
|
items.constraints.reprehenderite.require.type | string |
type |
space
|
items.constraints.reprehenderite.require.space | string |
space |
externalId
|
items.constraints.reprehenderite.require.externalId | string |
externalId |
constraintType
|
items.constraints.reprehenderite.constraintType | string |
constraintType |
type
|
items.constraints.proident87.require.type | string |
type |
space
|
items.constraints.proident87.require.space | string |
space |
externalId
|
items.constraints.proident87.require.externalId | string |
externalId |
constraintType
|
items.constraints.proident87.constraintType | string |
constraintType |
type
|
items.constraints.occaecat5.require.type | string |
type |
space
|
items.constraints.occaecat5.require.space | string |
space |
externalId
|
items.constraints.occaecat5.require.externalId | string |
externalId |
constraintType
|
items.constraints.occaecat5.constraintType | string |
constraintType |
type
|
items.constraints.aliquip__b7.require.type | string |
type |
space
|
items.constraints.aliquip__b7.require.space | string |
space |
externalId
|
items.constraints.aliquip__b7.require.externalId | string |
externalId |
constraintType
|
items.constraints.aliquip__b7.constraintType | string |
constraintType |
properties
|
items.indexes.elit59_.properties | array of string |
properties |
indexType
|
items.indexes.elit59_.indexType | string |
indexType |
cursorable
|
items.indexes.elit59_.cursorable | boolean |
cursorable |
properties
|
items.indexes.laborum_e8.properties | array of string |
properties |
indexType
|
items.indexes.laborum_e8.indexType | string |
indexType |
cursorable
|
items.indexes.laborum_e8.cursorable | boolean |
cursorable |
properties
|
items.indexes.ut_8bc.properties | array of string |
properties |
indexType
|
items.indexes.ut_8bc.indexType | string |
indexType |
cursorable
|
items.indexes.ut_8bc.cursorable | boolean |
cursorable |
properties
|
items.indexes.laborum_4_0.properties | array of string |
properties |
indexType
|
items.indexes.laborum_4_0.indexType | string |
indexType |
cursorable
|
items.indexes.laborum_4_0.cursorable | boolean |
cursorable |
nextCursor
|
nextCursor | string |
nextCursor |
List data models defined in the project
List data models defined in the project. You can filter the returned models by the specified space.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
limit
|
limit | integer |
Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit. |
|
cursor
|
cursor | string |
Cursor for paging through results. |
|
inlineViews
|
inlineViews | boolean |
Should we expand the referenced views inline in the returned result. |
|
space
|
space | string |
The space to query. |
|
allVersions
|
allVersions | boolean |
If all versions of the entity should be returned. Defaults to false which returns the latest version, attributed to the newest 'createdTime' field. |
|
includeGlobal
|
includeGlobal | boolean |
If the global items of the entity should be returned. Defaults to false which excludes global items. |
|
Accept
|
Accept | string |
Accept Header MimeType |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
space
|
items.space | string |
space |
version
|
items.version | string |
version |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
views
|
items.views | array of object |
views |
type
|
items.views.type | string |
type |
space
|
items.views.space | string |
space |
externalId
|
items.views.externalId | string |
externalId |
version
|
items.views.version | string |
version |
nextCursor
|
nextCursor | string |
nextCursor |
List spaces defined in the project
List spaces defined in the current project.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
limit
|
limit | integer |
Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit. |
|
cursor
|
cursor | string |
Cursor for paging through results. |
|
includeGlobal
|
includeGlobal | boolean |
If the global items of the entity should be returned. Defaults to false which excludes global items. |
|
Accept
|
Accept | string |
Accept Header MimeType |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
space
|
items.space | string |
space |
description
|
items.description | string |
description |
name
|
items.name | string |
name |
nextCursor
|
nextCursor | string |
nextCursor |
List time series
List time series. Use nextCursor
to paginate through the results.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
limit
|
limit | integer |
Limits the number of results to return. CDF returns a maximum of 1000 results even if you specify a higher limit. |
|
includeMetadata
|
includeMetadata | boolean |
Whether the metadata field should be returned or not. |
|
cursor
|
cursor | string |
Cursor for paging through results. |
|
partition
|
partition | string |
Splits the data set into N partitions. The attribute is specified as a "M/N" string, where M is a natural number in the interval of [1, N]. You need to follow the cursors within each partition in order to receive all the data. To prevent unexpected problems and maximize read throughput, you should at most use 10 (N <= 10) partitions. When using more than 10 partitions, CDF may reduce the number of partitions silently. For example, CDF may reduce the number of partitions to K = 10 so if you specify an X/N partition value where X = 8 and N = 20 - i.e. "partition": "8/20"- then CDF will change N to N = K = 10 and process the request. But if you specify the X/N partition value where X = 11 (X > K) and N = 20 - i.e. "partition": "11/20"- then CDF will reply with an empty result list and no cursor in the response. In future releases of the resource APIs, Cognite may reject requests if you specify more than 10 partitions. When Cognite enforces this behavior, the requests will result in a 400 Bad Request status. |
|
assetIds
|
assetIds | string |
Gets the time series related to the assets. The format is a list of IDs serialized as a JSON array(int64). Takes [ 1 .. 100 ] unique items. |
|
rootAssetIds
|
rootAssetIds | string |
Only includes time series that have a related asset in a tree rooted at any of these root assetIds. |
|
externalIdPrefix
|
externalIdPrefix | string |
Filter by this (case-sensitive) prefix for the external ID. |
|
Accept
|
Accept | string |
Accept Header MimeType |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
id
|
items.id | integer |
id |
isString
|
items.isString | boolean |
isString |
isStep
|
items.isStep | boolean |
isStep |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
externalId
|
items.externalId | string |
externalId |
name
|
items.name | string |
name |
tempord
|
items.metadata.tempord | string |
tempord |
eiusmod_0_3
|
items.metadata.eiusmod_0_3 | string |
eiusmod_0_3 |
auteb
|
items.metadata.auteb | string |
auteb |
unit
|
items.unit | string |
unit |
assetId
|
items.assetId | integer |
assetId |
description
|
items.description | string |
description |
securityCategories
|
items.securityCategories | array of integer |
securityCategories |
dataSetId
|
items.dataSetId | integer |
dataSetId |
nextCursor
|
nextCursor | string |
nextCursor |
List views defined in the project
List of views defined in the current project. You can filter the list by specifying a space.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
limit
|
limit | integer |
Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit. |
|
cursor
|
cursor | string |
Cursor for paging through results. |
|
space
|
space | string |
The space to query. |
|
includeInheritedProperties
|
includeInheritedProperties | boolean |
Include properties inherited from views this view implements. |
|
allVersions
|
allVersions | boolean |
If all versions of the entity should be returned. Defaults to false which returns the latest version, attributed to the newest 'createdTime' field. |
|
includeGlobal
|
includeGlobal | boolean |
If the global items of the entity should be returned. Defaults to false which excludes global items. |
|
Accept
|
Accept | string |
Accept Header MimeType |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
type
|
items.properties.Excepteur_6.container.type | string |
type |
space
|
items.properties.Excepteur_6.container.space | string |
space |
externalId
|
items.properties.Excepteur_6.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.Excepteur_6.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.Excepteur_6.type.type | string |
type |
list
|
items.properties.Excepteur_6.type.list | boolean |
list |
collation
|
items.properties.Excepteur_6.type.collation | string |
collation |
nullable
|
items.properties.Excepteur_6.nullable | boolean |
nullable |
autoIncrement
|
items.properties.Excepteur_6.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.Excepteur_6.defaultValue | string |
defaultValue |
description
|
items.properties.Excepteur_6.description | string |
description |
name
|
items.properties.Excepteur_6.name | string |
name |
type
|
items.properties.enim7.container.type | string |
type |
space
|
items.properties.enim7.container.space | string |
space |
externalId
|
items.properties.enim7.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.enim7.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.enim7.type.type | string |
type |
list
|
items.properties.enim7.type.list | boolean |
list |
collation
|
items.properties.enim7.type.collation | string |
collation |
nullable
|
items.properties.enim7.nullable | boolean |
nullable |
autoIncrement
|
items.properties.enim7.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.enim7.defaultValue | string |
defaultValue |
description
|
items.properties.enim7.description | string |
description |
name
|
items.properties.enim7.name | string |
name |
type
|
items.properties.in_b0.container.type | string |
type |
space
|
items.properties.in_b0.container.space | string |
space |
externalId
|
items.properties.in_b0.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.in_b0.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.in_b0.type.type | string |
type |
list
|
items.properties.in_b0.type.list | boolean |
list |
collation
|
items.properties.in_b0.type.collation | string |
collation |
nullable
|
items.properties.in_b0.nullable | boolean |
nullable |
autoIncrement
|
items.properties.in_b0.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.in_b0.defaultValue | string |
defaultValue |
description
|
items.properties.in_b0.description | string |
description |
name
|
items.properties.in_b0.name | string |
name |
space
|
items.space | string |
space |
usedFor
|
items.usedFor | string |
usedFor |
version
|
items.version | string |
version |
writable
|
items.writable | boolean |
writable |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
and
|
items.filter.and | array of object |
and |
value
|
items.filter.and.value | string |
value |
implements
|
items.implements | array of object |
implements |
type
|
items.implements.type | string |
type |
space
|
items.implements.space | string |
space |
externalId
|
items.implements.externalId | string |
externalId |
version
|
items.implements.version | string |
version |
nextCursor
|
nextCursor | string |
nextCursor |
Query GraphQL
Query_GraphQL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | True | string |
The space to query. |
datamodel
|
datamodel | True | string |
The datamodel to query. |
version
|
version | True | string |
Data model version (opaque string controlled by client applications) |
query
|
query | string |
query |
|
variables
|
variables | object |
variables |
Returns
Query nodes or edges
Querying
The Data Modelling API exposes an advanced query interface. The query interface supports parameterization, recursive edge traversal, chaining of result sets, and granular property selection.
A query is composed of a with section defining result set expressions that describe the input to the query, a set of optional parameter placeholders if the query is parameterized, and then the select section that defines which properties are to be returned back as part of the result.
Imagine you have a data set with airplanes and airports, represented as two sets of nodes with edges between them indicating in which airports the airplanes land. Here is an example of a query which fetches a specific airplane as well as the airports it lands in:
with:
airplanes:
nodes:
filter:
equals:
property: ["node", "externalId"]
value: {"parameter": "airplaneExternalId"}
limit: 1
lands_in_airports:
edges:
from: airplanes
maxDistance: 1
direction: outwards
filter:
equals:
property: ["edge", "type"]
value: ["aviation", "lands-in"]
airports:
nodes:
from: lands_in_airports
parameters:
airplaneExternalId: myFavouriteAirplane
select:
airplanes: {}
airports: {}
Result Set Expressions
Result set expressions appear directly below with
in a query, and define a set of either nodes or edges.
The set may be used to return results, as stepping stones to derive other sets from, or both.
Result set expressions are named and can be chained as we'll see examples of later.
A result set expression may also define sort
order and a limit
. See sorting for more
details.
While result set expressions may relate to each other via chaining, they don't have to. You can query for entirely unrelated things in the same query, but different sets are generally used to power graph traversals.
A set either queries nodes or it queries edges, possibly recursively.
All fields:
nodes
: An object to specify a result set of matching nodes.edges
: An object to specify a result set of matching edges.sort
: A list of sort configurationslimit
: How many nodes or edges to return in the result. Default: 100
Pagination
The max limit you can set for any table expression is 10,000. In order to support retrieving the entire result set, pagination cursors are emitted for each result set expression, allowing you to page through everything. Pagination cursors cannot be combined with custom sorts. If no pagination cursor is present for a given result set expression in the response, then there is guaranteed no more data that matches.
Node result set expressions
A nodes
statement in your result set expression will make the set contain nodes.
A node result set can be chained off both node and edge result set expressions. When chaining off another node result
set you will retrieve the nodes pointed to by a given direct relation property, this direct relation
property is defined using the through
field. When chaining off an edge result set, you will retrieve the end nodes
defined by the edges in the set.
from
: A different result set expression to chain fromthrough
: What property to join thefrom
"through". Thethrough
property must be a direct relation.chainTo
: Control which side of the edge to chain to. This option is only applicable if the view referenced in thefrom
field consists of edges.chainTo
can be one of:source
will chain tostart
if you're following edges outwards i.edirection=outwards
. If you're following edges inwards i.edirection=inwards
, it will chain toend
.destination (default)
will chain toend
if you're following edges outwards i.edirection=outwards
. If you're following edges inwards i.edirection=inwards
, it will chain tostart
.
filter
: A filter to determine which nodes to match and thus be returned in the respective result set.
Edge result set expressions
An edges
statement in a result set expression will make the set contain edges, and the statement defines the rules
the graph traversal will follow.
A graph traversal can start from some initial set. This can be defined by from
, which will name another result
set expression.
The graph traversal follows edges in a particular direction, controlled by direction
, which defaults to outwards
.
Alice -is_parent-> Bob
Bob -fancies-> Mallory
Given the above graph, if you follow any edge from Bob
outwards (which is default), you'll get the edges
Bob -fancies-> Mallory
. If you follow edges inwards, i.e. direction=inwards
, you'll get Alice -is-parent-> Bob
.
The traversal happens breadth first. See limitations for more details.
A traversal is defined by what edges to follow, what nodes to match, and what nodes to terminate traversal at.
This is controlled by filter
, nodeFilter
and terminationFilter
.
filter
is a filter on edges. You would typically filter on the property [edge, type]
, but any property on an edge
can be filtered on.
nodeFilter
is a node filter, which the node on the "other" side must match. With direction: outwards
, that means
the "end node" of the edge must match. With direction: inwards
, the "start node" must match.
terminationFilter
is similar to nodeFilter
, except if it matches, traversal will end. A node must also match
nodeFilter
(if any) to steer the traversal to the node to terminate at in the first place.
maxDistance
controls how many hops away from the initial set traversal will go. maxDistance
defaults to unlimited
(but the set must respect its limit
, defined on the result set expression). If maxDistance
is 1, execution might
be faster, so if you know there will only be one level, it's worth configuring maxDistance: 1
.
Full options:
from
: Result set expression to chain from.filter
: Edges traversed must match this filter.nodeFilter
: Nodes on the "other" side of the edge must match this filter.terminationFilter
. Do not traverse beyond nodes matching this filter.maxDistance
: How many levels to traverse. Default unlimited.direction
: Whether to traverse edges pointing out of the initial set, or into the initial set.limitEach
: Limit the number of returned edges for each of the source nodes in the result set. The indicated uniform limit applies to the result set from the referenced from. limitEach only has meaning when you also specify maxDistance=1 and from.
Selects
Select configurations appear directly below select
in a query. These specify which data to retrieve for the respective
result set expression. It specifies a number of sources (views) and a property selector for each of these. The property
selectors define which view properties will be emitted in the query result.
It's possible to have sets whose properties are not emitted. This can be useful if the sets are necessary for chaining, but not actually interesting to include in the final results. Sets that are neither chained nor selected will not be executed (but will cause very slight query processing overhead)
Results are grouped by their respective sets, and the results contain properties that match the property selectors for the set.
Filters
Filters define what a part of the query matches. Filters are tree structures where the operator comes first, and then the parameters for that operator.
A simple example is the in
filter:
in:
property: [node, name]
values: [movie]
If the property node.name
, which is text property, is equal to any of the values in the provided list, the node will
match. Properties are typed. What query operators you can use on a property depends on its type.
An exhaustive list of filters and their descriptions can be found by examining the request body schema below.
Compound filters
Filters can be combined with and
/or
/not
:
and:
- not:
in:
property: [node, type]
values: [movie]
- range:
property: [imdb, movie, released]
gte: {parameter: start}
This would correspond to (NOT node.type in ('movie')) AND imdb.movie.released >= $start
.
HasData filter
Although this filter is documentented in the request body schema, it merits a more detailed explanation.
A hasData
filters will match if data is present in a given set of containers or views.
There is an implicit AND
between the containers and views referenced in the filter, so the filter will match
if and only if the node/edge has data in all of the specified containers and views.
When a container is specified, the filter will match if the instance has all required properties populated for that particular container.
When a view is specified, the filter will match nodes with data in all of the containers which the view references through properties, respecting the filters of the view if defined (and the filters of views implemented by the view).
Example:
hasData:
- type: container
space: my_space
externalId: my_container
- type: view
space: my_space
externalId: my_view
version: v1
If my_space.my_view.v1
maps properties in the containers my_space.c1
and my_space.c2
. The filter will match
if there is data in my_space.my_container AND (my_space.c1 AND my_space.c2)
if there is no filter defined on
my_space.my_view.v1
, and my_space.my_container AND my_space.my_view.v1.filter
if there is a filter defined on
my_space.my_view.v1
.
Parameters
Values in filters can be parameterised. Parameters are provided as part of the query object, and not in the filter itself.
This filter is parameterised:
range:
property: [imdb, movie, released]
gte: {parameter: start}
A query containing this filter will only run if the parameter start
is provided. The parameter must be compatible
with all the types and operators that refer to the parameter. In the above example, the "released" property is a date.
Thus, the start parameter must be compatible with the date type, or the query will fail completely, even if the range
filter is optional because it's OR-ed
TIP
Parameterise your filters!
It's a best practice to parameterise queries that take user input. This enables reusing query plans across queries, which will be noticable with read-heavy workloads.
Sorting and Limiting
Sorting and limiting can happen in multiple places in a query:
- In the result set expression, i.e. in the
with
object that defines a node or edge set. - In the result selection, i.e. under
select
where defined sets can be emitted as results.
Sorting and limiting the set definitions under with
will transitively affect dependent sets.
Changes to a set defined under with
will naturally affect sets that depend on it, transitively. If you only change
the sort order of a with
expression, dependent sets will not (necessarily) change (based on how the dependent sets
are defined), but if you put a limit on an expression, all dependent sets will inherit this and change as a consequence.
This is also true for sets that aren't actually emitted via select
, i.e. sets that are only defined as stepping-stones
for other sets.
Sorts and limits defined under select
changes the result appearing order for that set only, and not for depending
sets.
Example:
with:
some_nodes:
… # omitted. No sort here
some_edges:
from: some_nodes
# omitted. also no sorting
target_nodes:
from: some_edges
# …
select:
some_nodes:
properties: ...
sort:
- {property: [node, created], direction: descending}
limit: 100
The above query would still let some_edges
and target_nodes
pull from the full amount of nodes in some_nodes
,
even though what's returned as a result for some_nodes
is capped at 100.
Order of sorting and limiting
NOTE
A limit in an edge traversal applies to when to start traversing, which happens before sorting.
Nodes and edges have subtly different sorting and limiting behaviour: Nodes sort and limit simultaneously, while recursive edge exploration do limited traversal, then sort.
The top-n set of nodes sorted by some property will be guaranteed to have the top-n of that property for the set.
For edges found through traversal, i.e. via edges
, the limit
applies to how many edges to discover. This may not
be all the edges that could have been discovered in a full traversal. If you start traversing from some node and ask
for 100 edges sorted by creation timestamp, the 100 edges discovered before traversal stops get sorted. The full graph
is not traversed in order to find the 100 newest edges that exist in the graph defined by the traversal filters.
Therefore, to do sorting with a recursive graph traversal, you'll need to specify the sort configuration via postSort
.
An edge traversal with maxDistance=1
can take a normal sort
configuration, however.
Limitations
Graph traversal
Any query that involves a graph traversal will force nested loop-style execution. This will work well enough for traversals limited to a few hundred thousand unique paths.
The graph traversal is breadth first. All possible paths are traversed. This is important to keep in mind with traversals across loops. For example, a fully connected graph will not do well in a query that follows all possible paths, and is very likely to be terminated due to constraints on either time, memory, or temporary disk usage.
Timeout errors
Queries get cancelled with a 408 Request Timeout error if they take longer than the timeout. If hitting a timeout like this you will need to reduce load or contention, or optimise your query.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
with
|
with | object |
with |
|
select
|
select | object |
select |
|
cursors
|
cursors | object |
cursors |
|
parameters
|
parameters | object |
parameters |
Returns
Name | Path | Type | Description |
---|---|---|---|
magna7c1
|
items.magna7c1 | array of object |
magna7c1 |
instanceType
|
items.magna7c1.instanceType | string |
instanceType |
space
|
items.magna7c1.space | string |
space |
externalId
|
items.magna7c1.externalId | string |
externalId |
createdTime
|
items.magna7c1.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.magna7c1.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.magna7c1.version | integer |
version |
deletedTime
|
items.magna7c1.deletedTime | integer |
deletedTime |
sed_d6f
|
items.magna7c1.properties.est3.Duis_2.sed_d6f | string |
sed_d6f |
cupidatat_f
|
items.magna7c1.properties.est3.Duis_2.cupidatat_f | string |
cupidatat_f |
minima
|
items.magna7c1.properties.est3.consequat_e.minima | string |
minima |
officia_0b
|
items.magna7c1.properties.est3.consequat_e.officia_0b | string |
officia_0b |
in736
|
items.magna7c1.properties.est3.consequat_e.in736 | string |
in736 |
dolore7c
|
items.magna7c1.properties.est3.tempor_123.dolore7c | string |
dolore7c |
minim_297
|
items.magna7c1.properties.ada.sed_00.minim_297 | string |
minim_297 |
sed_cb9
|
items.magna7c1.properties.ada.utbc.sed_cb9 | string |
sed_cb9 |
nostrud_7a1
|
items.magna7c1.properties.incididunt76c.officia_4d.nostrud_7a1 | string |
nostrud_7a1 |
deserunt77
|
items.magna7c1.properties.incididunt76c.officia_4d.deserunt77 | string |
deserunt77 |
ipsum_74
|
items.magna7c1.properties.incididunt76c.aliqua0.ipsum_74 | string |
ipsum_74 |
mollit_
|
items.magna7c1.properties.incididunt76c.aliqua0.mollit_ | string |
mollit_ |
Excepteur_05
|
items.magna7c1.properties.incididunt76c.aliqua0.Excepteur_05 | string |
Excepteur_05 |
veniam62f
|
items.veniam62f | array of object |
veniam62f |
instanceType
|
items.veniam62f.instanceType | string |
instanceType |
space
|
items.veniam62f.space | string |
space |
externalId
|
items.veniam62f.externalId | string |
externalId |
createdTime
|
items.veniam62f.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.veniam62f.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.veniam62f.version | integer |
version |
deletedTime
|
items.veniam62f.deletedTime | integer |
deletedTime |
dolor_f4
|
items.veniam62f.properties.in3d7.commodob44.dolor_f4 | string |
dolor_f4 |
incididunt_
|
items.veniam62f.properties.in3d7.commodob44.incididunt_ | string |
incididunt_ |
irure_89e
|
items.veniam62f.properties.in_dee.culpa148.irure_89e | string |
irure_89e |
dolor_bd4
|
items.veniam62f.properties.in_dee.culpa148.dolor_bd4 | string |
dolor_bd4 |
Excepteura67
|
items.veniam62f.properties.in_dee.aliqua20.Excepteura67 | string |
Excepteura67 |
dolore1
|
items.veniam62f.properties.in_dee.aliqua20.dolore1 | string |
dolore1 |
voluptate4e
|
items.veniam62f.properties.in_dee.aliqua20.voluptate4e | string |
voluptate4e |
et00e
|
items.veniam62f.properties.in_dee.aliqua20.et00e | string |
et00e |
id650
|
items.veniam62f.properties.in_dee.aliqua20.id650 | string |
id650 |
adipisicingfb
|
items.veniam62f.properties.in_dee.proident__85.adipisicingfb | string |
adipisicingfb |
culpa4
|
items.veniam62f.properties.nostrud420.ea_7.culpa4 | string |
culpa4 |
ut_6
|
items.veniam62f.properties.nostrud420.sit_c.ut_6 | string |
ut_6 |
officia_8
|
items.veniam62f.properties.nostrud420.sit_c.officia_8 | string |
officia_8 |
qui_c
|
items.qui_c | array of object |
qui_c |
instanceType
|
items.qui_c.instanceType | string |
instanceType |
space
|
items.qui_c.space | string |
space |
externalId
|
items.qui_c.externalId | string |
externalId |
createdTime
|
items.qui_c.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.qui_c.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.qui_c.version | integer |
version |
deletedTime
|
items.qui_c.deletedTime | integer |
deletedTime |
anim_03e
|
items.qui_c.properties.enimca.deserunte.anim_03e | string |
anim_03e |
ea_16
|
items.qui_c.properties.eiusmod5.in3c.ea_16 | string |
ea_16 |
Excepteur_bb
|
items.qui_c.properties.eiusmod5.in3c.Excepteur_bb | string |
Excepteur_bb |
dolorb
|
items.qui_c.properties.eiusmod5.in3c.dolorb | string |
dolorb |
dolor_d
|
items.qui_c.properties.eiusmod5.nostrud_ef.dolor_d | string |
dolor_d |
dolor_5
|
items.qui_c.properties.eiusmod5.nostrud_ef.dolor_5 | string |
dolor_5 |
mollit61
|
items.qui_c.properties.eiusmod5.nostrud_ef.mollit61 | string |
mollit61 |
sed_f
|
items.qui_c.properties.eiusmod5.nostrud_ef.sed_f | string |
sed_f |
occaecata7
|
items.qui_c.properties.quis0d.in_9a.occaecata7 | string |
occaecata7 |
ipsum_880
|
items.qui_c.properties.quis0d.in_9a.ipsum_880 | string |
ipsum_880 |
exercitation9
|
items.qui_c.properties.est_79.et_0.exercitation9 | string |
exercitation9 |
quisb3
|
nextCursor.quisb3 | string |
quisb3 |
Retrieve containers by their external ids
Retrieve up to 100 containers by their specified external ids.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
type
|
items.properties.occaecat_ad.type.type | string |
type |
list
|
items.properties.occaecat_ad.type.list | boolean |
list |
collation
|
items.properties.occaecat_ad.type.collation | string |
collation |
nullable
|
items.properties.occaecat_ad.nullable | boolean |
nullable |
autoIncrement
|
items.properties.occaecat_ad.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.occaecat_ad.defaultValue | string |
defaultValue |
description
|
items.properties.occaecat_ad.description | string |
description |
name
|
items.properties.occaecat_ad.name | string |
name |
type
|
items.properties.id9.type.type | string |
type |
list
|
items.properties.id9.type.list | boolean |
list |
collation
|
items.properties.id9.type.collation | string |
collation |
nullable
|
items.properties.id9.nullable | boolean |
nullable |
autoIncrement
|
items.properties.id9.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.id9.defaultValue | string |
defaultValue |
description
|
items.properties.id9.description | string |
description |
name
|
items.properties.id9.name | string |
name |
type
|
items.properties.reprehenderit8.type.type | string |
type |
list
|
items.properties.reprehenderit8.type.list | boolean |
list |
collation
|
items.properties.reprehenderit8.type.collation | string |
collation |
nullable
|
items.properties.reprehenderit8.nullable | boolean |
nullable |
autoIncrement
|
items.properties.reprehenderit8.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.reprehenderit8.defaultValue | string |
defaultValue |
description
|
items.properties.reprehenderit8.description | string |
description |
name
|
items.properties.reprehenderit8.name | string |
name |
type
|
items.properties.exercitationbe2.type.type | string |
type |
list
|
items.properties.exercitationbe2.type.list | boolean |
list |
collation
|
items.properties.exercitationbe2.type.collation | string |
collation |
nullable
|
items.properties.exercitationbe2.nullable | boolean |
nullable |
autoIncrement
|
items.properties.exercitationbe2.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.exercitationbe2.defaultValue | string |
defaultValue |
description
|
items.properties.exercitationbe2.description | string |
description |
name
|
items.properties.exercitationbe2.name | string |
name |
space
|
items.space | string |
space |
usedFor
|
items.usedFor | string |
usedFor |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
type
|
items.constraints.aute_30.require.type | string |
type |
space
|
items.constraints.aute_30.require.space | string |
space |
externalId
|
items.constraints.aute_30.require.externalId | string |
externalId |
constraintType
|
items.constraints.aute_30.constraintType | string |
constraintType |
type
|
items.constraints.ullamco_b.require.type | string |
type |
space
|
items.constraints.ullamco_b.require.space | string |
space |
externalId
|
items.constraints.ullamco_b.require.externalId | string |
externalId |
constraintType
|
items.constraints.ullamco_b.constraintType | string |
constraintType |
type
|
items.constraints.officia_638.require.type | string |
type |
space
|
items.constraints.officia_638.require.space | string |
space |
externalId
|
items.constraints.officia_638.require.externalId | string |
externalId |
constraintType
|
items.constraints.officia_638.constraintType | string |
constraintType |
properties
|
items.indexes.veniam_01.properties | array of string |
properties |
indexType
|
items.indexes.veniam_01.indexType | string |
indexType |
cursorable
|
items.indexes.veniam_01.cursorable | boolean |
cursorable |
properties
|
items.indexes.culpa_f.properties | array of string |
properties |
indexType
|
items.indexes.culpa_f.indexType | string |
indexType |
cursorable
|
items.indexes.culpa_f.cursorable | boolean |
cursorable |
properties
|
items.indexes.anim_0.properties | array of string |
properties |
indexType
|
items.indexes.anim_0.indexType | string |
indexType |
cursorable
|
items.indexes.anim_0.cursorable | boolean |
cursorable |
properties
|
items.indexes.nisi__4.properties | array of string |
properties |
indexType
|
items.indexes.nisi__4.indexType | string |
indexType |
cursorable
|
items.indexes.nisi__4.cursorable | boolean |
cursorable |
properties
|
items.indexes.commodo5.properties | array of string |
properties |
indexType
|
items.indexes.commodo5.indexType | string |
indexType |
cursorable
|
items.indexes.commodo5.cursorable | boolean |
cursorable |
Retrieve data models by their external ids
Retrieve up to 100 data models by their external ids. Views can be auto-expanded when the InlineViews
query parameter is set.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
inlineViews
|
inlineViews | boolean |
Should we expand the referenced views inline in the returned result. |
|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
space
|
items.space | string |
space |
version
|
items.version | string |
version |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
views
|
items.views | array of object |
views |
type
|
items.views.type | string |
type |
space
|
items.views.space | string |
space |
externalId
|
items.views.externalId | string |
externalId |
version
|
items.views.version | string |
version |
Retrieve data points
Retrieves a list of data points from multiple time series in a project. This operation supports aggregation and pagination. Learn more about aggregation.
Note: when start
isn't specified in the top level and for an individual item, it will default to epoch 0, which is 1 January, 1970, thus
excluding potential existent data points before 1970. start
needs to be specified as a negative number to get data points before 1970.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
start
|
start |
start |
||
end
|
end |
end |
||
limit
|
limit | integer |
limit |
|
aggregates
|
aggregates | array of string |
aggregates |
|
granularity
|
granularity | string |
granularity |
|
includeOutsidePoints
|
includeOutsidePoints | boolean |
includeOutsidePoints |
|
cursor
|
cursor | string |
cursor |
|
start
|
start |
start |
||
end
|
end |
end |
||
limit
|
limit | integer |
limit |
|
aggregates
|
aggregates | array of string |
aggregates |
|
granularity
|
granularity | string |
granularity |
|
includeOutsidePoints
|
includeOutsidePoints | boolean |
includeOutsidePoints |
|
ignoreUnknownIds
|
ignoreUnknownIds | boolean |
ignoreUnknownIds |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
datapoints
|
items.datapoints | array of object |
datapoints |
timestamp
|
items.datapoints.timestamp | integer |
timestamp |
average
|
items.datapoints.average | float |
average |
max
|
items.datapoints.max | float |
max |
min
|
items.datapoints.min | float |
min |
count
|
items.datapoints.count | integer |
count |
sum
|
items.datapoints.sum | float |
sum |
interpolation
|
items.datapoints.interpolation | float |
interpolation |
stepInterpolation
|
items.datapoints.stepInterpolation | float |
stepInterpolation |
continuousVariance
|
items.datapoints.continuousVariance | float |
continuousVariance |
discreteVariance
|
items.datapoints.discreteVariance | float |
discreteVariance |
totalVariation
|
items.datapoints.totalVariation | float |
totalVariation |
id
|
items.id | integer |
id |
isStep
|
items.isStep | boolean |
isStep |
isString
|
items.isString | boolean |
isString |
externalId
|
items.externalId | string |
externalId |
unit
|
items.unit | string |
unit |
nextCursor
|
items.nextCursor | string |
nextCursor |
Retrieve latest data point
Retrieves the latest data point in one or more time series. Note that the latest data point in a time series is the one with the highest timestamp, which is not necessarily the one that was ingested most recently.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
before
|
before | string |
before |
|
ignoreUnknownIds
|
ignoreUnknownIds | boolean |
ignoreUnknownIds |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
datapoints
|
items.datapoints | array of object |
datapoints |
timestamp
|
items.datapoints.timestamp | integer |
timestamp |
value
|
items.datapoints.value | float |
value |
id
|
items.id | integer |
id |
isString
|
items.isString | boolean |
isString |
externalId
|
items.externalId | string |
externalId |
isStep
|
items.isStep | boolean |
isStep |
unit
|
items.unit | string |
unit |
nextCursor
|
items.nextCursor | string |
nextCursor |
Retrieve nodes or edges by their external ids
Retrieve up to 1000 nodes or edges by their external ids.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
instanceType
|
instanceType | string |
instanceType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
type
|
type | string |
type |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
|
includeTyping
|
includeTyping | boolean |
includeTyping |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
instanceType
|
items.instanceType | string |
instanceType |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.version | integer |
version |
deletedTime
|
items.deletedTime | integer |
deletedTime |
incididunt5a
|
items.properties.minim_f.aute_7.incididunt5a | string |
incididunt5a |
ullamco_4b4
|
items.properties.minim_f.aute_7.ullamco_4b4 | string |
ullamco_4b4 |
enim_a2_
|
items.properties.minim_f.quis_8.enim_a2_ | string |
enim_a2_ |
adipisicing6
|
items.properties.minim_f.irure_dc.adipisicing6 | string |
adipisicing6 |
commodo_e
|
items.properties.minim_f.irure_dc.commodo_e | string |
commodo_e |
aliquaf
|
items.properties.minim_f.incididuntf.aliquaf | string |
aliquaf |
anim097
|
items.properties.minim_f.incididuntf.anim097 | string |
anim097 |
fugiat_c
|
items.properties.minim_f.Excepteurc94.fugiat_c | string |
fugiat_c |
cillum_d
|
items.properties.minim_f.Excepteurc94.cillum_d | string |
cillum_d |
eiusmod_d9b
|
items.properties.nisi6.fugiat5.eiusmod_d9b | string |
eiusmod_d9b |
sint_d7
|
items.properties.nisi6.sunt__b4.sint_d7 | string |
sint_d7 |
non6
|
items.properties.Duis_7.quis_f.non6 | string |
non6 |
est88
|
items.properties.Duis_7.irure6.est88 | string |
est88 |
adipisicing__ec
|
items.properties.Duis_7.irure6.adipisicing__ec | string |
adipisicing__ec |
fugiat_4
|
items.properties.sint_0ff.non0.fugiat_4 | string |
fugiat_4 |
ullamco__46
|
items.properties.sint_0ff.non0.ullamco__46 | string |
ullamco__46 |
tempor3e
|
items.properties.sint_0ff.non0.tempor3e | string |
tempor3e |
fugiat6
|
items.properties.ipsum_e9.consequat__b.fugiat6 | string |
fugiat6 |
quis_26
|
items.properties.ipsum_e9.incididunt_1c.quis_26 | string |
quis_26 |
do_8
|
items.properties.ipsum_e9.incididunt_1c.do_8 | string |
do_8 |
in_2
|
items.properties.in_05.consequat_e2.in_2 | string |
in_2 |
pariatur_c11
|
items.properties.in_05.consequat_e2.pariatur_c11 | string |
pariatur_c11 |
commodoc4a
|
items.properties.in_05.consequat_e2.commodoc4a | string |
commodoc4a |
deserunt8
|
items.properties.in_05.elit_b3.deserunt8 | string |
deserunt8 |
laboris_d
|
items.properties.in_05.amet6d.laboris_d | string |
laboris_d |
doloreb0
|
items.properties.in_05.amet6d.doloreb0 | string |
doloreb0 |
sed_6c
|
items.properties.in_05.id_975.sed_6c | string |
sed_6c |
eu78
|
items.properties.in_05.id_975.eu78 | string |
eu78 |
enim4b
|
items.properties.in_05.id_975.enim4b | string |
enim4b |
type
|
typing.exercitationc_d.proident_21.commodo_21.type.type | string |
type |
list
|
typing.exercitationc_d.proident_21.commodo_21.type.list | boolean |
list |
collation
|
typing.exercitationc_d.proident_21.commodo_21.type.collation | string |
collation |
nullable
|
typing.exercitationc_d.proident_21.commodo_21.nullable | boolean |
nullable |
autoIncrement
|
typing.exercitationc_d.proident_21.commodo_21.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.exercitationc_d.proident_21.commodo_21.defaultValue | string |
defaultValue |
description
|
typing.exercitationc_d.proident_21.commodo_21.description | string |
description |
name
|
typing.exercitationc_d.proident_21.commodo_21.name | string |
name |
type
|
typing.exercitationc_d.proident_21.id89.type.type | string |
type |
list
|
typing.exercitationc_d.proident_21.id89.type.list | boolean |
list |
collation
|
typing.exercitationc_d.proident_21.id89.type.collation | string |
collation |
nullable
|
typing.exercitationc_d.proident_21.id89.nullable | boolean |
nullable |
autoIncrement
|
typing.exercitationc_d.proident_21.id89.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.exercitationc_d.proident_21.id89.defaultValue | string |
defaultValue |
description
|
typing.exercitationc_d.proident_21.id89.description | string |
description |
name
|
typing.exercitationc_d.proident_21.id89.name | string |
name |
type
|
typing.labore_bfa.est4fc.anim_112.type.type | string |
type |
list
|
typing.labore_bfa.est4fc.anim_112.type.list | boolean |
list |
collation
|
typing.labore_bfa.est4fc.anim_112.type.collation | string |
collation |
nullable
|
typing.labore_bfa.est4fc.anim_112.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.est4fc.anim_112.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.est4fc.anim_112.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.est4fc.anim_112.description | string |
description |
name
|
typing.labore_bfa.est4fc.anim_112.name | string |
name |
type
|
typing.labore_bfa.est4fc.culpa_e7d.type.type | string |
type |
list
|
typing.labore_bfa.est4fc.culpa_e7d.type.list | boolean |
list |
collation
|
typing.labore_bfa.est4fc.culpa_e7d.type.collation | string |
collation |
nullable
|
typing.labore_bfa.est4fc.culpa_e7d.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.est4fc.culpa_e7d.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.est4fc.culpa_e7d.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.est4fc.culpa_e7d.description | string |
description |
name
|
typing.labore_bfa.est4fc.culpa_e7d.name | string |
name |
type
|
typing.labore_bfa.est4fc.in1e5.type.type | string |
type |
list
|
typing.labore_bfa.est4fc.in1e5.type.list | boolean |
list |
collation
|
typing.labore_bfa.est4fc.in1e5.type.collation | string |
collation |
nullable
|
typing.labore_bfa.est4fc.in1e5.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.est4fc.in1e5.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.est4fc.in1e5.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.est4fc.in1e5.description | string |
description |
name
|
typing.labore_bfa.est4fc.in1e5.name | string |
name |
type
|
typing.labore_bfa.exercitation_72.nulla_78.type.type | string |
type |
list
|
typing.labore_bfa.exercitation_72.nulla_78.type.list | boolean |
list |
collation
|
typing.labore_bfa.exercitation_72.nulla_78.type.collation | string |
collation |
nullable
|
typing.labore_bfa.exercitation_72.nulla_78.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.exercitation_72.nulla_78.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.exercitation_72.nulla_78.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.exercitation_72.nulla_78.description | string |
description |
name
|
typing.labore_bfa.exercitation_72.nulla_78.name | string |
name |
type
|
typing.labore_bfa.exercitation_72.id__.type.type | string |
type |
list
|
typing.labore_bfa.exercitation_72.id__.type.list | boolean |
list |
collation
|
typing.labore_bfa.exercitation_72.id__.type.collation | string |
collation |
nullable
|
typing.labore_bfa.exercitation_72.id__.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.exercitation_72.id__.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.exercitation_72.id__.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.exercitation_72.id__.description | string |
description |
name
|
typing.labore_bfa.exercitation_72.id__.name | string |
name |
type
|
typing.labore_bfa.adipisicing_e.sint9_b.type.type | string |
type |
list
|
typing.labore_bfa.adipisicing_e.sint9_b.type.list | boolean |
list |
collation
|
typing.labore_bfa.adipisicing_e.sint9_b.type.collation | string |
collation |
nullable
|
typing.labore_bfa.adipisicing_e.sint9_b.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.adipisicing_e.sint9_b.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.adipisicing_e.sint9_b.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.adipisicing_e.sint9_b.description | string |
description |
name
|
typing.labore_bfa.adipisicing_e.sint9_b.name | string |
name |
type
|
typing.labore_bfa.adipisicing_e.in_44.type.type | string |
type |
list
|
typing.labore_bfa.adipisicing_e.in_44.type.list | boolean |
list |
collation
|
typing.labore_bfa.adipisicing_e.in_44.type.collation | string |
collation |
nullable
|
typing.labore_bfa.adipisicing_e.in_44.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.adipisicing_e.in_44.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.adipisicing_e.in_44.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.adipisicing_e.in_44.description | string |
description |
name
|
typing.labore_bfa.adipisicing_e.in_44.name | string |
name |
type
|
typing.labore_bfa.adipisicing_e.proident_8e.type.type | string |
type |
list
|
typing.labore_bfa.adipisicing_e.proident_8e.type.list | boolean |
list |
collation
|
typing.labore_bfa.adipisicing_e.proident_8e.type.collation | string |
collation |
nullable
|
typing.labore_bfa.adipisicing_e.proident_8e.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.adipisicing_e.proident_8e.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.adipisicing_e.proident_8e.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.adipisicing_e.proident_8e.description | string |
description |
name
|
typing.labore_bfa.adipisicing_e.proident_8e.name | string |
name |
type
|
typing.labore_bfa.adipisicing_e.minim126.type.type | string |
type |
list
|
typing.labore_bfa.adipisicing_e.minim126.type.list | boolean |
list |
collation
|
typing.labore_bfa.adipisicing_e.minim126.type.collation | string |
collation |
nullable
|
typing.labore_bfa.adipisicing_e.minim126.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.adipisicing_e.minim126.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.adipisicing_e.minim126.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.adipisicing_e.minim126.description | string |
description |
name
|
typing.labore_bfa.adipisicing_e.minim126.name | string |
name |
type
|
typing.labore_bfa.adipisicing_e.eiusmod_6.type.type | string |
type |
list
|
typing.labore_bfa.adipisicing_e.eiusmod_6.type.list | boolean |
list |
collation
|
typing.labore_bfa.adipisicing_e.eiusmod_6.type.collation | string |
collation |
nullable
|
typing.labore_bfa.adipisicing_e.eiusmod_6.nullable | boolean |
nullable |
autoIncrement
|
typing.labore_bfa.adipisicing_e.eiusmod_6.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.labore_bfa.adipisicing_e.eiusmod_6.defaultValue | string |
defaultValue |
description
|
typing.labore_bfa.adipisicing_e.eiusmod_6.description | string |
description |
name
|
typing.labore_bfa.adipisicing_e.eiusmod_6.name | string |
name |
type
|
typing.consequat2.officia68.exercitation069.type.type | string |
type |
list
|
typing.consequat2.officia68.exercitation069.type.list | boolean |
list |
collation
|
typing.consequat2.officia68.exercitation069.type.collation | string |
collation |
nullable
|
typing.consequat2.officia68.exercitation069.nullable | boolean |
nullable |
autoIncrement
|
typing.consequat2.officia68.exercitation069.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.consequat2.officia68.exercitation069.defaultValue | string |
defaultValue |
description
|
typing.consequat2.officia68.exercitation069.description | string |
description |
name
|
typing.consequat2.officia68.exercitation069.name | string |
name |
Retrieve spaces by their space-ids
Retrieve up to 100 spaces by specifying their space-ids.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
space
|
items.space | string |
space |
description
|
items.description | string |
description |
name
|
items.name | string |
name |
Retrieve time series
Retrieves one or more time series by ID or external ID. The response returns the time series in the same order as in the request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
ignoreUnknownIds
|
ignoreUnknownIds | boolean |
ignoreUnknownIds |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
id
|
items.id | integer |
id |
isString
|
items.isString | boolean |
isString |
isStep
|
items.isStep | boolean |
isStep |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
externalId
|
items.externalId | string |
externalId |
name
|
items.name | string |
name |
cupidatat4b_
|
items.metadata.cupidatat4b_ | string |
cupidatat4b_ |
reprehenderit36
|
items.metadata.reprehenderit36 | string |
reprehenderit36 |
unit
|
items.unit | string |
unit |
assetId
|
items.assetId | integer |
assetId |
description
|
items.description | string |
description |
securityCategories
|
items.securityCategories | array of integer |
securityCategories |
dataSetId
|
items.dataSetId | integer |
dataSetId |
Retrieve views by their external ids
Retrieve up to 100 views by their external ids.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
includeInheritedProperties
|
includeInheritedProperties | boolean |
Include properties inherited from views this view implements. |
|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
space
|
space | string |
space |
|
externalId
|
externalId | string |
externalId |
|
version
|
version | string |
version |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
createdTime
|
items.createdTime | integer |
createdTime |
externalId
|
items.externalId | string |
externalId |
isGlobal
|
items.isGlobal | boolean |
isGlobal |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
type
|
items.properties.nostrud_cc1.container.type | string |
type |
space
|
items.properties.nostrud_cc1.container.space | string |
space |
externalId
|
items.properties.nostrud_cc1.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.nostrud_cc1.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.nostrud_cc1.type.type | string |
type |
list
|
items.properties.nostrud_cc1.type.list | boolean |
list |
collation
|
items.properties.nostrud_cc1.type.collation | string |
collation |
nullable
|
items.properties.nostrud_cc1.nullable | boolean |
nullable |
autoIncrement
|
items.properties.nostrud_cc1.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.nostrud_cc1.defaultValue | string |
defaultValue |
description
|
items.properties.nostrud_cc1.description | string |
description |
name
|
items.properties.nostrud_cc1.name | string |
name |
type
|
items.properties.ipsum_df.container.type | string |
type |
space
|
items.properties.ipsum_df.container.space | string |
space |
externalId
|
items.properties.ipsum_df.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.ipsum_df.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.ipsum_df.type.type | string |
type |
list
|
items.properties.ipsum_df.type.list | boolean |
list |
collation
|
items.properties.ipsum_df.type.collation | string |
collation |
nullable
|
items.properties.ipsum_df.nullable | boolean |
nullable |
autoIncrement
|
items.properties.ipsum_df.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.ipsum_df.defaultValue | string |
defaultValue |
description
|
items.properties.ipsum_df.description | string |
description |
name
|
items.properties.ipsum_df.name | string |
name |
type
|
items.properties.eu3.container.type | string |
type |
space
|
items.properties.eu3.container.space | string |
space |
externalId
|
items.properties.eu3.container.externalId | string |
externalId |
containerPropertyIdentifier
|
items.properties.eu3.containerPropertyIdentifier | string |
containerPropertyIdentifier |
type
|
items.properties.eu3.type.type | string |
type |
list
|
items.properties.eu3.type.list | boolean |
list |
collation
|
items.properties.eu3.type.collation | string |
collation |
nullable
|
items.properties.eu3.nullable | boolean |
nullable |
autoIncrement
|
items.properties.eu3.autoIncrement | boolean |
autoIncrement |
defaultValue
|
items.properties.eu3.defaultValue | string |
defaultValue |
description
|
items.properties.eu3.description | string |
description |
name
|
items.properties.eu3.name | string |
name |
space
|
items.space | string |
space |
usedFor
|
items.usedFor | string |
usedFor |
version
|
items.version | string |
version |
writable
|
items.writable | boolean |
writable |
name
|
items.name | string |
name |
description
|
items.description | string |
description |
and
|
items.filter.and | array of object |
and |
value
|
items.filter.and.value | string |
value |
implements
|
items.implements | array of object |
implements |
type
|
items.implements.type | string |
type |
space
|
items.implements.space | string |
space |
externalId
|
items.implements.externalId | string |
externalId |
version
|
items.implements.version | string |
version |
Search for nodes or edges
Search text fields in views for nodes or edge(s). The service will return up to 1000 results. This operation orders the results by relevance, across the specified spaces.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
view type
|
type | string |
type |
|
view space
|
space | string |
space |
|
view externalId
|
externalId | string |
externalId |
|
view version
|
version | string |
version |
|
query
|
query | string |
query |
|
instanceType
|
instanceType | string |
instanceType |
|
properties
|
properties | array of string |
properties |
|
filter
|
filter | object |
filter |
|
limit
|
limit | integer |
limit |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
instanceType
|
items.instanceType | string |
instanceType |
space
|
items.space | string |
space |
externalId
|
items.externalId | string |
externalId |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.version | integer |
version |
deletedTime
|
items.deletedTime | integer |
deletedTime |
quis7bb
|
items.properties.ipsum_20.pariatur_39.quis7bb | string |
quis7bb |
proidentb48
|
items.properties.enim_8.laborum__91.proidentb48 | string |
proidentb48 |
deserunt_4
|
items.properties.enim_8.laborum__91.deserunt_4 | string |
deserunt_4 |
doc1
|
items.properties.enim_8.laborum__91.doc1 | string |
doc1 |
consecteturd35
|
items.properties.reprehenderit_1fb.Lorem83c.consecteturd35 | string |
consecteturd35 |
culpac
|
items.properties.reprehenderit_1fb.Lorem83c.culpac | string |
culpac |
type
|
typing.ametae9.anim_3e.cupidatat97.type.type | string |
type |
list
|
typing.ametae9.anim_3e.cupidatat97.type.list | boolean |
list |
collation
|
typing.ametae9.anim_3e.cupidatat97.type.collation | string |
collation |
nullable
|
typing.ametae9.anim_3e.cupidatat97.nullable | boolean |
nullable |
autoIncrement
|
typing.ametae9.anim_3e.cupidatat97.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.ametae9.anim_3e.cupidatat97.defaultValue | string |
defaultValue |
description
|
typing.ametae9.anim_3e.cupidatat97.description | string |
description |
name
|
typing.ametae9.anim_3e.cupidatat97.name | string |
name |
type
|
typing.ametae9.aute7c.ea0.type.type | string |
type |
list
|
typing.ametae9.aute7c.ea0.type.list | boolean |
list |
collation
|
typing.ametae9.aute7c.ea0.type.collation | string |
collation |
nullable
|
typing.ametae9.aute7c.ea0.nullable | boolean |
nullable |
autoIncrement
|
typing.ametae9.aute7c.ea0.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.ametae9.aute7c.ea0.defaultValue | string |
defaultValue |
description
|
typing.ametae9.aute7c.ea0.description | string |
description |
name
|
typing.ametae9.aute7c.ea0.name | string |
name |
type
|
typing.ametae9.aute7c.nisif.type.type | string |
type |
list
|
typing.ametae9.aute7c.nisif.type.list | boolean |
list |
collation
|
typing.ametae9.aute7c.nisif.type.collation | string |
collation |
nullable
|
typing.ametae9.aute7c.nisif.nullable | boolean |
nullable |
autoIncrement
|
typing.ametae9.aute7c.nisif.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.ametae9.aute7c.nisif.defaultValue | string |
defaultValue |
description
|
typing.ametae9.aute7c.nisif.description | string |
description |
name
|
typing.ametae9.aute7c.nisif.name | string |
name |
type
|
typing.ametae9.aute7c.qui92_.type.type | string |
type |
list
|
typing.ametae9.aute7c.qui92_.type.list | boolean |
list |
collation
|
typing.ametae9.aute7c.qui92_.type.collation | string |
collation |
nullable
|
typing.ametae9.aute7c.qui92_.nullable | boolean |
nullable |
autoIncrement
|
typing.ametae9.aute7c.qui92_.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.ametae9.aute7c.qui92_.defaultValue | string |
defaultValue |
description
|
typing.ametae9.aute7c.qui92_.description | string |
description |
name
|
typing.ametae9.aute7c.qui92_.name | string |
name |
type
|
typing.nisi_c.occaecat_8.pariatur_525.type.type | string |
type |
list
|
typing.nisi_c.occaecat_8.pariatur_525.type.list | boolean |
list |
collation
|
typing.nisi_c.occaecat_8.pariatur_525.type.collation | string |
collation |
nullable
|
typing.nisi_c.occaecat_8.pariatur_525.nullable | boolean |
nullable |
autoIncrement
|
typing.nisi_c.occaecat_8.pariatur_525.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.nisi_c.occaecat_8.pariatur_525.defaultValue | string |
defaultValue |
description
|
typing.nisi_c.occaecat_8.pariatur_525.description | string |
description |
name
|
typing.nisi_c.occaecat_8.pariatur_525.name | string |
name |
type
|
typing.nisi_c.occaecat_8.nisi_c6.type.type | string |
type |
list
|
typing.nisi_c.occaecat_8.nisi_c6.type.list | boolean |
list |
collation
|
typing.nisi_c.occaecat_8.nisi_c6.type.collation | string |
collation |
nullable
|
typing.nisi_c.occaecat_8.nisi_c6.nullable | boolean |
nullable |
autoIncrement
|
typing.nisi_c.occaecat_8.nisi_c6.autoIncrement | boolean |
autoIncrement |
defaultValue
|
typing.nisi_c.occaecat_8.nisi_c6.defaultValue | string |
defaultValue |
description
|
typing.nisi_c.occaecat_8.nisi_c6.description | string |
description |
name
|
typing.nisi_c.occaecat_8.nisi_c6.name | string |
name |
Search time series
Fulltext search for time series based on result relevance. Primarily meant for human-centric use cases, not for programs, since matching and order may change over time. Additional filters can also be specified. This operation does not support pagination.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
filter name
|
name | string |
name |
|
filter unit
|
unit | string |
unit |
|
filter isString
|
isString | boolean |
isString |
|
filter isStep
|
isStep | boolean |
isStep |
|
filter metadata
|
metadata | object |
metadata |
|
filter assetIds
|
assetIds | array of integer |
assetIds |
|
filter assetExternalIds
|
assetExternalIds | array of string |
assetExternalIds |
|
filter rootAssetIds
|
rootAssetIds | array of integer |
rootAssetIds |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
filter externalIdPrefix
|
externalIdPrefix | string |
externalIdPrefix |
|
filter createdTime max
|
max | integer |
max |
|
filter createdTime min
|
min | integer |
min |
|
filter lastUpdatedTime max
|
max | integer |
max |
|
filter lastUpdatedTime min
|
min | integer |
min |
|
search name
|
name | string |
name |
|
search description
|
description | string |
description |
|
search query
|
query | string |
query |
|
limit
|
limit | integer |
limit |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
id
|
items.id | integer |
id |
isString
|
items.isString | boolean |
isString |
isStep
|
items.isStep | boolean |
isStep |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
externalId
|
items.externalId | string |
externalId |
name
|
items.name | string |
name |
cupidatat4b_
|
items.metadata.cupidatat4b_ | string |
cupidatat4b_ |
reprehenderit36
|
items.metadata.reprehenderit36 | string |
reprehenderit36 |
unit
|
items.unit | string |
unit |
assetId
|
items.assetId | integer |
assetId |
description
|
items.description | string |
description |
securityCategories
|
items.securityCategories | array of integer |
securityCategories |
dataSetId
|
items.dataSetId | integer |
dataSetId |
Sync nodes or edges
Subscribe to changes for nodes and edges in a project, matching a supplied filter. This endpoint will always return a NextCursor
. The sync specification mirrors the query interface, but sorting is not currently supported.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
with
|
with | object |
with |
|
select
|
select | object |
select |
|
cursors
|
cursors | object |
cursors |
|
parameters
|
parameters | object |
parameters |
Returns
Name | Path | Type | Description |
---|---|---|---|
sunt58
|
items.sunt58 | array of object |
sunt58 |
instanceType
|
items.sunt58.instanceType | string |
instanceType |
space
|
items.sunt58.space | string |
space |
externalId
|
items.sunt58.externalId | string |
externalId |
createdTime
|
items.sunt58.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.sunt58.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.sunt58.version | integer |
version |
deletedTime
|
items.sunt58.deletedTime | integer |
deletedTime |
aute4
|
items.sunt58.properties.consequata94.enim_b.aute4 | string |
aute4 |
deseruntaa9
|
items.sunt58.properties.consequata94.exercitation_.deseruntaa9 | string |
deseruntaa9 |
eiusmoda
|
items.sunt58.properties.consequata94.labore19.eiusmoda | string |
eiusmoda |
dolore579
|
items.sunt58.properties.consequata94.labore19.dolore579 | string |
dolore579 |
sintdf7
|
items.sunt58.properties.consequata94.Duis_515.sintdf7 | string |
sintdf7 |
velit8
|
items.sunt58.properties.consequata94.Duis_515.velit8 | string |
velit8 |
elit9e_
|
items.sunt58.properties.ullamco_0.voluptate1.elit9e_ | string |
elit9e_ |
cillum_94
|
items.sunt58.properties.ullamco_0.voluptate1.cillum_94 | string |
cillum_94 |
ea7e8
|
items.sunt58.properties.laborum0.pariatur_c.ea7e8 | string |
ea7e8 |
incididunt_52d
|
items.sunt58.properties.laborum0.pariatur_c.incididunt_52d | string |
incididunt_52d |
consectetur3d6
|
items.consectetur3d6 | array of object |
consectetur3d6 |
instanceType
|
items.consectetur3d6.instanceType | string |
instanceType |
space
|
items.consectetur3d6.space | string |
space |
externalId
|
items.consectetur3d6.externalId | string |
externalId |
createdTime
|
items.consectetur3d6.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.consectetur3d6.lastUpdatedTime | integer |
lastUpdatedTime |
version
|
items.consectetur3d6.version | integer |
version |
deletedTime
|
items.consectetur3d6.deletedTime | integer |
deletedTime |
proident_4b
|
items.consectetur3d6.properties.consectetur_c.mollitb.proident_4b | string |
proident_4b |
et_fd8
|
items.consectetur3d6.properties.consectetur_c.mollitb.et_fd8 | string |
et_fd8 |
sunt_19
|
items.consectetur3d6.properties.consectetur_c.reprehenderit7.sunt_19 | string |
sunt_19 |
occaecate9
|
items.consectetur3d6.properties.consectetur_c.reprehenderit7.occaecate9 | string |
occaecate9 |
sit7
|
items.consectetur3d6.properties.consectetur_c.Excepteur_51.sit7 | string |
sit7 |
magna8_
|
items.consectetur3d6.properties.consectetur_c.Excepteur_51.magna8_ | string |
magna8_ |
dolore0
|
items.consectetur3d6.properties.consectetur_c.Excepteur_51.dolore0 | string |
dolore0 |
consectetur__a
|
items.consectetur3d6.properties.anim_b.ut_86b.consectetur__a | string |
consectetur__a |
voluptatefcb
|
items.consectetur3d6.properties.anim_b.et_2.voluptatefcb | string |
voluptatefcb |
aliquipc
|
items.consectetur3d6.properties.anim_b.et_2.aliquipc | string |
aliquipc |
dolore_461
|
items.consectetur3d6.properties.anim_b.Excepteur_9c.dolore_461 | string |
dolore_461 |
qui_8c4
|
items.consectetur3d6.properties.anim_b.Excepteur_9c.qui_8c4 | string |
qui_8c4 |
sint5
|
nextCursor.sint5 | string |
sint5 |
voluptate_380
|
nextCursor.voluptate_380 | string |
voluptate_380 |
labore_f
|
nextCursor.labore_f | string |
labore_f |
Update time series
Updates one or more time series. Fields outside of the request remain unchanged.
For primitive fields (those whose type is string, number, or boolean), use "set": value
to update the value; use "setNull": true
to set the field to null.
For JSON array fields (for example securityCategories
), use "set": [value1, value2]
to
update the value; use "add": [value1, value2]
to add values; use
"remove": [value1, value2]
to remove values.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
project
|
project | True | string |
The Cognite Data Fusion project. |
Content Type
|
Content-Type | string |
Content-Type Header MimeType |
|
Accept
|
Accept | string |
Accept Header MimeType |
|
id
|
id | integer |
id |
|
externalId
|
externalId | string |
externalId |
|
update externalId
|
externalId | object |
externalId |
|
update name
|
name | object |
name |
|
update metadata
|
metadata | object |
metadata |
|
update unit
|
unit | object |
unit |
|
update assetId
|
assetId | object |
assetId |
|
update isStep
|
isStep | object |
isStep |
|
update description
|
description | object |
description |
|
update securityCategories
|
securityCategories | object |
securityCategories |
|
update dataSetId
|
dataSetId | object |
dataSetId |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of object |
items |
id
|
items.id | integer |
id |
isString
|
items.isString | boolean |
isString |
isStep
|
items.isStep | boolean |
isStep |
createdTime
|
items.createdTime | integer |
createdTime |
lastUpdatedTime
|
items.lastUpdatedTime | integer |
lastUpdatedTime |
externalId
|
items.externalId | string |
externalId |
name
|
items.name | string |
name |
cupidatat4b_
|
items.metadata.cupidatat4b_ | string |
cupidatat4b_ |
reprehenderit36
|
items.metadata.reprehenderit36 | string |
reprehenderit36 |
unit
|
items.unit | string |
unit |
assetId
|
items.assetId | integer |
assetId |
description
|
items.description | string |
description |
securityCategories
|
items.securityCategories | array of integer |
securityCategories |
dataSetId
|
items.dataSetId | integer |
dataSetId |
Definitions
object
This is the type 'object'.