v1

latestOpenAPI 3.1.0BurstIQ, Inc.2026-08-04171112158.2 KB
Graph Chain APIs

<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>Finds the shortest path (0..1) or shortest paths (0..*) between SDO IDs (v1 chain/id and v2 chain/id).

User must specify a case-insensitive direction (IN, OUT, INOUT, OMNI).

Depth parameters are also required.

The optimizedShortestPath must be a minDepth of 0. Also, for optimizedShortestPath the ALL direction is not supported. When optimizedShortestPath is specified than (0..1) paths are returned; when not requested, then (0..*) paths are returned.

An optional graph traversal WHILE statement is available.

get/api/graphchain/shortestpath

Query parameters

v1Chainstring required
v1SdoIdstring uuid required
v2Chainstring required
v2SdoIdstring uuid required
directionstring required
minDepthinteger required
maxDepthinteger required
whileStmtstring
optimizedShortestPathboolean

Response

OK