Glossary.GetRelatedTerms Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

Azure.Analytics.Purview.DataMap v1.0.0-beta.1

Overloads

GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) convenience overload with strongly typed models first.

GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

Source:

Glossary.cs

[Protocol Method] Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetRelatedTerms (string termId, int? limit, int? offset, string sort, Azure.RequestContext context);

abstract member GetRelatedTerms : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response
override this.GetRelatedTerms : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetRelatedTerms (termId As String, limit As Nullable(Of Integer), offset As Nullable(Of Integer), sort As String, context As RequestContext) As Response

Parameters

termId

String

The globally unique identifier for glossary term.

limit

Nullable<Int32>

The page size - by default there is no paging.

offset

Nullable<Int32>

The offset for pagination purpose.

sort

String

The sort order, ASC (default) or DESC.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

termId is null.

ArgumentException

termId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetRelatedTerms and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response response = client.GetRelatedTerms("<termId>", null, null, null, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("<key>")[0].ToString());

This sample shows how to call GetRelatedTerms with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient(apiVersion: "2023-09-01");

Response response = client.GetRelatedTerms("<termId>", 1234, 1234, "<sort>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("expression").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("steward").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("termGuid").ToString());

GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Source:

Glossary.cs

Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyDictionary<string,System.Collections.Generic.IList<Azure.Analytics.Purview.DataMap.AtlasRelatedTermHeader>>> GetRelatedTerms (string termId, int? limit = default, int? offset = default, string sort = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRelatedTerms : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IList<Azure.Analytics.Purview.DataMap.AtlasRelatedTermHeader>>>
override this.GetRelatedTerms : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IList<Azure.Analytics.Purview.DataMap.AtlasRelatedTermHeader>>>

Public Overridable Function GetRelatedTerms (termId As String, Optional limit As Nullable(Of Integer) = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional sort As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyDictionary(Of String, IList(Of AtlasRelatedTermHeader)))

Parameters

termId

String

The globally unique identifier for glossary term.

limit

Nullable<Int32>

The page size - by default there is no paging.

offset

Nullable<Int32>

The offset for pagination purpose.

sort

String

The sort order, ASC (default) or DESC.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyDictionary<String,IList<AtlasRelatedTermHeader>>>

Exceptions

ArgumentNullException

termId is null.

ArgumentException

termId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetRelatedTerms.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response<IReadOnlyDictionary<string, IList<AtlasRelatedTermHeader>>> response = client.GetRelatedTerms("<termId>");

This sample shows how to call GetRelatedTerms with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient(apiVersion: "2023-09-01");

Response<IReadOnlyDictionary<string, IList<AtlasRelatedTermHeader>>> response = client.GetRelatedTerms("<termId>", limit: 1234, offset: 1234, sort: "<sort>");