Merge a given graph with the existing graph under marked merge nodes as batch update.

POST 
/graph/:graph_id/batch/merge

Experimental: This API is not stable and might be subject of change.
Merge a given graph with the existing graph under marked merge nodes as batch update.

Request

Path Parameters

graph_id stringrequired
The identifier of the graph
Example: resoto

Query Parameters

batch_id string

A batch identifier is a string that uniquely identifies the batch update. If this parameter is omitted, a new batch identifier is created automatically. The resulting batch identifier can be retrieved via the response message.

wait_for_result boolean

Default value: true

If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.

application/x-ndjson

Body

required

The graph is sent as newline delimited json, where each line holds a document, which is either a node or an edge.

oneOf

NodeInGraph

id string

The identifier of this node.

type string

reported object

kind string

The kind of this node.

property name* any

desired object

property name* any

metadata object

property name* any

Edge

from string

The id of node to start from

to string

The id of the node to go to

edge_type string

Possible values: [default, delete]

The type of this edge

Responses

200

Return a summary of actions that has been applied.

application/json

Schema

Schema

nodes_created integer

The number of nodes that have been created.

nodes_updates integer

The number of nodes that have been updated.

nodes_deleted integer

The number of nodes that have been deleted.

edges_created integer

The number of edges that have been created.

edges_updated integer

The number of edges that have been updated.

edges_deleted integer

The number of edges that have been deleted.

Example (from schema)

{
  "nodes_created": 0,
  "nodes_updates": 0,
  "nodes_deleted": 0,
  "edges_created": 0,
  "edges_updated": 0,
  "edges_deleted": 0
}

Loading...