PurviewGlossaries.PartialUpdateGlossary 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 glossary partially. Some properties such as qualifiedName are not allowed to be updated.

public virtual Azure.Response PartialUpdateGlossary (string glossaryGuid, Azure.Core.RequestContent content, bool? includeTermHierarchy = default, Azure.RequestContext context = default);

abstract member PartialUpdateGlossary : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.PartialUpdateGlossary : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.Response

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

Parameters

glossaryGuid: String

The globally unique identifier for glossary.

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

Response

Exceptions

ArgumentNullException

glossaryGuid or content is null.

ArgumentException

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

Remarks

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,
              categories: [
                {
                  categoryGuid: string,
                  description: string,
                  displayText: string,
                  parentCategoryGuid: string,
                  relationGuid: string
                }
              ],
              language: string,
              terms: [
                {
                  description: string,
                  displayText: string,
                  expression: string,
                  relationGuid: string,
                  source: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                  steward: string,
                  termGuid: string
                }
              ],
              usage: string
            }

Schema for Response Error:

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

Applies to

Dela via