Database endpoints
Find paths in either direction
Lists the simple paths between two nodes when each hop may follow a relation edge in either direction.
GET /v1/tenants/{tenant}/graph/{schema}/all_simple_paths_bidir
- Set the endpointsChoose the source, destination and relation.
- Follow links both waysSearch within the depth and path-count limits.
- Read the simple pathsEach route lists its nodes in traversal order.
Before you start
Use your database bearer token.
Register the schema and relation, then add their rows. The examples use demo.people, its bidirectional follows relation, and linked rows u1, u2 and u3.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
schema | string | Required |
Query parameters
| Field | Type | Required |
|---|---|---|
rel | string | Required |
src | string | Required |
dst | string | Required |
max_depth | integer | Optional |
max_paths | integer | Optional |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Read the result
Each pks array is an ordered simple path. A hop may follow an edge in either direction, so a returned path does not imply that every edge points from source toward destination.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 408 | Reduce query work or adjust the timeout. |
| 429 | Honor Retry-After when present; back off. |
| 499 | The client cancelled the request. |
| 500 | Check the outcome before retrying a write. |
| 503 | Honor Retry-After when present; check write outcomes. |