relation resource type

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.

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 does not get reflected in the other term sets in which the term is reused.

Inherits from entity.

Methods

Method Return type Description
List relations microsoft.graph.termstore.relation collection Retrieve a list of relation objects.
Create relation microsoft.graph.termstore.relation Create a new relation object.

Properties

Property Type Description
id String The ID of the relation.
relationship String The type of relation. Possible values are: pin, reuse.

Relationships

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.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.termStore.relation",
  "id": "String (identifier)",
  "relationship": "String"
}