Cognite Data Fusion API

Sync nodes/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. For more information, see Query language.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code

Request

Request Body schema: application/json
required

Change filter specification

required	object [ 1 .. 50 ] properties
	object <= 50 properties Cursors returned from the previous sync request. These cursors match the result set expressions you specified in the `with` clause for the sync.
required	object [ 1 .. 50 ] properties
	object Parameters to return
includeTyping	boolean (IncludeTyping) Should we return property type information as part of the result?

Responses

200

Matching nodes and edges

400

The response for a failed request.

post/models/instances/sync

Request samples

Payload
Python SDK
curl

application/json

{"with": {"property1": {"limit": 100,
"nodes": {"from": "string",
"chainTo": "source",
"through": {"view": {"type": "view",
"space": "string",
"externalId": "string",
"version": "string"
},
"identifier": "string"
},
"direction": "outwards",
"filter": {"and": [{"in": {"property": ["tag"
],
"values": [10011,
10011
]
}
},
{"range": {"property": ["weight"
],
"gte": 0
}
}
]
}
}
},
"property2": {"limit": 100,
"nodes": {"from": "string",
"chainTo": "source",
"through": {"view": {"type": "view",
"space": "string",
"externalId": "string",
"version": "string"
},
"identifier": "string"
},
"direction": "outwards",
"filter": {"and": [{"in": {"property": ["tag"
],
"values": [10011,
10011
]
}
},
{"range": {"property": ["weight"
],
"gte": 0
}
}
]
}
}
}
},
"cursors": {"sync cursor reference1": "string",
"sync cursor reference2": "string"
},
"select": {"property1": {"sources": [{"source": {"type": "view",
"space": "string",
"externalId": "string",
"version": "string"
},
"properties": ["string"
],
"targetUnits": [{"property": "string",
"unit": {"externalId": null
}
}
]
}
]
},
"property2": {"sources": [{"source": {"type": "view",
"space": "string",
"externalId": "string",
"version": "string"
},
"properties": ["string"
],
"targetUnits": [{"property": "string",
"unit": {"externalId": null
}
}
]
}
]
}
},
"parameters": {"parameter-identifier1": "string",
"parameter-identifier2": "string"
},
"includeTyping": false
}

Response samples

application/json

{"items": {"result-expression1": [{"instanceType": "node",
"version": 0,
"space": "string",
"externalId": "string",
"type": {"space": "string",
"externalId": "string"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"deletedTime": 1730204346000,
"properties": {"space-name1": {"view-or-container-identifier1": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
},
"view-or-container-identifier2": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
}
},
"space-name2": {"view-or-container-identifier1": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
},
"view-or-container-identifier2": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
}
}
}
}
],
"result-expression2": [{"instanceType": "node",
"version": 0,
"space": "string",
"externalId": "string",
"type": {"space": "string",
"externalId": "string"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"deletedTime": 1730204346000,
"properties": {"space-name1": {"view-or-container-identifier1": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
},
"view-or-container-identifier2": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
}
},
"space-name2": {"view-or-container-identifier1": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
},
"view-or-container-identifier2": {"someStringProperty": "someStringValue",
"someDirectRelation": {"space": "mySpace",
"externalId": "someNode"
},
"someIntArrayProperty": [1,
2,
3,
4
]
}
}
}
}
]
},
"typing": {"result-expression1": {"space-name1": {"view-or-container-external-id1": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
},
"view-or-container-external-id2": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
}
},
"space-name2": {"view-or-container-external-id1": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
},
"view-or-container-external-id2": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
}
}
},
"result-expression2": {"space-name1": {"view-or-container-external-id1": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
},
"view-or-container-external-id2": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
}
},
"space-name2": {"view-or-container-external-id1": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
},
"view-or-container-external-id2": {"property-identifier1": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
},
"property-identifier2": {"immutable": false,
"nullable": true,
"autoIncrement": false,
"defaultValue": "string",
"description": "string",
"name": "string",
"type": {"type": "text",
"list": false,
"collation": "ucs_basic"
}
}
}
}
}
},
"nextCursor": {"cursor-name1": "string",
"cursor-name2": "string"
}
}

➔ Next to Asset-centric data model / Assets

Sync nodes/edges

Request Body schema: application/jsonrequired

Request Body schema: application/json
required