PurviewGlossaries.UpdateGlossaryCategory Method
Definition
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 category by its GUID.
public virtual Azure.Response UpdateGlossaryCategory (string categoryGuid, Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member UpdateGlossaryCategory : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateGlossaryCategory : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
Public Overridable Function UpdateGlossaryCategory (categoryGuid As String, content As RequestContent, Optional context As RequestContext = Nothing) As 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
Exceptions
categoryGuid
or content
is null.
categoryGuid
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,
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 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
}