ORory
relationship

Query relationships

Changed on

Get all relationships that match the query. Only the namespace field is required.

get/relation-tuples

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

page_sizeinteger

Items per Page

This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

page_tokenstring

Next Page Token

The next page token. For details on pagination please head over to the pagination documentation.

namespacestring

Namespace of the Relationship

objectstring

Object of the Relationship

relationstring

Relation of the Relationship

subject_idstring

SubjectID of the Relationship

subject_set.namespacestring

Namespace of the Subject Set

subject_set.objectstring

Object of the Subject Set

subject_set.relationstring

Relation of the Subject Set

Response

relationships

next_page_tokenstring

The opaque token to provide in a subsequent request to get the next page. It is the empty string iff this is the last page.

Changes

  • fb6ac8396666Revision changes
    • breaking

      for the query request parameter page_size, default value 250 was added

    • warning

      for the query request parameter page_size, the max was set to 1000.00

    • warning

      for the query request parameter page_size, the min was set to 1.00

  • 5f207fe3fcc0Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id getRelationTuples removed and replaced with getRelationships

    • info

      api tag relationship added

    • info

      api tag read removed

    • info

      removed the non-success response with the status

    • info

      added the required property to the response with the status