PurviewGlossaries.CreateGlossaryTermAsync(RequestContent, Nullable<Boolean>, RequestOptions) Method

Definition

Create a glossary term.

public virtual System.Threading.Tasks.Task<Azure.Response> CreateGlossaryTermAsync (Azure.Core.RequestContent requestBody, bool? includeTermHierarchy = default, Azure.RequestOptions requestOptions = default);
abstract member CreateGlossaryTermAsync : Azure.Core.RequestContent * Nullable<bool> * Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateGlossaryTermAsync : Azure.Core.RequestContent * Nullable<bool> * Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CreateGlossaryTermAsync (requestBody As RequestContent, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional requestOptions As RequestOptions = Nothing) As Task(Of Response)

Parameters

requestBody
RequestContent

The request body.

includeTermHierarchy
Nullable<Boolean>

Whether include term hierarchy.

requestOptions
RequestOptions

The request options.

Returns

Task<Response>

Remarks

Schema for Request Body:

classificationsAtlasClassification[] An array of classifications.
longDescriptionstring The long version description.
namestring The name of the glossary object.
qualifiedNamestring The qualified name of the glossary object.
shortDescriptionstring The short version of description.
lastModifiedTSstring ETag for concurrency control.
guidstring The GUID of the object.
abbreviationstring The abbreviation of the term.
templateNameAnyObject[]
anchorAtlasGlossaryHeader The glossary header with basic information.
antonymsAtlasRelatedTermHeader[] An array of related term headers as antonyms.
createTimenumber The created time of the record.
createdBystring The user who created the record.
updateTimenumber The update time of the record.
updatedBystring The user who updated the record.
status"Draft" | "Approved" | "Alert" | "Expired" Status of the AtlasGlossaryTerm.
resourcesResourceLink[] An array of resource link for term.
contactsDictionary<string, ContactBasic[]> The dictionary of contacts for terms. Key could be Expert or Steward.
attributesDictionary<string, Dictionary<string, AnyObject>> The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.
assignedEntitiesAtlasRelatedObjectId[] An array of related object IDs.
categoriesAtlasTermCategorizationHeader[] An array of term categorization headers.
classifiesAtlasRelatedTermHeader[] An array of related term headers.
examplesstring[] An array of examples.
isAAtlasRelatedTermHeader[] An array of related term headers indicating the is-a relationship.
preferredTermsAtlasRelatedTermHeader[] An array of preferred related term headers.
preferredToTermsAtlasRelatedTermHeader[] An array of related term headers that are preferred to.
replacedByAtlasRelatedTermHeader[] An array of related term headers that are replaced by.
replacementTermsAtlasRelatedTermHeader[] An array of related term headers for replacement.
seeAlsoAtlasRelatedTermHeader[] An array of related term headers for see also.
synonymsAtlasRelatedTermHeader[] An array of related term headers as synonyms.
translatedTermsAtlasRelatedTermHeader[] An array of translated related term headers.
translationTermsAtlasRelatedTermHeader[] An array of related term headers for translation.
usagestring The usage of the term.
validValuesAtlasRelatedTermHeader[] An array of related term headers as valid values.
validValuesForAtlasRelatedTermHeader[] An array of related term headers as valid values for other records.
Schema for AtlasGlossaryHeader:
displayTextstring The display text.
glossaryGuidstring The GUID of the glossary.
relationGuidstring The GUID of the relationship.
Schema for AtlasClassification:
attributesDictionary<string, AnyObject> The attributes of the struct.
typeNamestring The name of the type.
lastModifiedTSstring ETag for concurrency control.
entityGuidstring The GUID of the entity.
entityStatus"ACTIVE" | "DELETED" Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.
removePropagationsOnEntityDeleteboolean Determines if propagations will be removed on entity deletion.
validityPeriodsTimeBoundary[] An array of time boundaries indicating validity periods.
sourcestring indicate the source who create the classification detail.
sourceDetailsDictionary<string, AnyObject> more detail on source information.
Schema for AtlasRelatedTermHeader:
descriptionstring The description of the related term.
displayTextstring The display text.
expressionstring The expression of the term.
relationGuidstring The GUID of the relationship.
sourcestring The source of the term.
status"DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER" The status of term relationship.
stewardstring The steward of the term.
termGuidstring The GUID of the term.
Schema for ResourceLink:
displayNamestring Display name for url.
urlstring web url. http or https.
Schema for AtlasRelatedObjectId:
guidstring The GUID of the object.
typeNamestring The name of the type.
uniqueAttributesDictionary<string, AnyObject> The unique attributes of the object.
displayTextstring The display text.
entityStatus"ACTIVE" | "DELETED" Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.
relationshipTypestring
relationshipAttributesAtlasStruct Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
relationshipGuidstring The GUID of the relationship.
relationshipStatus"ACTIVE" | "DELETED" The enum of relationship status.
Schema for AtlasTermCategorizationHeader:
categoryGuidstring The GUID of the category.
descriptionstring The description of the record.
displayTextstring The display text.
relationGuidstring The GUID of the relationship.
status"DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER" The status of term relationship.
Schema for ContactBasic:
idstring Azure Active Directory object Id.
infostring additional information to describe this contact.
Schema for AtlasStruct:
attributesDictionary<string, AnyObject> The attributes of the struct.
typeNamestring The name of the type.
lastModifiedTSstring ETag for concurrency control.
Schema for TimeBoundary:
endTimestring The end of the time boundary.
startTimestring The start of the time boundary.
timeZonestring The timezone of the time boundary.

Applies to