Type - Get Entity Def By Name
Get the entity definition by its name (unique).
GET {endpoint}/datamap/api/atlas/v2/types/entitydef/name/{name}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
name
|
path | True |
string |
The name of the entity. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
An unexpected error response. |
Security
OAuth2Auth
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://purview.azure.net/.default |
Examples
Type_GetEntityDefByName
Sample request
GET {endpoint}/datamap/api/atlas/v2/types/entitydef/name/DataSet
Sample response
{
"category": "ENTITY",
"guid": "4bc54c37-98a8-4de8-9ee8-182610859d43",
"createdBy": "ExampleCreator",
"updatedBy": "ExampleUpdator",
"createTime": 1553065960959,
"updateTime": 1553065960959,
"version": 1,
"name": "DataSet",
"description": "DataSet",
"typeVersion": "1.1",
"attributeDefs": [],
"superTypes": [
"Asset"
],
"subTypes": [
"rdbms_foreign_key",
"azure_datalake_gen1_path",
"hive_table",
"mssql_column",
"sqoop_dbdatastore",
"hbase_column",
"azure_sql_table",
"rdbms_instance",
"azure_datalake_gen2_path",
"jms_topic",
"falcon_feed",
"hbase_table",
"rdbms_table",
"rdbms_column",
"hbase_column_family",
"hive_column",
"azure_blob_container",
"rdbms_db",
"column",
"azure_blob_path",
"kafka_topic",
"tabular_schema",
"azure_datalake_gen2_filesystem",
"rdbms_index",
"azure_sql_column",
"mssql_table",
"avro_type",
"fs_path"
]
}
Definitions
Name | Description |
---|---|
Atlas |
class that captures details of a struct-attribute. |
Atlas |
class that captures details of a constraint. |
Atlas |
class that captures details of a entity-type. |
Atlas |
An error response from the service |
Atlas |
The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship. |
Cardinality |
Cardinality |
Date |
The date format. |
Number |
The number format. |
Rounding |
Rounding Mode |
Time |
The timezone information. |
Type |
Type Category |
AtlasAttributeDef
class that captures details of a struct-attribute.
Name | Type | Description |
---|---|---|
cardinality |
single-valued attribute or multi-valued attribute. |
|
constraints |
An array of constraints. |
|
defaultValue |
string |
The default value of the attribute. |
description |
string |
The description of the attribute. |
includeInNotification |
boolean |
Determines if it is included in notification. |
isIndexable |
boolean |
Determines if it is indexable. |
isOptional |
boolean |
Determines if it is optional. |
isUnique |
boolean |
Determines if it unique. |
name |
string |
The name of the attribute. |
options |
object |
The options for the attribute. |
typeName |
string |
The name of the type. |
valuesMaxCount |
integer |
The maximum count of the values. |
valuesMinCount |
integer |
The minimum count of the values. |
AtlasConstraintDef
class that captures details of a constraint.
Name | Type | Description |
---|---|---|
params |
|
The parameters of the constraint definition. |
type |
string |
The type of the constraint. |
AtlasEntityDef
class that captures details of a entity-type.
Name | Type | Description |
---|---|---|
attributeDefs |
An array of attribute definitions. |
|
category |
The enum of type category. |
|
createTime |
integer |
The created time of the record. |
createdBy |
string |
The user who created the record. |
dateFormatter |
The date format. |
|
description |
string |
The description of the type definition. |
guid |
string |
The GUID of the type definition. |
lastModifiedTS |
string |
ETag for concurrency control. |
name |
string |
The name of the type definition. |
options |
object |
The options for the type definition. |
relationshipAttributeDefs |
An array of relationship attributes. |
|
serviceType |
string |
The service type. |
subTypes |
string[] |
An array of sub types. |
superTypes |
string[] |
An array of super types. |
typeVersion |
string |
The version of the type. |
updateTime |
integer |
The update time of the record. |
updatedBy |
string |
The user who updated the record. |
version |
integer |
The version of the record. |
AtlasErrorResponse
An error response from the service
Name | Type | Description |
---|---|---|
errorCode |
string |
The error code. |
errorMessage |
string |
The error message. |
requestId |
string |
The request ID. |
AtlasRelationshipAttributeDef
The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.
Name | Type | Description |
---|---|---|
cardinality |
single-valued attribute or multi-valued attribute. |
|
constraints |
An array of constraints. |
|
defaultValue |
string |
The default value of the attribute. |
description |
string |
The description of the attribute. |
includeInNotification |
boolean |
Determines if it is included in notification. |
isIndexable |
boolean |
Determines if it is indexable. |
isLegacyAttribute |
boolean |
Determines if it is a legacy attribute. |
isOptional |
boolean |
Determines if it is optional. |
isUnique |
boolean |
Determines if it unique. |
name |
string |
The name of the attribute. |
options |
object |
The options for the attribute. |
relationshipTypeName |
string |
The name of the relationship type. |
typeName |
string |
The name of the type. |
valuesMaxCount |
integer |
The maximum count of the values. |
valuesMinCount |
integer |
The minimum count of the values. |
CardinalityValue
Cardinality
Name | Type | Description |
---|---|---|
LIST |
string |
list |
SET |
string |
set |
SINGLE |
string |
single |
DateFormat
The date format.
Name | Type | Description |
---|---|---|
availableLocales |
string[] |
An array of available locales. |
calendar |
number |
Calendar |
dateInstance |
The date format. |
|
dateTimeInstance |
The date format. |
|
instance |
The date format. |
|
lenient |
boolean |
Determines the leniency of the date format. |
numberFormat |
The number format. |
|
timeInstance |
The date format. |
|
timeZone |
The timezone information. |
NumberFormat
The number format.
Name | Type | Description |
---|---|---|
availableLocales |
string[] |
The number format. |
currency |
string |
The currency. |
currencyInstance |
The number format. |
|
groupingUsed |
boolean |
Determines if grouping is used. |
instance |
The number format. |
|
integerInstance |
The number format. |
|
maximumFractionDigits |
integer |
The maximum of fraction digits. |
maximumIntegerDigits |
integer |
The maximum of integer digits. |
minimumFractionDigits |
integer |
The minimum of fraction digits. |
minimumIntegerDigits |
integer |
The minimum of integer digits. |
numberInstance |
The number format. |
|
parseIntegerOnly |
boolean |
Determines if only integer is parsed. |
percentInstance |
The number format. |
|
roundingMode |
The enum of rounding mode. |
RoundingMode
Rounding Mode
Name | Type | Description |
---|---|---|
CEILING |
string |
ceiling |
DOWN |
string |
down |
FLOOR |
string |
floor |
HALF_DOWN |
string |
half down |
HALF_EVEN |
string |
half even |
HALF_UP |
string |
half up |
UNNECESSARY |
string |
unnecessary |
UP |
string |
up |
TimeZone
The timezone information.
Name | Type | Description |
---|---|---|
availableIds |
string[] |
An array of available IDs. |
default |
The timezone information. |
|
displayName |
string |
The display name of the timezone. |
dstSavings |
integer |
The value of the daylight saving time. |
id |
string |
The ID of the timezone. |
rawOffset |
integer |
The raw offset of the timezone. |
TypeCategory
Type Category
Name | Type | Description |
---|---|---|
ARRAY |
string |
array |
CLASSIFICATION |
string |
classification |
ENTITY |
string |
entity |
ENUM |
string |
enum |
MAP |
string |
map |
OBJECT_ID_TYPE |
string |
object id type |
PRIMITIVE |
string |
primitive |
RELATIONSHIP |
string |
relationship |
STRUCT |
string |
struct |
TERM_TEMPLATE |
string |
term template |