Filter nodes/edges

Filter the instances - nodes and edges - in a project.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Filter based on the instance type, the name, the external-ids, and on properties. The filter supports sorting and pagination. The instances must have data in all the views referenced by the sources field. Properties for up to 10 views can be retrieved in one query.

includeTyping
boolean (IncludeTyping)
Default: false

Should we return property type information as part of the result?

Array of objects (SourceSelectorWithoutPropertiesV3) <= 10 items

Retrieve properties from the listed - by reference - views. The node/edge must have data in all the sources defined in the list.

instanceType
string
Default: "node"

The type of instance you are querying for; an edge or a node. If the instance type isn't specified, we list nodes. When instanceType is edge, property can refer to any container and is defined as ["edge", "type"], and value contains the value of the property.

Example:

{
    “includeTyping”: true,
    “instanceType”: "edge",
    “filter”: {
                “equals”: {
                    "property": [
                      "edge",
                      "type" // VALID VALUES:[space, externalId, createdTime, lastUpdatedTime, startNode, endNode, type ]
                    ],
                    "value": {
                    "space": "apm_simple",
                    "externalId": "WMT:23-FO-96187"
                    }
                  }
              }
} 
Enum: "node" "edge"
cursor
string
limit
integer [ 1 .. 1000 ]
Default: 1000

Limits the number of results to return.

Array of objects (PropertySortV3) <= 5 items
(BoolFilter (and (object) or or (object) or not (object))) or (LeafFilter (equals (object) or in (object) or range (object) or prefix (object) or exists (object) or containsAny (object) or containsAll (object) or matchAll (object) or nested (object) or overlaps (object) or hasData (object))) (FilterDefinition)

A filter Domain Specific Language (DSL) used to create advanced filter queries.

Responses
200

List of matching nodes and edges

400

The response for a failed request.

post/models/instances/list
Request samples
application/json
{
  • "includeTyping": false,
  • "sources": [
    • {
      }
    ],
  • "instanceType": "node",
  • "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo",
  • "limit": 1000,
  • "sort": [
    • {
      }
    ],
  • "filter": {
    • "and": [
      ]
    }
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "typing": {
    • "space-name1": {
      },
    • "space-name2": {
      }
    },
  • "nextCursor": "string"
}