Instances

List of nodes and edges to create/update

List of nodes and edges to delete

Should we create missing target nodes of direct relations? If the target-container constraint has been specified for a direct relation, the target node cannot be auto-created. If you want to point direct relations to a space where you have only read access, this option must be set to false.

Should we create missing start nodes for edges when ingesting? By default, the start node of an edge must exist before we can ingest the edge.

Should we create missing end nodes for edges when ingesting? By default, the end node of an edge must exist before we can ingest the edge.

If existingVersion is specified on any of the nodes/edges in the input, the default behaviour is that the entire ingestion will fail when version conflicts occur. If skipOnVersionConflict is set to true, items with version conflicts will be skipped instead. If no version is specified for nodes/edges, it will do the write directly.

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

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

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"
                    }
                  }
              }
}

Return query debug notices.

Limits the number of results to return.

The node/edge must have data in all the sources defined in the list

Reference to a view

Query string that will be parsed and used for search.

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.

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.

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.

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

Controls how multiple search terms are combined when matching documents.

• OR (default): A document matches if it contains any of the query terms in the searchable fields. This typically returns more results but with lower precision.

• AND: A document matches only if it contains all of the query terms across the searchable fields. This typically returns fewer results but with higher relevance.

Optional query string. The API will parse the query string, and use it to match the text properties on elements to use for the aggregate(s).

Optional list (array) of properties you want to apply the query above to. If you do not list any properties, you search through text fields by default.

Limit the number of results returned. The default limit is currently at 100 items.

The selection of fields to group the results by when doing aggregations. You can specify up to 5 items to group by.

When you do not specify any aggregates, the fields listed in the groupBy clause will return the unique values stored for each field. The property types supported for groupBy are text, direct, int32, int64, float32, float64, boolean, and enum.

Controls how multiple search terms are combined when matching documents.

• OR (default): A document matches if it contains any of the query terms in the searchable fields. This typically returns more results but with lower precision.

• AND: A document matches only if it contains all of the query terms across the searchable fields. This typically returns fewer results but with higher relevance.

The type of instance

Reference to a view

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.

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

Select properties for each result set.

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

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