PurviewGlossaries.UpdateGlossaryTermAsync Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Catalog

Assembly:: Azure.Analytics.Purview.Catalog.dll

Package:: Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:: PurviewGlossaries.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Update the given glossary term by its GUID.

public virtual System.Threading.Tasks.Task<Azure.Response> UpdateGlossaryTermAsync (string termGuid, Azure.Core.RequestContent content, bool? includeTermHierarchy = default, Azure.RequestContext context = default);

abstract member UpdateGlossaryTermAsync : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateGlossaryTermAsync : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function UpdateGlossaryTermAsync (termGuid As String, content As RequestContent, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

termGuid: String

The globally unique identifier for glossary term.

content: RequestContent

The content to send as the body of the request.

includeTermHierarchy: Nullable<Boolean>

Whether include term hierarchy.

context: RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

termGuid or content is null.

ArgumentException

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

Remarks

Schema for Request Body:

{
              classifications: [
                {
                  attributes: Dictionary<string, AnyObject>,
                  typeName: string,
                  lastModifiedTS: string,
                  entityGuid: string,
                  entityStatus: "ACTIVE" | "DELETED",
                  removePropagationsOnEntityDelete: boolean,
                  validityPeriods: [
                    {
                      endTime: string,
                      startTime: string,
                      timeZone: string
                    }
                  ],
                  source: string,
                  sourceDetails: Dictionary<string, AnyObject>
                }
              ],
              longDescription: string,
              name: string,
              qualifiedName: string,
              shortDescription: string,
              lastModifiedTS: string,
              guid: string,
              abbreviation: string,
              templateName: [AnyObject],
              anchor: {
                displayText: string,
                glossaryGuid: string,
                relationGuid: string
              },
              antonyms: [
                {
                  description: string,
                  displayText: string,
                  expression: string,
                  relationGuid: string,
                  source: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                  steward: string,
                  termGuid: string
                }
              ],
              createTime: number,
              createdBy: string,
              updateTime: number,
              updatedBy: string,
              status: "Draft" | "Approved" | "Alert" | "Expired",
              resources: [
                {
                  displayName: string,
                  url: string
                }
              ],
              contacts: Dictionary<string, ContactBasic[]>,
              attributes: Dictionary<string, Dictionary<string, AnyObject>>,
              assignedEntities: [
                {
                  guid: string,
                  typeName: string,
                  uniqueAttributes: Dictionary<string, AnyObject>,
                  displayText: string,
                  entityStatus: "ACTIVE" | "DELETED",
                  relationshipType: string,
                  relationshipAttributes: {
                    attributes: Dictionary<string, AnyObject>,
                    typeName: string,
                    lastModifiedTS: string
                  },
                  relationshipGuid: string,
                  relationshipStatus: "ACTIVE" | "DELETED"
                }
              ],
              categories: [
                {
                  categoryGuid: string,
                  description: string,
                  displayText: string,
                  relationGuid: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER"
                }
              ],
              classifies: [AtlasRelatedTermHeader],
              examples: [string],
              isA: [AtlasRelatedTermHeader],
              preferredTerms: [AtlasRelatedTermHeader],
              preferredToTerms: [AtlasRelatedTermHeader],
              replacedBy: [AtlasRelatedTermHeader],
              replacementTerms: [AtlasRelatedTermHeader],
              seeAlso: [AtlasRelatedTermHeader],
              synonyms: [AtlasRelatedTermHeader],
              translatedTerms: [AtlasRelatedTermHeader],
              translationTerms: [AtlasRelatedTermHeader],
              usage: string,
              validValues: [AtlasRelatedTermHeader],
              validValuesFor: [AtlasRelatedTermHeader]
            }

Schema for Response Body:

{
              classifications: [
                {
                  attributes: Dictionary<string, AnyObject>,
                  typeName: string,
                  lastModifiedTS: string,
                  entityGuid: string,
                  entityStatus: "ACTIVE" | "DELETED",
                  removePropagationsOnEntityDelete: boolean,
                  validityPeriods: [
                    {
                      endTime: string,
                      startTime: string,
                      timeZone: string
                    }
                  ],
                  source: string,
                  sourceDetails: Dictionary<string, AnyObject>
                }
              ],
              longDescription: string,
              name: string,
              qualifiedName: string,
              shortDescription: string,
              lastModifiedTS: string,
              guid: string,
              abbreviation: string,
              templateName: [AnyObject],
              anchor: {
                displayText: string,
                glossaryGuid: string,
                relationGuid: string
              },
              antonyms: [
                {
                  description: string,
                  displayText: string,
                  expression: string,
                  relationGuid: string,
                  source: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                  steward: string,
                  termGuid: string
                }
              ],
              createTime: number,
              createdBy: string,
              updateTime: number,
              updatedBy: string,
              status: "Draft" | "Approved" | "Alert" | "Expired",
              resources: [
                {
                  displayName: string,
                  url: string
                }
              ],
              contacts: Dictionary<string, ContactBasic[]>,
              attributes: Dictionary<string, Dictionary<string, AnyObject>>,
              assignedEntities: [
                {
                  guid: string,
                  typeName: string,
                  uniqueAttributes: Dictionary<string, AnyObject>,
                  displayText: string,
                  entityStatus: "ACTIVE" | "DELETED",
                  relationshipType: string,
                  relationshipAttributes: {
                    attributes: Dictionary<string, AnyObject>,
                    typeName: string,
                    lastModifiedTS: string
                  },
                  relationshipGuid: string,
                  relationshipStatus: "ACTIVE" | "DELETED"
                }
              ],
              categories: [
                {
                  categoryGuid: string,
                  description: string,
                  displayText: string,
                  relationGuid: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER"
                }
              ],
              classifies: [AtlasRelatedTermHeader],
              examples: [string],
              isA: [AtlasRelatedTermHeader],
              preferredTerms: [AtlasRelatedTermHeader],
              preferredToTerms: [AtlasRelatedTermHeader],
              replacedBy: [AtlasRelatedTermHeader],
              replacementTerms: [AtlasRelatedTermHeader],
              seeAlso: [AtlasRelatedTermHeader],
              synonyms: [AtlasRelatedTermHeader],
              translatedTerms: [AtlasRelatedTermHeader],
              translationTerms: [AtlasRelatedTermHeader],
              usage: string,
              validValues: [AtlasRelatedTermHeader],
              validValuesFor: [AtlasRelatedTermHeader]
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }

Applies to

Dela via