Type - Get Struct Def By Guid
Get the struct definition for the given GUID.
GET {endpoint}/datamap/api/atlas/v2/types/structdef/guid/{guid}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
guid
|
path | True |
string |
The globally unique identifier of the struct. |
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_GetStructDefByGuid
Sample request
GET {endpoint}/datamap/api/atlas/v2/types/structdef/guid/f1571b6e-ad08-4040-a9a7-c30ed935d437
Sample response
{
"category": "STRUCT",
"guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437",
"createdBy": "ExampleCreator",
"updatedBy": "ExampleUpdator",
"createTime": 1553065968145,
"updateTime": 1553065968145,
"version": 1,
"name": "hive_order",
"description": "hive_order",
"typeVersion": "1.0",
"attributeDefs": [
{
"name": "order",
"typeName": "int",
"isOptional": false,
"cardinality": "SINGLE",
"valuesMinCount": 1,
"valuesMaxCount": 1,
"isUnique": false,
"isIndexable": false,
"includeInNotification": false
},
{
"name": "col",
"typeName": "string",
"isOptional": false,
"cardinality": "SINGLE",
"valuesMinCount": 1,
"valuesMaxCount": 1,
"isUnique": false,
"isIndexable": false,
"includeInNotification": false
}
]
}
Definitions
Name | Description |
---|---|
Atlas |
class that captures details of a struct-attribute. |
Atlas |
class that captures details of a constraint. |
Atlas |
An error response from the service |
Atlas |
class that captures details of a struct-type. |
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. |
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. |
AtlasStructDef
class that captures details of a struct-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. |
serviceType |
string |
The service type. |
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. |
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 |