ReadRelationships reads a set of the relationships matching one or more
filters.
POST {{baseUrl}}/v1/relationships/read
Request Body
{"consistency"=>{"minimizeLatency"=>"<boolean>", "atLeastAsFresh"=>{"token"=>"<string>"}, "atExactSnapshot"=>{"token"=>"<string>"}, "fullyConsistent"=>"<boolean>"}, "relationshipFilter"=>{"resourceType"=>"<string>", "optionalResourceId"=>"<string>", "optionalRelation"=>"<string>", "optionalSubjectFilter"=>{"subjectType"=>"<string>", "optionalSubjectId"=>"<string>", "optionalRelation"=>{"relation"=>"<string>"}}}, "optionalLimit"=>"<long>", "optionalCursor"=>{"token"=>"<string>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"result":{"readAt":{"token":"\u003cstring\u003e"},"relationship":{"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":{}}},"afterResultCursor":{"token":"\u003cstring\u003e"}},"error":{"code":"\u003cinteger\u003e","message":"\u003cstring\u003e","details":[{"@type":"\u003cstring\u003e","labore_9a":{}},{"@type":"\u003cstring\u003e"}]}}