List relations

Namespace: microsoft.graph.termStore

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get the different relation of a term or set from the relations navigation property.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) TermStore.Read.All, TermStore.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Not supported.

HTTP request

GET /termStore/sets/{setId}/relations
GET /termStore/sets/{setId}/terms/{termId}/relations

Optional query parameters

This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of relation objects in the response body.

Examples

Request

GET https://graph.microsoft.com/beta/termStore/sets/{setId}/relations

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "052c749c-749c-052c-9c74-2c059c742c05",
      "relationship": "pin"
    }
  ]
}