PurviewGlossaries.PartialUpdateGlossaryCategoryAsync Method

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

Update the glossary category partially.

public virtual System.Threading.Tasks.Task<Azure.Response> PartialUpdateGlossaryCategoryAsync (string categoryGuid, Azure.Core.RequestContent content, Azure.RequestContext context = default);

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

Public Overridable Function PartialUpdateGlossaryCategoryAsync (categoryGuid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

categoryGuid

String

The globally unique identifier of the category.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

categoryGuid or content is null.

ArgumentException

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

Schema for Response Error:

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