BulkExportRelationships is the fastest path available to exporting
relationships from the server. It is resumable, and will return results in an order determined by the server.
POST {{baseUrl}}/v1/experimental/relationships/bulkexport
Request Body
{"consistency"=>{"minimizeLatency"=>"<boolean>", "atLeastAsFresh"=>{"token"=>"<string>"}, "atExactSnapshot"=>{"token"=>"<string>"}, "fullyConsistent"=>"<boolean>"}, "optionalLimit"=>"<long>", "optionalCursor"=>{"token"=>"<string>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"result":{"afterResultCursor":{"token":"\u003cstring\u003e"},"relationships":[{"resource":{"objectType":"\u003cstring\u003e","objectId":"\u003cstring\u003e"},"relation":"\u003cstring\u003e","subject":{"object":{"objectType":"\u003cstring\u003e","objectId":"\u003cstring\u003e"},"optionalRelation":"\u003cstring\u003e"},"optionalCaveat":{"caveatName":"\u003cstring\u003e","context":{}}},{"resource":{"objectType":"\u003cstring\u003e","objectId":"\u003cstring\u003e"},"relation":"\u003cstring\u003e","subject":{"object":{"objectType":"\u003cstring\u003e","objectId":"\u003cstring\u003e"},"optionalRelation":"\u003cstring\u003e"},"optionalCaveat":{"caveatName":"\u003cstring\u003e","context":{}}}]},"error":{"code":"\u003cinteger\u003e","message":"\u003cstring\u003e","details":[{"@type":"\u003cstring\u003e","labore6":{}},{"@type":"\u003cstring\u003e"}]}}