public final class TypesBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
DynamicRequest |
createTypeDefinitions()
Create all atlas type definitions in bulk, only new definitions will be created.
|
DynamicRequest |
deleteTypeByName(String name)
Delete API for type identified by its name.
|
DynamicRequest |
deleteTypeDefinitions()
Delete API for all types in bulk.
|
DynamicRequest |
getAllTypeDefinitions()
Get all type definitions in Atlas in bulk.
|
DynamicRequest |
getClassificationDefByGuid(String guid)
Get the classification definition for the given GUID.
|
DynamicRequest |
getClassificationDefByName(String name)
Get the classification definition by its name (unique).
|
DynamicRequest |
getEntityDefinitionByGuid(String guid)
Get the Entity definition for the given GUID.
|
DynamicRequest |
getEntityDefinitionByName(String name)
Get the entity definition by its name (unique).
|
DynamicRequest |
getEnumDefByGuid(String guid)
Get the enum definition for the given GUID.
|
DynamicRequest |
getEnumDefByName(String name)
Get the enum definition by its name (unique).
|
DynamicRequest |
getRelationshipDefByGuid(String guid)
Get the relationship definition for the given GUID.
|
DynamicRequest |
getRelationshipDefByName(String name)
Get the relationship definition by its name (unique).
|
DynamicRequest |
getStructDefByGuid(String guid)
Get the struct definition for the given GUID.
|
DynamicRequest |
getStructDefByName(String name)
Get the struct definition by its name (unique).
|
DynamicRequest |
getTermTemplateDefByGuid(String guid)
Get the term template definition for the given GUID.
|
DynamicRequest |
getTermTemplateDefByName(String name)
Get the term template definition by its name (unique).
|
DynamicRequest |
getTypeDefinitionByGuid(String guid)
Get the type definition for the given GUID.
|
DynamicRequest |
getTypeDefinitionByName(String name)
Get the type definition by its name (unique).
|
DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
DynamicRequest |
listTypeDefinitionHeaders()
List all type definitions returned as a list of minimal information header.
|
DynamicRequest |
updateAtlasTypeDefinitions()
Update all types in bulk, changes detected in the type definitions would be persisted.
|
public DynamicRequest getClassificationDefByGuid(String guid)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
}
guid
- The globally unique identifier of the classification.public DynamicRequest getClassificationDefByName(String name)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
}
name
- The name of the classification.public DynamicRequest getEntityDefinitionByGuid(String guid)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
}
guid
- The globally unique identifier of the entity.public DynamicRequest getEntityDefinitionByName(String name)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
}
name
- The name of the entity.public DynamicRequest getEnumDefByGuid(String guid)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
}
guid
- The globally unique identifier of the enum.public DynamicRequest getEnumDefByName(String name)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
}
name
- The name of the enum.public DynamicRequest getRelationshipDefByGuid(String guid)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
}
guid
- The globally unique identifier of the relationship.public DynamicRequest getRelationshipDefByName(String name)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
}
name
- The name of the relationship.public DynamicRequest getStructDefByGuid(String guid)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
}
guid
- The globally unique identifier of the struct.public DynamicRequest getStructDefByName(String name)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
}
name
- The name of the struct.public DynamicRequest getTypeDefinitionByGuid(String guid)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
}
guid
- The globally unique identifier of the type.public DynamicRequest getTypeDefinitionByName(String name)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
}
name
- The name of the type.public DynamicRequest deleteTypeByName(String name)
name
- The name of the type.public DynamicRequest getAllTypeDefinitions()
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermTemplate | Boolean | Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template |
type | Type | Typedef name as search filter when get typedefs. |
Response Body Schema
{
classificationDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
}
]
entityDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
}
]
enumDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
}
]
relationshipDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
}
]
structDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
termTemplateDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
}
public DynamicRequest createTypeDefinitions()
Request Body Schema
{
classificationDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
}
]
entityDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
}
]
enumDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
}
]
relationshipDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
}
]
structDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
termTemplateDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
}
Response Body Schema
(recursive schema, see above)
public DynamicRequest updateAtlasTypeDefinitions()
Request Body Schema
{
classificationDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
}
]
entityDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
}
]
enumDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
}
]
relationshipDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
}
]
structDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
termTemplateDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
}
Response Body Schema
(recursive schema, see above)
public DynamicRequest deleteTypeDefinitions()
Request Body Schema
{
classificationDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
entityTypes: [
String
]
subTypes: [
String
]
superTypes: [
String
]
}
]
entityDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
subTypes: [
String
]
superTypes: [
String
]
relationshipAttributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
(recursive schema, see above)
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
isLegacyAttribute: Boolean
relationshipTypeName: String
}
]
}
]
enumDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
defaultValue: String
elementDefs: [
{
description: String
ordinal: Float
value: String
}
]
}
]
relationshipDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
endDef1: {
cardinality: String(SINGLE/LIST/SET)
description: String
isContainer: Boolean
isLegacyAttribute: Boolean
name: String
type: String
}
endDef2: (recursive schema, see endDef2 above)
relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
relationshipLabel: String
}
]
structDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
termTemplateDefs: [
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: (recursive schema, see dateFormatter above)
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
(recursive schema, see above)
]
}
]
}
public DynamicRequest listTypeDefinitionHeaders()
Optional Query Parameters
Name | Type | Description |
---|---|---|
includeTermTemplate | Boolean | Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template |
type | Type | Typedef name as search filter when get typedefs. |
Response Body Schema
[
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
guid: String
name: String
}
]
public DynamicRequest getTermTemplateDefByGuid(String guid)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
}
guid
- The globally unique identifier of the term template.public DynamicRequest getTermTemplateDefByName(String name)
Response Body Schema
{
category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
createTime: Float
createdBy: String
dateFormatter: {
availableLocales: [
String
]
calendar: Float
dateInstance: (recursive schema, see dateInstance above)
dateTimeInstance: (recursive schema, see dateTimeInstance above)
instance: (recursive schema, see instance above)
lenient: Boolean
numberFormat: {
availableLocales: [
String
]
currency: String
currencyInstance: (recursive schema, see currencyInstance above)
groupingUsed: Boolean
instance: (recursive schema, see instance above)
integerInstance: (recursive schema, see integerInstance above)
maximumFractionDigits: Integer
maximumIntegerDigits: Integer
minimumFractionDigits: Integer
minimumIntegerDigits: Integer
numberInstance: (recursive schema, see numberInstance above)
parseIntegerOnly: Boolean
percentInstance: (recursive schema, see percentInstance above)
roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
}
timeInstance: (recursive schema, see timeInstance above)
timeZone: {
dstSavings: Integer
id: String
availableIds: [
String
]
defaultProperty: (recursive schema, see defaultProperty above)
displayName: String
rawOffset: Integer
}
}
description: String
guid: String
name: String
options: {
String: String
}
serviceType: String
typeVersion: String
updateTime: Float
updatedBy: String
version: Float
lastModifiedTS: String
attributeDefs: [
{
cardinality: String(SINGLE/LIST/SET)
constraints: [
{
params: {
String: Object
}
type: String
}
]
defaultValue: String
description: String
includeInNotification: Boolean
isIndexable: Boolean
isOptional: Boolean
isUnique: Boolean
name: String
options: {
String: String
}
typeName: String
valuesMaxCount: Integer
valuesMinCount: Integer
}
]
}
name
- The name of the term template.public DynamicRequest invoke()
Copyright © 2021. All rights reserved.