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
application/json
{
  • "with": {
    • "property1": {
      },
    • "property2": {
      }
    },
  • "cursors": {
    • "sync cursor reference1": "string",
    • "sync cursor reference2": "string"
    },
  • "select": {
    • "property1": {
      },
    • "property2": {
      }
    },
  • "parameters": {
    • "parameter-identifier1": "string",
    • "parameter-identifier2": "string"
    },
  • "includeTyping": false
}
Response samples
application/json
{
  • "items": {
    • "result-expression1": [
      ],
    • "result-expression2": [
      ]
    },
  • "typing": {
    • "result-expression1": {
      },
    • "result-expression2": {
      }
    },
  • "nextCursor": {
    • "cursor-name1": "string",
    • "cursor-name2": "string"
    }
}
➔ Next to Units / Units