Skip to main content
Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use /show/graph to obtain the total number of nodes and edges.

Input Parameter Description

string
Name of the graph from which to retrieve entities.
long
Starting index of the entities to retrieve (0-based).The default value is 0.
long
Number of entities to retrieve starting from input parameter offset. A value of -1 returns all entities from the offset to the end. Note: the output parameter entities_int or output parameter entities_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4).The default value is 10000.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘get_graph_entities_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /get/graph/entities endpoint:Empty string in case of an error.