Skip to content

termstore-relation-post.md

Latest commit

 

History

History
125 lines (97 loc) · 3.81 KB

termstore-relation-post.md

File metadata and controls

125 lines (97 loc) · 3.81 KB
title Create relation
description Create a new relation object.
author mohitpcad
ms.localizationpriority medium
ms.subservice sharepoint
doc_type apiPageType
ms.date 04/05/2024

Create relation

Namespace: microsoft.graph.termStore

[!INCLUDE beta-disclaimer]

Create a new relation object. These are used to create pinned and reused relations between terms or between a term and set. When creating a pinned/reused term between term and set then fromTerm in the post body must be null.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

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

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the relation object.

The following table lists the properties that are required when you create the relation.

Property Type Description
relationship relationType Type of relation to be created. The possible values are: pin, reuse.
set microsoft.graph.termstore.set The set where the relationship needs to be created.
fromTerm microsoft.graph.termstore.term The term with which the relationship needs to be created.

Response

If successful, this method returns a 201 Created response code and a relation object in the response body.

Examples

Request

POST https://graph.microsoft.com/beta/termStore/sets/{setId}/terms/{termId}/relations
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.termStore.relation",
  "relationship": "pin",
  "fromTerm" : {
    "id" : "b49f64b3-4722-4336-9a5c-56c326b344d4"
  },
  "set" : {
    "id": "95e553ae-a91a-4670-a139-67a6cea285b3"
  }
}

Response

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

HTTP/1.1 201 Created
Content-Type: application/json
{
  "@odata.type": "#microsoft.graph.termStore.relation",
  "id": "052c749c-749c-052c-9c74-2c059c742c05",
  "relationship": "pin",
  "fromTerm" : {
      "id" : "b49f64b3-4722-4336-9a5c-56c326b344d4"
  },
  "toTerm" : {
      "id" : "226e8ee3-f4b6-49d7-92d5-ec9d5475eec5"
  },
  "set" : {
      "id" : "95e553ae-a91a-4670-a139-67a6cea285b3"
  }
}