Database endpoints
Find all simple paths
Lists the simple paths from one node to another along a relation, up to a depth and path-count limit.
GET /v1/tenants/{tenant}/graph/{schema}/all_simple_paths
- Choose two recordsSet the source, destination and relation.
- Follow directed linksExplore simple paths within the chosen limits.
- Read each ordered pathEach returned path contains no repeated node.
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 path from source to destination with no repeated node. Depth and path-count limits bound the search; the returned list is not necessarily every possible path.
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. |