Query Builder Results

Examples and descriptions for query builder responses

Depending on the request, query results can be returned as a collection of entities (nodes), a numeric value, or a timestamp.

Requesting a query result will return the result value, which can be a total number of results, the node details, or a timestamp. To return a paginated list of node details instead, use Get Query Nodes.

Sample Response: Get Nodes

{
    "nodes_value": [
      {
        "id": "00upa6s0hSGtl1eGL5d5",
        "type": "OktaUser",
        "properties": {
          "created_at": "2020-11-12T20:56:34Z",
          "email": "[email protected]",
          "is_active": false,
          "login": "[email protected]",
          "name": "[email protected]",
          "status": "STAGED",
          "updated_at": "2020-11-12T20:56:34Z"
        },
        "destination_node_count": 0,
        "permissions": []
      }
    ]
}

Sample Response: Get Result

{
  "result_type": "string",
  "number_value": "string",
  "timestamp_value": "string",
  "nodes_value": {
    "values": [
      {
        "id": "string",
        "type": "string",
        "properties": {},
        "destination_node_count": 0,
        "permissions": [
          "string"
        ]
      }
    ],
    "next_page_token": "string",
    "has_more": true
  }
}

Field	Type	Description
result_type	string	Indicates whether the query returns nodes details, node count, or timestamp.
nodes_value	array	Contains node details (see below)
number_value	string	The count of nodes in the query results.
timestamp_value	string	Not currently supported
result_node_type	string	The type of nodes returned in the search results.
next_page_token	string	Pagination token
has_more	boolean	Indicates if more results are available

Node details

The node values contain individual entity details, including any properties Veza has discovered such as manager or date_created:

{
  "values": [
    {
      "id": "string",
      "type": "string",
      "properties": {},
      "destination_node_count": 0,
      "permissions": [
        "string"
      ]
    }
  ],
  "next_page_token": "string",
  "has_more": true
}

Field	Type	Description
id	string	The node's UUID in the Veza data catalog
type	string	The node type.
properties	dict	List of any entity properties, as key:value pairs
destination_node_count	int	For DESTINATION_NODES queries, the number of connected nodes.
permissions	array	The permissions a source node has to the destination resource.