Search for nodes/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.

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

The search specification.

required
object (ViewReference)

Reference to a view

query
string

Query string that will be parsed and used for search.

instanceType
string
Default: "node"

Limit the search query to searching nodes or edges. Unless you set the item type to apply the search to, the service will default to searching nodes within the view.

Enum: "node" "edge"
properties
Array of strings

Optional array of properties you want to search through. If you do not specify one or more properties, the service will search all text fields within the view.

Array of objects (TargetUnits) [ 1 .. 10 ] items

Properties to convert to another unit. The API can only convert to another unit, if a unit has been defined as part of the type on the underlying container being queried.

(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.

includeTyping
boolean (IncludeTyping)
Default: false

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

Array of objects (SearchSort) <= 5 items
limit
integer [ 1 .. 1000 ]
Default: 1000

Limits the number of results to return.

Responses
200

Search query results

400

The response for a failed request.

post/models/instances/search
Request samples
application/json
{
  • "view": {
    • "type": "view",
    • "space": "string",
    • "externalId": "string",
    • "version": "string"
    },
  • "query": "string",
  • "instanceType": "node",
  • "properties": [
    • "string"
    ],
  • "targetUnits": [
    • {
      }
    ],
  • "filter": {
    • "and": [
      ]
    },
  • "includeTyping": false,
  • "sort": [
    • {
      }
    ],
  • "limit": 1000
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "typing": {
    • "space-name1": {
      },
    • "space-name2": {
      }
    }
}