relationship

Query relationships

Changed on

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

get/relation-tuples

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /relation-tuples
  • 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

    • 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

      the query request parameter namespace became optional

    • info

      the query request parameter object became optional

    • info

      the query request parameter relation became optional