PurviewTypes.GetEntityDefinitionByName(String, RequestContext) 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.
Get the entity definition by its name (unique).
public virtual Azure.Response GetEntityDefinitionByName (string name, Azure.RequestContext context = default);
abstract member GetEntityDefinitionByName : string * Azure.RequestContext -> Azure.Response
override this.GetEntityDefinitionByName : string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetEntityDefinitionByName (name As String, Optional context As RequestContext = Nothing) As Response
Parameters
- name
- String
The name of the entity.
- context
- RequestContext
The request context, which can override default behaviors on the request on a per-call basis.
Returns
Exceptions
name
is null.
name
is an empty string, and was expected to be non-empty.
Remarks
Schema for Response Body
:
{
attributeDefs: [
{
cardinality: "SINGLE" | "LIST" | "SET",
constraints: [
{
params: Dictionary<string, AnyObject>,
type: string
}
],
defaultValue: string,
description: string,
includeInNotification: boolean,
isIndexable: boolean,
isOptional: boolean,
isUnique: boolean,
name: string,
options: Dictionary<string, string>,
typeName: string,
valuesMaxCount: number,
valuesMinCount: number
}
],
category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE",
createTime: number,
createdBy: string,
dateFormatter: {
availableLocales: [string],
calendar: number,
dateInstance: DateFormat,
dateTimeInstance: DateFormat,
instance: DateFormat,
lenient: boolean,
numberFormat: {
availableLocales: [string],
currency: string,
currencyInstance: NumberFormat,
groupingUsed: boolean,
instance: NumberFormat,
integerInstance: NumberFormat,
maximumFractionDigits: number,
maximumIntegerDigits: number,
minimumFractionDigits: number,
minimumIntegerDigits: number,
numberInstance: NumberFormat,
parseIntegerOnly: boolean,
percentInstance: NumberFormat,
roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY"
},
timeInstance: DateFormat,
timeZone: {
dstSavings: number,
id: string,
availableIds: [string],
default: TimeZone,
displayName: string,
rawOffset: number
}
},
description: string,
guid: string,
name: string,
options: Dictionary<string, string>,
serviceType: string,
typeVersion: string,
updateTime: number,
updatedBy: string,
version: number,
lastModifiedTS: string,
subTypes: [string],
superTypes: [string],
relationshipAttributeDefs: [
{
cardinality: "SINGLE" | "LIST" | "SET",
constraints: [AtlasConstraintDef],
defaultValue: string,
description: string,
includeInNotification: boolean,
isIndexable: boolean,
isOptional: boolean,
isUnique: boolean,
name: string,
options: Dictionary<string, string>,
typeName: string,
valuesMaxCount: number,
valuesMinCount: number,
isLegacyAttribute: boolean,
relationshipTypeName: string
}
]
}
Schema for Response Error
:
{
requestId: string,
errorCode: string,
errorMessage: string
}
Applies to
Collabora con noi su GitHub
L'origine di questo contenuto è disponibile in GitHub, in cui è anche possibile creare ed esaminare i problemi e le richieste pull. Per ulteriori informazioni, vedere la guida per i collaboratori.