| title | relation resource type |
|---|---|
| description | Represents the relationship between terms in a term store. |
| author | mohitpcad |
| ms.localizationpriority | medium |
| ms.subservice | sharepoint |
| doc_type | resourcePageType |
| ms.date | 05/23/2024 |
Namespace: microsoft.graph.termStore
[!INCLUDE beta-disclaimer]
Represents the relationship between terms in a term store. Currently two types of relationships are supported: pin and reuse.
In a pin relationship, a term can be pinned under a different term in a different term set. In a pinned relationship, new children to the term can only be added in the term set in which the term was created. Any change in the hierarchy under the term is reflected across the sets in which the term was pinned.
The reuse relationship is similar to the pinned relationship except that changes to the reused term can be made from any hierarchy in which the term is reused. Also, a change in hierarchy made to the reused term doesn't get reflected in the other term sets in which the term is reused.
Inherits from entity.
| Method | Return type | Description |
|---|---|---|
| List | microsoft.graph.termstore.relation collection | Retrieve a list of relation objects. |
| Create | microsoft.graph.termstore.relation | Create a new relation object. |
| Property | Type | Description |
|---|---|---|
| id | String | The ID of the relation. |
| relationship | String | The type of relation. The possible values are: pin, reuse. |
| Relationship | Type | Description |
|---|---|---|
| fromTerm | microsoft.graph.termStore.term | The from term of the relation. The term from which the relationship is defined. A null value would indicate the relation is directly with the set. |
| set | microsoft.graph.termStore.set | The set in which the relation is relevant. |
| toTerm | microsoft.graph.termStore.term | The to term of the relation. The term to which the relationship is defined. |
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.termStore.relation",
"id": "String (identifier)",
"relationship": "String"
}