Query nodes/edges

Specification of query endpoint. 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

Query specification.

required
object [ 1 .. 50 ] properties
object <= 50 properties

Cursors returned from the previous query request. These cursors match the result set expressions you specified in the with clause for the query.

required
object [ 1 .. 50 ] properties
object

Values in filters can be parameterised. Parameters are provided as part of the query object, and referenced in the filter itself.

includeTyping
boolean (IncludeTyping)
Default: false

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/query
Request samples
application/json
{
  • "with": {
    • "result-expression-name1": {
      },
    • "result-expression-name2": {
      }
    },
  • "cursors": {
    • "pagination cursor reference1": "string",
    • "pagination cursor reference2": "string"
    },
  • "select": {
    • "result-expression-name1": {
      },
    • "result-expression-name2": {
      }
    },
  • "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"
    }
}