OpenGraph (Experimental)
Community
Enterprise

Get Relationship Kind

Changed on

Experimental - Retrieves the details of a single OpenGraph relationship kind by its id, including its extension metadata and entity-panel info map keyed by info key.

get/api/v2/relationship-kinds/{relationship_kind_id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/relationship-kinds/{relationship_kind_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Response

OK

Example response

{
  "data": {
    "relationship_kind_id": 42,
    "name": "MemberOf",
    "description": "a membership relationship",
    "is_traversable": true,
    "extension": {
      "extension_id": 7,
      "name": "AD",
      "display_name": "Active Directory",
      "namespace": "AD",
      "version": "v1"
    }
  }
}

Changes