Azure.Analytics.Purview.DataMap (preview:2024-03-01)

2025/12/05 • 97 deleted methods

Entity_CreateOrUpdate (removed)
Description :  Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
businessAttributeUpdateBehavior:
{
Description: Used to define the update behavior for business attributes when updating entities. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
referredEntities:
{
Description: The referred entities. ,
Required: False ,
}
object ,
entity:
{
Description: An instance of an entity - like hive_table, hive_database. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
businessAttributes:
{
Description: Business attributes ,
Required: False ,
}
object ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
customAttributes:
{
Description: Custom Attribute ,
Required: False ,
}
object ,
guid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the entity. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection ID of the entity. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers indicating the meanings of the entity. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship. ,
Format: int32 ,
Required: False ,
}
integer ,
proxy:
{
Description: Determines if there's a proxy. ,
Required: False ,
}
boolean ,
relationshipAttributes:
{
Description: The attributes of relationship. ,
Required: False ,
}
object ,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the entity. ,
Format: int64 ,
Required: False ,
}
integer ,
contacts:
{
Description: The dictionary of contacts for entities. Key could be Expert or Owner. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_ListByGuids (removed)
Description :  List entities in bulk identified by its GUIDs.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/bulk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
guid:
{
Description: An array of GUIDs of entities to list. ,
Required: True ,
}
array ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
referredEntities:
{
Description: The referred entities. ,
Required: False ,
}
object ,
entities:
{
Description: An array of entities. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
businessAttributes:
{
Description: Business attributes ,
Required: False ,
}
object ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
customAttributes:
{
Description: Custom Attribute ,
Required: False ,
}
object ,
guid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the entity. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection ID of the entity. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers indicating the meanings of the entity. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship. ,
Format: int32 ,
Required: False ,
}
integer ,
proxy:
{
Description: Determines if there's a proxy. ,
Required: False ,
}
boolean ,
relationshipAttributes:
{
Description: The attributes of relationship. ,
Required: False ,
}
object ,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the entity. ,
Format: int64 ,
Required: False ,
}
integer ,
contacts:
{
Description: The dictionary of contacts for entities. Key could be Expert or Owner. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_BulkCreateOrUpdate (removed)
Description :  Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>. For each contact type, the maximum number of contacts is 20.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. ,
Required: False ,
}
string ,
businessAttributeUpdateBehavior:
{
Description: Used to define the update behavior for business attributes when updating entities. ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
referredEntities:
{
Description: The referred entities. ,
Required: False ,
}
object ,
entities:
{
Description: An array of entities. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
businessAttributes:
{
Description: Business attributes ,
Required: False ,
}
object ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
customAttributes:
{
Description: Custom Attribute ,
Required: False ,
}
object ,
guid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the entity. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection ID of the entity. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers indicating the meanings of the entity. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship. ,
Format: int32 ,
Required: False ,
}
integer ,
proxy:
{
Description: Determines if there's a proxy. ,
Required: False ,
}
boolean ,
relationshipAttributes:
{
Description: The attributes of relationship. ,
Required: False ,
}
object ,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the entity. ,
Format: int64 ,
Required: False ,
}
integer ,
contacts:
{
Description: The dictionary of contacts for entities. Key could be Expert or Owner. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_BulkDelete (removed)
Description :  Delete a list of entities in bulk identified by their GUIDs or unique attributes.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/bulk
{
guid:
{
Description: An array of GUIDs of entities to delete. ,
Required: True ,
}
array ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddClassification (removed)
Description :  Associate a classification to multiple entities in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk/classification
{
body:
{
Required: True ,
}
{
classification:
{
Description: An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
entityGuids:
{
Description: The GUID of the entity. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_BulkSetClassifications (removed)
Description :  Set classifications on entities in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/bulk/setClassifications
{
body:
{
Required: True ,
}
{
guidHeaderMap:
{
Description: The description of the guid header map, ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_ListByUniqueAttributes (removed)
Description :  Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=\&attr_1:\=\&attr_2:\=\&attr_3:\=\ NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
attr_N:qualifiedName:
{
Description: Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
referredEntities:
{
Description: The referred entities. ,
Required: False ,
}
object ,
entities:
{
Description: An array of entities. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
businessAttributes:
{
Description: Business attributes ,
Required: False ,
}
object ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
customAttributes:
{
Description: Custom Attribute ,
Required: False ,
}
object ,
guid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the entity. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection ID of the entity. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers indicating the meanings of the entity. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship. ,
Format: int32 ,
Required: False ,
}
integer ,
proxy:
{
Description: Determines if there's a proxy. ,
Required: False ,
}
boolean ,
relationshipAttributes:
{
Description: The attributes of relationship. ,
Required: False ,
}
object ,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the entity. ,
Format: int64 ,
Required: False ,
}
integer ,
contacts:
{
Description: The dictionary of contacts for entities. Key could be Expert or Owner. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_ImportBusinessMetadata (removed)
Description :  Upload the file for creating Business Metadata in BULK
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/businessmetadata/import
{
file:
{
Description: InputStream of file ,
Required: True ,
}
file ,
}

⚐ Response (200)

{
failedImportInfoList:
{
Description: failed importInfoList ,
Required: False ,
}
[
{
childObjectName:
{
Description: childObjectName ,
Required: False ,
}
string ,
importStatus:
{
Description: importStatus ,
Enum:
{
SUCCESS: Success ,
FAILED: Failed ,
}
,
Required: False ,
}
enum ,
parentObjectName:
{
Description: parentObjectName ,
Required: False ,
}
string ,
remarks:
{
Description: remarks ,
Required: False ,
}
string ,
}
,
]
,
successImportInfoList:
{
Description: successful importInfoList ,
Required: False ,
}
[
{
childObjectName:
{
Description: childObjectName ,
Required: False ,
}
string ,
importStatus:
{
Description: importStatus ,
Enum:
{
SUCCESS: Success ,
FAILED: Failed ,
}
,
Required: False ,
}
enum ,
parentObjectName:
{
Description: parentObjectName ,
Required: False ,
}
string ,
remarks:
{
Description: remarks ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetSampleBusinessMetadataTemplate (removed)
Description :  Get the sample Template for uploading/creating bulk BusinessMetaData
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/businessmetadata/import/template
{}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_Get (removed)
Description :  Get complete definition of an entity given its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
referredEntities:
{
Description: The referred entities. ,
Required: False ,
}
object ,
entity:
{
Description: An instance of an entity - like hive_table, hive_database. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
businessAttributes:
{
Description: Business attributes ,
Required: False ,
}
object ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
customAttributes:
{
Description: Custom Attribute ,
Required: False ,
}
object ,
guid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the entity. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection ID of the entity. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers indicating the meanings of the entity. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship. ,
Format: int32 ,
Required: False ,
}
integer ,
proxy:
{
Description: Determines if there's a proxy. ,
Required: False ,
}
boolean ,
relationshipAttributes:
{
Description: The attributes of relationship. ,
Required: False ,
}
object ,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the entity. ,
Format: int64 ,
Required: False ,
}
integer ,
contacts:
{
Description: The dictionary of contacts for entities. Key could be Expert or Owner. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_PartialUpdateAttributeByGuid (removed)
Description :  Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/entity/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
name:
{
Description: The name of the attribute. ,
Required: True ,
}
string ,
body:
{
Description: The value of the attribute. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_Delete (removed)
Description :  Delete an entity identified by its GUID.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddOrUpdateBusinessMetadata (removed)
Description :  Add business metadata to an entity.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/businessmetadata
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
isOverwrite:
{
Description: Whether to overwrite the existing business metadata on the entity or not, default is false. ,
Required: False ,
}
boolean ,
body:
{
Description: BusinessMetadata payload ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_RemoveBusinessMetadata (removed)
Description :  Remove business metadata from an entity.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/businessmetadata
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: Business metadata payload ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddOrUpdateBusinessMetadataAttributes (removed)
Description :  Add or update business metadata attributes.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}
{
businessMetadataName:
{
Description: BusinessMetadata name ,
Required: True ,
}
string ,
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: Business metadata attribute payload ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_RemoveBusinessMetadataAttributes (removed)
Description :  Delete business metadata attributes from an entity.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}
{
businessMetadataName:
{
Description: BusinessMetadata name ,
Required: True ,
}
string ,
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: Business metadata attribute payload ,
Required: True ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetClassification (removed)
Description :  Get classification for a given entity represented by a GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/classification/{classificationName}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
classificationName:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_RemoveClassification (removed)
Description :  Delete a given classification from an existing entity represented by a GUID.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/classification/{classificationName}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
classificationName:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetClassifications (removed)
Description :  List classifications for a given entity represented by a GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/classifications
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
list:
{
Description: An array of objects. ,
Required: False ,
}
[
string ,
]
,
pageSize:
{
Description: The size of the page. ,
Format: int32 ,
Required: False ,
}
integer ,
sortBy:
{
Description: The sorted by field. ,
Required: False ,
}
string ,
sortType:
{
Description: to specify whether the result should be sorted? If yes, whether asc or desc. ,
Enum:
{
NONE: No sorting order ,
ASC: Use ascending order for sorting ,
DESC: Use descending order for sorting ,
}
,
Required: False ,
}
enum ,
startIndex:
{
Description: The start index of the page. ,
Format: int32 ,
Required: False ,
}
integer ,
totalCount:
{
Description: The total count of items. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_UpdateClassifications (removed)
Description :  Update classifications to an existing entity represented by a guid.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/entity/guid/{guid}/classifications
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: An array of classifications to be updated. ,
Required: True ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddClassifications (removed)
Description :  Add classifications to an existing entity represented by a GUID.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/classifications
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: An array of classifications to be added. ,
Required: True ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetHeader (removed)
Description :  Get entity header given its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/guid/{guid}/header
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddLabel (removed)
Description :  Add given labels to a given entity.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/entity/guid/{guid}/labels
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: set of labels to be added ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_SetLabels (removed)
Description :  Set labels to a given entity.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/guid/{guid}/labels
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: set of labels to be set to the entity ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_RemoveLabels (removed)
Description :  Delete given labels to a given entity.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/guid/{guid}/labels
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
body:
{
Description: set of labels to be deleted ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_GetByUniqueAttributes (removed)
Description :  Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/entity/uniqueAttribute/type/{typeName}
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
minExtInfo:
{
Description: Whether to return minimal information for referred entities. ,
Required: False ,
}
boolean ,
ignoreRelationships:
{
Description: Whether to ignore relationship attributes. ,
Required: False ,
}
boolean ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
referredEntities:
{
Description: The referred entities. ,
Required: False ,
}
object ,
entity:
{
Description: An instance of an entity - like hive_table, hive_database. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
businessAttributes:
{
Description: Business attributes ,
Required: False ,
}
object ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
customAttributes:
{
Description: Custom Attribute ,
Required: False ,
}
object ,
guid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the entity. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection ID of the entity. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers indicating the meanings of the entity. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship. ,
Format: int32 ,
Required: False ,
}
integer ,
proxy:
{
Description: Determines if there's a proxy. ,
Required: False ,
}
boolean ,
relationshipAttributes:
{
Description: The attributes of relationship. ,
Required: False ,
}
object ,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the entity. ,
Format: int64 ,
Required: False ,
}
integer ,
contacts:
{
Description: The dictionary of contacts for entities. Key could be Expert or Owner. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_PartialUpdateByUniqueAttributes (removed)
Description :  Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/entity/uniqueAttribute/type/{typeName}
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
referredEntities:
{
Description: The referred entities. ,
Required: False ,
}
object ,
entity:
{
Description: An instance of an entity - like hive_table, hive_database. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
businessAttributes:
{
Description: Business attributes ,
Required: False ,
}
object ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
customAttributes:
{
Description: Custom Attribute ,
Required: False ,
}
object ,
guid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the entity. ,
Required: False ,
}
string ,
collectionId:
{
Description: The collection ID of the entity. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers indicating the meanings of the entity. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship. ,
Format: int32 ,
Required: False ,
}
integer ,
proxy:
{
Description: Determines if there's a proxy. ,
Required: False ,
}
boolean ,
relationshipAttributes:
{
Description: The attributes of relationship. ,
Required: False ,
}
object ,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the entity. ,
Format: int64 ,
Required: False ,
}
integer ,
contacts:
{
Description: The dictionary of contacts for entities. Key could be Expert or Owner. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_DeleteByUniqueAttribute (removed)
Description :  Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\=\. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/uniqueAttribute/type/{typeName}
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_RemoveClassificationByUniqueAttribute (removed)
Description :  Delete a given classification from an entity identified by its type and unique attributes.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
classificationName:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_UpdateClassificationsByUniqueAttribute (removed)
Description :  Update classification on an entity identified by its type and unique attributes.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: An array of classification to be updated. ,
Required: True ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddClassificationsByUniqueAttribute (removed)
Description :  Add classification to the entity identified by its type and unique attributes.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: An array of classification to be added. ,
Required: True ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_AddLabelsByUniqueAttribute (removed)
Description :  Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: set of labels to be added ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_SetLabelsByUniqueAttribute (removed)
Description :  Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: set of labels to be set ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_RemoveLabelsByUniqueAttribute (removed)
Description :  Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
body:
{
Description: set of labels to be deleted ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_List (removed)
Description :  Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
ignoreTermsAndCategories:
{
Description: Whether ignore terms and categories ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_Create (removed)
Description :  Create a glossary.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary
{
body:
{
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_Get (removed)
Description :  Get a specific Glossary by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryId}
{
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_Update (removed)
Description :  Update the given glossary.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/{glossaryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
ignoreTermsAndCategories:
{
Description: Whether ignore terms and categories ,
Required: False ,
}
boolean ,
body:
{
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_Delete (removed)
Description :  Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/{glossaryId}
{
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListCategories (removed)
Description :  Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryId}/categories
{
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListCategoriesHeaders (removed)
Description :  Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryId}/categories/headers
{
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetDetailed (removed)
Description :  Get a specific glossary with detailed information. This API is not recommend. Recommend to fetch terms/categories details separately using GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryId}/detailed
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
categoryInfo:
{
Description: The glossary category information. ,
Required: False ,
}
object ,
termInfo:
{
Description: The glossary term information. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_PartialUpdate (removed)
Description :  Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/{glossaryId}/partial
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
ignoreTermsAndCategories:
{
Description: Whether ignore terms and categories ,
Required: False ,
}
boolean ,
body:
{
Description: A map containing keys as attribute names and values as corresponding attribute values. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
categories:
{
Description: An array of categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The language of the glossary. ,
Required: False ,
}
string ,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the glossary. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListTerms (removed)
Description :  Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryId}/terms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListTermHeaders (removed)
Description :  Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/{glossaryId}/terms/headers
{
glossaryId:
{
Description: The globally unique identifier for glossary. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateCategories (removed)
Description :  Create glossary category in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/categories
{
body:
{
Description: An array of glossary category definitions to be created. ,
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateCategory (removed)
Description :  Create a glossary category.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/category
{
body:
{
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetCategory (removed)
Description :  Get specific glossary category by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryId}
{
categoryId:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_UpdateCategory (removed)
Description :  Update the given glossary category by its GUID.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/category/{categoryId}
{
categoryId:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_DeleteCategory (removed)
Description :  Delete a glossary category.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/category/{categoryId}
{
categoryId:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_PartialUpdateCategory (removed)
Description :  Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/category/{categoryId}/partial
{
categoryId:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
body:
{
Description: A map containing keys as attribute names and values as corresponding attribute values for partial update. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
childrenCategories:
{
Description: An array of children categories. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
parentCategory:
{
Description: The header of the related category. ,
Required: False ,
}
{
categoryGuid:
{
Description: The GUID of the category. ,
Required: False ,
}
string ,
description:
{
Description: The description of the category header. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
parentCategoryGuid:
{
Description: The GUID of the parent category. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
terms:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListRelatedCategories (removed)
Description :  Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryId}/related
{
categoryId:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListCategoryTerms (removed)
Description :  Get all terms associated with the specific category.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/category/{categoryId}/terms
{
categoryId:
{
Description: The globally unique identifier of the category. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateTerm (removed)
Description :  Create a glossary term.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/term
{
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
body:
{
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_GetTerm (removed)
Description :  Get a specific glossary term by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/term/{termId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_UpdateTerm (removed)
Description :  Update the given glossary term by its GUID.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/term/{termId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
body:
{
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_DeleteTerm (removed)
Description :  Delete a glossary term.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/term/{termId}
{
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_PartialUpdateTerm (removed)
Description :  Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/glossary/term/{termId}/partial
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
body:
{
Description: A map containing keys as attribute names and values as corresponding attribute values to be updated. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_CreateTerms (removed)
Description :  Create glossary terms in bulk.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/terms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
includeTermHierarchy:
{
Description: Whether include term hierarchy ,
Required: False ,
}
boolean ,
body:
{
Description: An array of glossary term definitions to be created in bulk. ,
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
longDescription:
{
Description: The long version description. ,
Required: False ,
}
string ,
name:
{
Description: The name of the glossary object. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the glossary object. ,
Required: False ,
}
string ,
shortDescription:
{
Description: The short version of description. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
abbreviation:
{
Description: The abbreviation of the term. ,
Required: False ,
}
string ,
templateName:
{
Description: The name of the template. ,
Required: False ,
}
[
string ,
]
,
anchor:
{
Description: The glossary header with basic information. ,
Required: False ,
}
{
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
glossaryGuid:
{
Description: The GUID of the glossary. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
}
,
antonyms:
{
Description: An array of related term headers as antonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the AtlasGlossaryTerm ,
Enum:
{
Draft: draft ,
Approved: approved ,
Alert: alert ,
Expired: expired ,
}
,
Required: False ,
}
enum ,
nickName:
{
Description: The nick name of the term. ,
Required: False ,
}
string ,
hierarchyInfo:
{
Description: The hierarchy information of the term. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
name:
{
Description: Name ,
Required: False ,
}
string ,
displayText:
{
Description: Display text ,
Required: False ,
}
string ,
itemPath:
{
Description: Item path ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
properties:
{
Description: Dictionary of ,
Required: False ,
}
object ,
}
,
]
,
resources:
{
Description: An array of resource link for term ,
Required: False ,
}
[
{
displayName:
{
Description: Display name for url. ,
Required: False ,
}
string ,
url:
{
Description: web url. http or https ,
Required: False ,
}
string ,
}
,
]
,
contacts:
{
Description: The dictionary of contacts for terms. Key could be Expert or Steward. ,
Required: False ,
}
object ,
attributes:
{
Description: The custom attributes of the term, which is map>. The key of the first layer map is term template name. ,
Required: False ,
}
object ,
assignedEntities:
{
Description: An array of related object IDs. ,
Required: False ,
}
[
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
]
,
categories:
{
Description: An array of term categorization headers. ,
Required: False ,
}
[
{
categoryGuid:
{
Description: The GUID of the category. ,
Format: uuid ,
Required: False ,
}
string ,
description:
{
Description: The description of the record. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
}
,
]
,
classifies:
{
Description: An array of related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
examples:
{
Description: An array of examples. ,
Required: False ,
}
[
string ,
]
,
isA:
{
Description: An array of related term headers indicating the is-a relationship. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredTerms:
{
Description: An array of preferred related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
preferredToTerms:
{
Description: An array of related term headers that are preferred to. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacedBy:
{
Description: An array of related term headers that are replaced by. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
replacementTerms:
{
Description: An array of related term headers for replacement. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
seeAlso:
{
Description: An array of related term headers for see also. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
synonyms:
{
Description: An array of related term headers as synonyms. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translatedTerms:
{
Description: An array of translated related term headers. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
translationTerms:
{
Description: An array of related term headers for translation. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
usage:
{
Description: The usage of the term. ,
Required: False ,
}
string ,
validValues:
{
Description: An array of related term headers as valid values. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
validValuesFor:
{
Description: An array of related term headers as valid values for other records. ,
Required: False ,
}
[
{
description:
{
Description: The description of the related term. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
status:
{
Description: The status of term relationship. ,
Enum:
{
DRAFT: draft ,
ACTIVE: active ,
DEPRECATED: deprecated ,
OBSOLETE: obsolete ,
OTHER: other ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListEntitiesAssignedWithTerm (removed)
Description :  List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/terms/{termId}/assignedEntities
{
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_AssignTermToEntities (removed)
Description :  Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. [Entities Create Or Update operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) is an alternative to assign a term to multiple entities.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/glossary/terms/{termId}/assignedEntities
{
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
body:
{
Description: An array of related object IDs to which the term has to be associated. ,
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_DeleteTermAssignmentFromEntities (removed)
Description :  Delete the term assignment for the given list of related objects.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/glossary/terms/{termId}/assignedEntities
{
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
body:
{
Description: An array of related object IDs from which the term has to be dissociated. ,
Required: True ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
relationshipType:
{
Description: Relationship type ,
Required: False ,
}
string ,
relationshipAttributes:
{
Description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
}
,
relationshipGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
relationshipStatus:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Glossary_ListRelatedTerms (removed)
Description :  Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/glossary/terms/{termId}/related
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
termId:
{
Description: The globally unique identifier for glossary term. ,
Required: True ,
}
string ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
sort:
{
Description: The sort order, ASC (default) or DESC. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Lineage_Get (removed)
Description :  Get lineage info of the entity specified by GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/lineage/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
depth:
{
Description: The number of hops for lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
direction:
{
Description: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
baseEntityGuid:
{
Description: The GUID of the base entity. ,
Required: False ,
}
string ,
guidEntityMap:
{
Description: The GUID entity map. ,
Required: False ,
}
object ,
widthCounts:
{
Description: The entity count in specific direction. ,
Required: False ,
}
object ,
lineageDepth:
{
Description: The depth of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageWidth:
{
Description: The width of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
childrenCount:
{
Description: The number of children node. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageDirection:
{
Description: The enum of lineage direction. ,
Enum:
{
INPUT: input ,
OUTPUT: output ,
BOTH: both ,
}
,
Required: False ,
}
enum ,
parentRelations:
{
Description: An array of parentRelations relations. ,
Required: False ,
}
[
{
childEntityId:
{
Description: The GUID of child entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
parentEntityId:
{
Description: The GUID of parent entity. ,
Required: False ,
}
string ,
}
,
]
,
relations:
{
Description: An array of lineage relations. ,
Required: False ,
}
[
{
fromEntityId:
{
Description: The GUID of from-entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
toEntityId:
{
Description: The GUID of to-entity. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Lineage_GetByUniqueAttribute (removed)
Description :  Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:[attrName]=[attrValue] NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/lineage/uniqueAttribute/type/{typeName}
{
typeName:
{
Description: The name of the type. ,
Required: True ,
}
string ,
depth:
{
Description: The number of hops for lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
direction:
{
Description: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. ,
Required: True ,
}
string ,
attr:qualifiedName:
{
Description: The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
baseEntityGuid:
{
Description: The GUID of the base entity. ,
Required: False ,
}
string ,
guidEntityMap:
{
Description: The GUID entity map. ,
Required: False ,
}
object ,
widthCounts:
{
Description: The entity count in specific direction. ,
Required: False ,
}
object ,
lineageDepth:
{
Description: The depth of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageWidth:
{
Description: The width of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
childrenCount:
{
Description: The number of children node. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageDirection:
{
Description: The enum of lineage direction. ,
Enum:
{
INPUT: input ,
OUTPUT: output ,
BOTH: both ,
}
,
Required: False ,
}
enum ,
parentRelations:
{
Description: An array of parentRelations relations. ,
Required: False ,
}
[
{
childEntityId:
{
Description: The GUID of child entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
parentEntityId:
{
Description: The GUID of parent entity. ,
Required: False ,
}
string ,
}
,
]
,
relations:
{
Description: An array of lineage relations. ,
Required: False ,
}
[
{
fromEntityId:
{
Description: The GUID of from-entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
toEntityId:
{
Description: The GUID of to-entity. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Update (removed)
Description :  Update an existing relationship between entities.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/relationship
{
body:
{
Required: True ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
end1:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
end2:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
guid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the relationship. ,
Required: False ,
}
string ,
label:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the relationship. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
end1:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
end2:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
guid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the relationship. ,
Required: False ,
}
string ,
label:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the relationship. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Create (removed)
Description :  Create a new relationship between entities.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/relationship
{
body:
{
Required: True ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
end1:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
end2:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
guid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the relationship. ,
Required: False ,
}
string ,
label:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the relationship. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
end1:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
end2:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
guid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the relationship. ,
Required: False ,
}
string ,
label:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the relationship. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Get (removed)
Description :  Get relationship information between entities by its GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/relationship/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the relationship. ,
Required: True ,
}
string ,
extendedInfo:
{
Description: Limits whether includes extended information. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
referredEntities:
{
Description: The referred entity header. ,
Required: False ,
}
object ,
relationship:
{
Description: Atlas relationship instance. ,
Required: False ,
}
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
end1:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
end2:
{
Description: Reference to an object-instance of a type - like entity. ,
Required: False ,
}
{
guid:
{
Description: The GUID of the object. ,
Required: False ,
}
string ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
uniqueAttributes:
{
Description: The unique attributes of the object. ,
Required: False ,
}
object ,
}
,
guid:
{
Description: The GUID of the relationship. ,
Required: False ,
}
string ,
homeId:
{
Description: The home ID of the relationship. ,
Required: False ,
}
string ,
label:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
provenanceType:
{
Description: Used to record the provenance of an instance of an entity or relationship ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The enum of relationship status. ,
Enum:
{
ACTIVE: active ,
DELETED: deleted ,
}
,
Required: False ,
}
enum ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the relationship. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Relationship_Delete (removed)
Description :  Delete a relationship between entities by its GUID.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/relationship/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the relationship. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetBusinessMetadataDefByGuid (removed)
Description :  Get the businessMetadata definition for the given guid.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/businessmetadatadef/guid/{guid}
{
guid:
{
Description: businessMetadata guid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetBusinessMetadataDefByName (removed)
Description :  Get the businessMetadata definition by it's name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/businessmetadatadef/name/{name}
{
name:
{
Description: businessMetadata name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetClassificationDefByGuid (removed)
Description :  Get the classification definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/classificationdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetClassificationDefByName (removed)
Description :  Get the classification definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/classificationdef/name/{name}
{
name:
{
Description: The name of the classification. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetEntityDefByGuid (removed)
Description :  Get the Entity definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/entitydef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetEntityDefByName (removed)
Description :  Get the entity definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/entitydef/name/{name}
{
name:
{
Description: The name of the entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetEnumDefByGuid (removed)
Description :  Get the enum definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/enumdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the enum. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetEnumDefByName (removed)
Description :  Get the enum definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/enumdef/name/{name}
{
name:
{
Description: The name of the enum. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetRelationshipDefByGuid (removed)
Description :  Get the relationship definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/relationshipdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the relationship. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetRelationshipDefByName (removed)
Description :  Get the relationship definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/relationshipdef/name/{name}
{
name:
{
Description: The name of the relationship. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetStructDefByGuid (removed)
Description :  Get the struct definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/structdef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the struct. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetStructDefByName (removed)
Description :  Get the struct definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/structdef/name/{name}
{
name:
{
Description: The name of the struct. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetByGuid (removed)
Description :  Get the type definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedef/guid/{guid}
{
guid:
{
Description: The globally unique identifier of the type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetByName (removed)
Description :  Get the type definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedef/name/{name}
{
name:
{
Description: The name of the type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_Delete (removed)
Description :  Delete API for type identified by its name.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/types/typedef/name/{name}
{
name:
{
Description: The name of the type. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_List (removed)
Description :  List all type definitions in bulk.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedefs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
includeTermTemplate:
{
Description: Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template ,
Required: False ,
}
boolean ,
type:
{
Description: Typedef name as search filter when get typedefs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_BulkUpdate (removed)
Description :  Update all types in bulk, changes detected in the type definitions would be persisted.
Reference :  Link ¶

⚼ Request

PUT:  /atlas/v2/types/typedefs
{
body:
{
Required: True ,
}
{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_BulkCreate (removed)
Description :  Create all atlas type definitions in bulk. Please avoid recreating existing types.
Reference :  Link ¶

⚼ Request

POST:  /atlas/v2/types/typedefs
{
body:
{
Required: True ,
}
{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_BulkDelete (removed)
Description :  Delete API for all types in bulk.
Reference :  Link ¶

⚼ Request

DELETE:  /atlas/v2/types/typedefs
{
body:
{
Required: True ,
}
{
businessMetadataDefs:
{
Description: businessMetadataDefs ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
classificationDefs:
{
Description: An array of classification definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
entityTypes:
{
Description: Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. Any subtypes of the entity types inherit the restriction. Any classificationDef subtypes inherit the parents entityTypes restrictions. Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes. An empty entityTypes list when there are no parent restrictions means there are no restrictions. An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions. If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs. ,
Required: False ,
}
[
string ,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
entityDefs:
{
Description: An array of entity definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
subTypes:
{
Description: An array of sub types. ,
Required: False ,
}
[
string ,
]
,
superTypes:
{
Description: An array of super types. ,
Required: False ,
}
[
string ,
]
,
relationshipAttributeDefs:
{
Description: An array of relationship attributes. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
relationshipTypeName:
{
Description: The name of the relationship type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
enumDefs:
{
Description: An array of enum definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
defaultValue:
{
Description: The default value. ,
Required: False ,
}
string ,
elementDefs:
{
Description: An array of enum element definitions. ,
Required: False ,
}
[
{
description:
{
Description: The description of the enum element definition. ,
Required: False ,
}
string ,
ordinal:
{
Description: The ordinal of the enum element definition. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The value of the enum element definition. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
relationshipDefs:
{
Description: An array of relationship definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
endDef1:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
endDef2:
{
Description: 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. ,
Required: False ,
}
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description of the relationship end definition. ,
Required: False ,
}
string ,
isContainer:
{
Description: Determines if it is container. ,
Required: False ,
}
boolean ,
isLegacyAttribute:
{
Description: Determines if it is a legacy attribute. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the relationship end definition. ,
Required: False ,
}
string ,
type:
{
Description: The type of the relationship end. ,
Required: False ,
}
string ,
}
,
relationshipCategory:
{
Description: The Relationship category determines the style of relationship around containment and lifecycle. UML terminology is used for the values. ASSOCIATION is a relationship with no containment. COMPOSITION and AGGREGATION are containment relationships. The difference being in the lifecycles of the container and its children. In the COMPOSITION case, the children cannot exist without the container. For AGGREGATION, the life cycles of the container and children are totally independent. ,
Enum:
{
ASSOCIATION: association ,
AGGREGATION: aggregation ,
COMPOSITION: composition ,
}
,
Required: False ,
}
enum ,
relationshipLabel:
{
Description: The label of the relationship. ,
Required: False ,
}
string ,
}
,
]
,
structDefs:
{
Description: An array of struct definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
termTemplateDefs:
{
Description: An array of term template definitions. ,
Required: False ,
}
[
{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_ListHeaders (removed)
Description :  List all type definitions returned as a list of minimal information header.
Reference :  Link ¶

⚼ Request

GET:  /atlas/v2/types/typedefs/headers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: False ,
}
string ,
includeTermTemplate:
{
Description: Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template ,
Required: False ,
}
boolean ,
type:
{
Description: Typedef name as search filter when get typedefs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Entity_MoveEntitiesToCollection (removed)
Description :  Move existing entities to the target collection.
Reference :  Link ¶

⚼ Request

POST:  /entity/moveTo
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection where entities will be moved to. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
entityGuids:
{
Description: An array of entity guids to be moved to target collection. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
guidAssignments:
{
Description: A map of GUID assignments with entities. ,
Required: False ,
}
object ,
mutatedEntities:
{
Description: The entity headers of mutated entities. ,
Required: False ,
}
object ,
partialUpdatedEntities:
{
Description: An array of entity headers that partially updated. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
classificationNames:
{
Description: An array of classification names. ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: An array of classifications. ,
Required: False ,
}
[
{
attributes:
{
Description: The attributes of the struct. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
entityGuid:
{
Description: The GUID of the entity. ,
Required: False ,
}
string ,
entityStatus:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
removePropagationsOnEntityDelete:
{
Description: Determines if propagations will be removed on entity deletion. ,
Required: False ,
}
boolean ,
validityPeriods:
{
Description: An array of time boundaries indicating validity periods. ,
Required: False ,
}
[
{
endTime:
{
Description: The end of the time boundary. ,
Required: False ,
}
string ,
startTime:
{
Description: The start of the time boundary. ,
Required: False ,
}
string ,
timeZone:
{
Description: The timezone of the time boundary. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
isIncomplete:
{
Description: Whether it is a shell entity ,
Required: False ,
}
boolean ,
labels:
{
Description: labels ,
Required: False ,
}
[
string ,
]
,
meaningNames:
{
Description: An array of meanings. ,
Required: False ,
}
[
string ,
]
,
meanings:
{
Description: An array of term assignment headers. ,
Required: False ,
}
[
{
confidence:
{
Description: The confidence of the term assignment. ,
Format: int32 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
description:
{
Description: The description of the term assignment. ,
Required: False ,
}
string ,
displayText:
{
Description: The display text. ,
Required: False ,
}
string ,
expression:
{
Description: The expression of the term assignment. ,
Required: False ,
}
string ,
relationGuid:
{
Description: The GUID of the relationship. ,
Format: uuid ,
Required: False ,
}
string ,
status:
{
Description: The status of terms assignment. ,
Enum:
{
DISCOVERED: The status is discovered. ,
PROPOSED: The status is proposed. ,
IMPORTED: The status is imported. ,
VALIDATED: The status is validated. ,
DEPRECATED: The status is deprecated. ,
OBSOLETE: The status is obsolete. ,
OTHER: Other status. ,
}
,
Required: False ,
}
enum ,
steward:
{
Description: The steward of the term. ,
Required: False ,
}
string ,
termGuid:
{
Description: The GUID of the term. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Status of the entity - can be active or deleted. Deleted entities are not removed. ,
Enum:
{
ACTIVE: The status is active. ,
DELETED: The status is deleted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Lineage_GetNextPage (removed)
Description :  Return immediate next page lineage info about entity with pagination
Reference :  Link ¶

⚼ Request

GET:  /lineage/{guid}/next
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
guid:
{
Description: The globally unique identifier of the entity. ,
Required: True ,
}
string ,
direction:
{
Description: The direction of the lineage, which could be INPUT, OUTPUT or BOTH. ,
Required: True ,
}
string ,
offset:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The page size - by default there is no paging. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
baseEntityGuid:
{
Description: The GUID of the base entity. ,
Required: False ,
}
string ,
guidEntityMap:
{
Description: The GUID entity map. ,
Required: False ,
}
object ,
widthCounts:
{
Description: The entity count in specific direction. ,
Required: False ,
}
object ,
lineageDepth:
{
Description: The depth of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageWidth:
{
Description: The width of lineage. ,
Format: int32 ,
Required: False ,
}
integer ,
childrenCount:
{
Description: The number of children node. ,
Format: int32 ,
Required: False ,
}
integer ,
lineageDirection:
{
Description: The enum of lineage direction. ,
Enum:
{
INPUT: input ,
OUTPUT: output ,
BOTH: both ,
}
,
Required: False ,
}
enum ,
parentRelations:
{
Description: An array of parentRelations relations. ,
Required: False ,
}
[
{
childEntityId:
{
Description: The GUID of child entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
parentEntityId:
{
Description: The GUID of parent entity. ,
Required: False ,
}
string ,
}
,
]
,
relations:
{
Description: An array of lineage relations. ,
Required: False ,
}
[
{
fromEntityId:
{
Description: The GUID of from-entity. ,
Required: False ,
}
string ,
relationshipId:
{
Description: The GUID of relationship. ,
Required: False ,
}
string ,
toEntityId:
{
Description: The GUID of to-entity. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_AutoComplete (removed)
Description :  Get auto complete options.
Reference :  Link ¶

⚼ Request

POST:  /search/autocomplete
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. ,
Required: False ,
}
string ,
limit:
{
Description: The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter for the autocomplete request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The result value ,
Required: False ,
}
[
{
text:
{
Description: The completed term or phrase. ,
Required: False ,
}
string ,
queryPlusText:
{
Description: The completed search query text. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_Query (removed)
Description :  Get data using search.
Reference :  Link ¶

⚼ Request

POST:  /search/query
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all searchable fields. ,
Required: False ,
}
string ,
limit:
{
Description: The limit of the number of the search result. default value is 50; maximum value is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data. ,
Required: False ,
}
string ,
orderby:
{
Description: The sort order of search results, can specify multiple fields. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The filter for the search. See examples for the usage of supported filters. ,
Required: False ,
}
string ,
facets:
{
Description: The facets for search. See examples for the usage of supported facets. ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
facet:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
sort:
{
Description: Define the sorting criteria for items ,
Required: False ,
}
{
count:
{
Description: Order by count ,
Enum:
{
asc: Use ascending order for sorting ,
desc: Use descending order for sorting ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Order by value ,
Enum:
{
asc: Use ascending order for sorting ,
desc: Use descending order for sorting ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
taxonomySetting:
{
Description: The taxonomy setting for search. ,
Required: False ,
}
{
assetTypes:
{
Description: Asset types ,
Required: False ,
}
[
string ,
]
,
facet:
{
Description: The content of a search facet result item. ,
Required: False ,
}
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
facet:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
sort:
{
Description: Define the sorting criteria for items ,
Required: False ,
}
{
count:
{
Description: Order by count ,
Enum:
{
asc: Use ascending order for sorting ,
desc: Use descending order for sorting ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Order by value ,
Enum:
{
asc: Use ascending order for sorting ,
desc: Use descending order for sorting ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
@search.count:
{
Description: The total number of search results (not the number of documents in a single page). ,
Format: int32 ,
Required: False ,
}
integer ,
@search.count.approximate:
{
Description: 'True' if the '@search.count' is an approximate value and vise versa. ,
Required: False ,
}
boolean ,
continuationToken:
{
Description: The token used to get next batch of data. Absent if there's no more data. ,
Required: False ,
}
string ,
@search.facets:
{
Description: A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets. ,
Required: False ,
}
{
entityType:
{
Description: Entity type ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Description: Asset type ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
classification:
{
Description: Classification ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
term:
{
Description: Term ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
contactId:
{
Description: Contact id ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
contactType:
{
Description: Contact type ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
label:
{
Description: Label ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
glossaryType:
{
Description: Glossary type ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
termStatus:
{
Description: Term status ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
termTemplate:
{
Description: Term template ,
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
}
,
value:
{
Description: Search result value ,
Required: False ,
}
[
{
@search.score:
{
Description: The search score calculated by the search engine. The results are ordered by search score by default. ,
Format: float ,
Required: False ,
}
number ,
@search.highlights:
{
Description: A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights. ,
Required: False ,
}
{
id:
{
Description: Id ,
Required: False ,
}
[
string ,
]
,
qualifiedName:
{
Description: Qualified name ,
Required: False ,
}
[
string ,
]
,
name:
{
Description: Name ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description ,
Required: False ,
}
[
string ,
]
,
entityType:
{
Description: Entity type ,
Required: False ,
}
[
string ,
]
,
}
,
objectType:
{
Description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term. ,
Required: False ,
}
string ,
createTime:
{
Description: The create time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
updateTime:
{
Description: The last update time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the record. ,
Required: False ,
}
string ,
entityType:
{
Description: The type name of the asset. ,
Required: False ,
}
string ,
description:
{
Description: The description of the asset. ,
Required: False ,
}
string ,
endorsement:
{
Description: The endorsement of the asset. ,
Required: False ,
}
[
string ,
]
,
owner:
{
Description: The owner of the record. ,
Required: False ,
}
string ,
classification:
{
Description: The classifications of the record. ,
Required: False ,
}
[
string ,
]
,
label:
{
Description: The labels of the asset. ,
Required: False ,
}
[
string ,
]
,
term:
{
Description: The terms assigned to the asset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the term. ,
Required: False ,
}
string ,
glossaryName:
{
Description: The name of the glossary which contains the term. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
contact:
{
Description: The contacts of the asset. ,
Required: False ,
}
[
{
id:
{
Description: The GUID of the contact. ,
Required: False ,
}
string ,
info:
{
Description: The description of the contact. ,
Required: False ,
}
string ,
contactType:
{
Description: The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Description: The asset types of the asset. ,
Required: False ,
}
[
string ,
]
,
glossaryType:
{
Description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. ,
Required: False ,
}
string ,
glossary:
{
Description: The glossary name of the term. ,
Required: False ,
}
string ,
termStatus:
{
Description: The status of the term. ,
Required: False ,
}
string ,
termTemplate:
{
Description: The term template names used by the term. ,
Required: False ,
}
[
string ,
]
,
longDescription:
{
Description: The definition of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_Suggest (removed)
Description :  Get search suggestions by query criteria.
Reference :  Link ¶

⚼ Request

POST:  /search/suggest
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode. ,
Required: False ,
}
string ,
limit:
{
Description: The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter for the search. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The result value ,
Required: False ,
}
[
{
@search.score:
{
Description: The search score calculated by the search engine. The results are ordered by search score by default. ,
Format: float ,
Required: False ,
}
number ,
@search.text:
{
Description: The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark. ,
Required: False ,
}
string ,
objectType:
{
Description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term. ,
Required: False ,
}
string ,
createTime:
{
Description: The create time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
updateTime:
{
Description: The last update time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the record. ,
Required: False ,
}
string ,
entityType:
{
Description: The type name of the asset. ,
Required: False ,
}
string ,
description:
{
Description: The description of the asset. ,
Required: False ,
}
string ,
endorsement:
{
Description: The endorsement of the asset. ,
Required: False ,
}
[
string ,
]
,
owner:
{
Description: The owner of the record. ,
Required: False ,
}
string ,
classification:
{
Description: The classifications of the record. ,
Required: False ,
}
[
string ,
]
,
label:
{
Description: The labels of the asset. ,
Required: False ,
}
[
string ,
]
,
term:
{
Description: The terms assigned to the asset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the term. ,
Required: False ,
}
string ,
glossaryName:
{
Description: The name of the glossary which contains the term. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
contact:
{
Description: The contacts of the asset. ,
Required: False ,
}
[
{
id:
{
Description: The GUID of the contact. ,
Required: False ,
}
string ,
info:
{
Description: The description of the contact. ,
Required: False ,
}
string ,
contactType:
{
Description: The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Description: The asset types of the asset. ,
Required: False ,
}
[
string ,
]
,
glossaryType:
{
Description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. ,
Required: False ,
}
string ,
glossary:
{
Description: The glossary name of the term. ,
Required: False ,
}
string ,
termStatus:
{
Description: The status of the term. ,
Required: False ,
}
string ,
termTemplate:
{
Description: The term template names used by the term. ,
Required: False ,
}
[
string ,
]
,
longDescription:
{
Description: The definition of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_Navigation (removed)
Description :  Navigate entities by itemPath.
Reference :  Link ¶

⚼ Request

POST:  /navigate
{
NavigationRequest:
{
Description: An object specifying the navigation criteria. ,
Required: True ,
}
{
navigationMode:
{
Description: The navigation mode. ,
Enum:
{
assetType: No description available. ,
azureResourceHierarchy: No description available. ,
}
,
Required: False ,
}
enum ,
itemPath:
{
Description: The identifier of navigation request. ,
Required: True ,
}
{
path:
{
Description: The identifier of the item. The path starts with an empty string or a single slash. To navigate further, you need to concatenate with a slash to form the full itemPath using the previous navigation response's relative item path. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: The extended properties of the itemPath are typically obtained from the last navigation response. While not mandatory to provide, including them can enhance performance. Otherwise, there may be some impact on performance. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Additional properties of the item. ,
Required: False ,
}
object ,
includeNextLevelAssetCount:
{
Description: Whether to return the next level asset count. ,
Required: False ,
}
boolean ,
}
,
maxpagesize:
{
Description: The page size - by default the value is 100. The maximum is 10000. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: To achieve paginated results, invoke the API with the next continuationToken received from Navigation Result to retrieve subsequent pages. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
items:
{
Required: True ,
}
[
{
name:
{
Description: The name of the item. ,
Required: True ,
}
string ,
type:
{
Description: The type name of the item. Eg. EntityType. ,
Required: True ,
}
string ,
isLeafNode:
{
Description: Indicates whether the item is a leaf node. If it is, further navigation is not possible. ,
Required: True ,
}
boolean ,
isEntity:
{
Description: Whether the item is Entity. If yes, can get complete definition of an entity given its itemPath ,
Required: True ,
}
boolean ,
itemPath:
{
Description: The identifier of navigation request. ,
Required: True ,
}
{
path:
{
Description: The identifier of the item. The path starts with an empty string or a single slash. To navigate further, you need to concatenate with a slash to form the full itemPath using the previous navigation response's relative item path. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: The extended properties of the itemPath are typically obtained from the last navigation response. While not mandatory to provide, including them can enhance performance. Otherwise, there may be some impact on performance. ,
Required: False ,
}
object ,
}
,
count:
{
Description: The count of the top level asset. Won't return if request payload 'includeNextLevelAssetCount' is false. ,
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The additional properties of the navigation element. ,
Required: True ,
}
object ,
}
,
]
,
continuationToken:
{
Description: The token used to get next batch of data. Absent if there's no more data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: An error response from the service ,
}
{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Type_GetTermTemplateDefByGuid (removed)
Description :  Get the term template definition for the given GUID.
Reference :  Link ¶

⚼ Request

GET:  /types/termtemplatedef/guid/{guid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
guid:
{
Description: The globally unique identifier of the term template. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Type_GetTermTemplateDefByName (removed)
Description :  Get the term template definition by its name (unique).
Reference :  Link ¶

⚼ Request

GET:  /types/termtemplatedef/name/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The unique name of the term template. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The enum of type category. ,
Enum:
{
PRIMITIVE: primitive ,
OBJECT_ID_TYPE: object id type ,
ENUM: enum ,
STRUCT: struct ,
CLASSIFICATION: classification ,
ENTITY: entity ,
ARRAY: array ,
MAP: map ,
RELATIONSHIP: relationship ,
TERM_TEMPLATE: term template ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The created time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
createdBy:
{
Description: The user who created the record. ,
Required: False ,
}
string ,
dateFormatter:
{
Description: The date format. ,
Required: False ,
}
{
availableLocales:
{
Description: An array of available locales. ,
Required: False ,
}
[
string ,
]
,
calendar:
{
Description: Calendar ,
Format: float ,
Required: False ,
}
number ,
dateInstance:
{
Required: False ,
}
string ,
dateTimeInstance:
{
Required: False ,
}
string ,
instance:
{
Required: False ,
}
string ,
lenient:
{
Description: Determines the leniency of the date format. ,
Required: False ,
}
boolean ,
numberFormat:
{
Description: The number format. ,
Required: False ,
}
{
availableLocales:
{
Description: The number format. ,
Required: False ,
}
[
string ,
]
,
currency:
{
Description: The currency. ,
Required: False ,
}
string ,
currencyInstance:
{
Required: False ,
}
string ,
groupingUsed:
{
Description: Determines if grouping is used. ,
Required: False ,
}
boolean ,
instance:
{
Required: False ,
}
string ,
integerInstance:
{
Required: False ,
}
string ,
maximumFractionDigits:
{
Description: The maximum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumIntegerDigits:
{
Description: The maximum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumFractionDigits:
{
Description: The minimum of fraction digits. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumIntegerDigits:
{
Description: The minimum of integer digits. ,
Format: int32 ,
Required: False ,
}
integer ,
numberInstance:
{
Required: False ,
}
string ,
parseIntegerOnly:
{
Description: Determines if only integer is parsed. ,
Required: False ,
}
boolean ,
percentInstance:
{
Required: False ,
}
string ,
roundingMode:
{
Description: The enum of rounding mode. ,
Enum:
{
UP: up ,
DOWN: down ,
CEILING: ceiling ,
FLOOR: floor ,
HALF_UP: half up ,
HALF_DOWN: half down ,
HALF_EVEN: half even ,
UNNECESSARY: unnecessary ,
}
,
Required: False ,
}
enum ,
}
,
timeInstance:
{
Required: False ,
}
string ,
timeZone:
{
Description: The timezone information. ,
Required: False ,
}
{
dstSavings:
{
Description: The value of the daylight saving time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: The ID of the timezone. ,
Required: False ,
}
string ,
availableIds:
{
Description: An array of available IDs. ,
Required: False ,
}
[
string ,
]
,
default:
{
Required: False ,
}
string ,
displayName:
{
Description: The display name of the timezone. ,
Required: False ,
}
string ,
rawOffset:
{
Description: The raw offset of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
description:
{
Description: The description of the type definition. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the type definition. ,
Required: False ,
}
string ,
name:
{
Description: The name of the type definition. ,
Required: False ,
}
string ,
options:
{
Description: The options for the type definition. ,
Required: False ,
}
object ,
serviceType:
{
Description: The service type. ,
Required: False ,
}
string ,
typeVersion:
{
Description: The version of the type. ,
Required: False ,
}
string ,
updateTime:
{
Description: The update time of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
updatedBy:
{
Description: The user who updated the record. ,
Required: False ,
}
string ,
version:
{
Description: The version of the record. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedTS:
{
Description: ETag for concurrency control. ,
Required: False ,
}
string ,
attributeDefs:
{
Description: An array of attribute definitions. ,
Required: False ,
}
[
{
cardinality:
{
Description: single-valued attribute or multi-valued attribute. ,
Enum:
{
SINGLE: single ,
LIST: list ,
SET: set ,
}
,
Required: False ,
}
enum ,
constraints:
{
Description: An array of constraints. ,
Required: False ,
}
[
{
params:
{
Description: The parameters of the constraint definition. ,
Required: False ,
}
object ,
type:
{
Description: The type of the constraint. ,
Required: False ,
}
string ,
}
,
]
,
defaultValue:
{
Description: The default value of the attribute. ,
Required: False ,
}
string ,
description:
{
Description: The description of the attribute. ,
Required: False ,
}
string ,
includeInNotification:
{
Description: Determines if it is included in notification. ,
Required: False ,
}
boolean ,
isIndexable:
{
Description: Determines if it is indexable. ,
Required: False ,
}
boolean ,
isOptional:
{
Description: Determines if it is optional. ,
Required: False ,
}
boolean ,
isUnique:
{
Description: Determines if it unique. ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the attribute. ,
Required: False ,
}
string ,
options:
{
Description: The options for the attribute. ,
Required: False ,
}
object ,
typeName:
{
Description: The name of the type. ,
Required: False ,
}
string ,
valuesMaxCount:
{
Description: The maximum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
valuesMinCount:
{
Description: The minimum count of the values. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Format: uuid ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}