​

Field Details

• ​

  ENTITY_TYPE

  public static final String ENTITY_TYPE

  The type of entity to retrieve. Supported values:

  • EDGE: Retrieve edge entities (default).
  • NODE: Retrieve node entities.

  The default value is EDGE.

  See Also:

  • Constant Field Values

• ​

  EDGE

  public static final String EDGE

  Retrieve edge entities (default).

  See Also:

  • Constant Field Values

• ​

  NODE

  public static final String NODE

  Retrieve node entities.

  See Also:

  • Constant Field Values

• ​

  SERVER_ID

  public static final String SERVER_ID

  Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is ‘0’.

  See Also:

  • Constant Field Values

• ​

  CONCISE_EDGE_CONNECTIVITY

  public static final String CONCISE_EDGE_CONNECTIVITY

  When true, edges are emitted in a compact connectivity form regardless of the graph’s identifier type: entitiesInt contains stride-4 records [edge_id, node1_index, node2_index, edge_label_index] where node1_index/node2_index are 0-based positions into the node array (obtained from a node-entity call on the same graph). When requesting nodes with this option, the response includes tombstoned (deleted) slots in order to keep position indices stable so edge indices resolve correctly; deleted slots carry id=0 for integer graphs or an empty identifier for string/WKT graphs. For paginated node calls, subtract offset from an edge endpoint index to locate it within the returned page. Supported values:

  • TRUE: Compact integer connectivity for edges; deleted node slots included in node output.
  • FALSE: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.

  The default value is FALSE.

  See Also:

  • Constant Field Values

• ​

  TRUE

  public static final String TRUE

  Populate entitiesWeight with per-edge weights (edge requests only).

  See Also:

  • Constant Field Values

• ​

  FALSE

  public static final String FALSE

  Default: entitiesWeight is empty.

  See Also:

  • Constant Field Values

• ​

  INCLUDE_WEIGHTS

  public static final String INCLUDE_WEIGHTS

  When true and options entityType is ‘edge’, the response entitiesWeight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entitiesInt or entitiesString). Empty when the graph has no weights component or when requesting nodes. Supported values:

  • TRUE: Populate entitiesWeight with per-edge weights (edge requests only).
  • FALSE: Default: entitiesWeight is empty.

  The default value is FALSE.

  See Also:

  • Constant Field Values