TypesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
types attribute.
- Inheritance
-
builtins.objectTypesOperations
Constructor
TypesOperations(*args, **kwargs)Methods
| create_type_definitions |
Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded. |
| delete_type_by_name |
Delete API for type identified by its name. |
| delete_type_definitions |
Delete API for all types in bulk. |
| get_all_type_definitions |
Get all type definitions in Atlas in bulk. |
| get_business_metadata_def_by_guid |
Get the businessMetadata definition for the given guid. |
| get_business_metadata_def_by_name |
Get the businessMetadata definition by it's name (unique). |
| get_classification_def_by_guid |
Get the classification definition for the given GUID. |
| get_classification_def_by_name |
Get the classification definition by its name (unique). |
| get_entity_definition_by_guid |
Get the Entity definition for the given GUID. |
| get_entity_definition_by_name |
Get the entity definition by its name (unique). |
| get_enum_def_by_guid |
Get the enum definition for the given GUID. |
| get_enum_def_by_name |
Get the enum definition by its name (unique). |
| get_relationship_def_by_guid |
Get the relationship definition for the given GUID. |
| get_relationship_def_by_name |
Get the relationship definition by its name (unique). |
| get_struct_def_by_guid |
Get the struct definition for the given GUID. |
| get_struct_def_by_name |
Get the struct definition by its name (unique). |
| get_term_template_def_by_guid |
Get the term template definition for the given GUID. |
| get_term_template_def_by_name |
Get the term template definition by its name (unique). |
| get_type_definition_by_guid |
Get the type definition for the given GUID. |
| get_type_definition_by_name |
Get the type definition by its name (unique). |
| list_type_definition_headers |
List all type definitions returned as a list of minimal information header. |
| update_atlas_type_definitions |
Update all types in bulk, changes detected in the type definitions would be persisted. |
create_type_definitions
Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.
create_type_definitions(types_def: collections.abc.MutableMapping[str, Any], **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
- types_def
- <xref:JSON>
Required
A composite wrapper object with corresponding lists of the type definition.
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# JSON input template you can fill out and use as your body input.
types_def = {
"businessMetadataDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"classificationDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType
names in the classificationDef, ensures that classifications
can"nonly be applied to those entityTypes."n"n"n.. raw:: html"n"n
<ul>"n <li>Any subtypes of the entity types inherit the
restriction</li>"n <li>Any classificationDef subtypes inherit the
parents entityTypes restrictions</li>"n <li>Any classificationDef
subtypes can further restrict the parents entityTypes restrictions by
specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there
are no restrictions</li>"n <li>An empty entityTypes list when there
are parent restrictions means that the subtype picks up the parents
restrictions</li>"n <li>If a list of entityTypes are supplied,
where one inherits from another, this will be rejected. This should
encourage cleaner classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"entityDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isLegacyAttribute": bool, # Optional.
Determines if it is a legacy attribute.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"relationshipTypeName": "str", # Optional.
The name of the relationship type.
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"enumDefs": [
{
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the
type definition.
"elementDefs": [
{
"description": "str", # Optional. The
description of the enum element definition.
"ordinal": 0.0, # Optional. The ordinal of
the enum element definition.
"value": "str" # Optional. The value of the
enum element definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"relationshipDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipCategory": "str", # Optional. The Relationship
category determines the style of relationship around containment and
lifecycle."nUML terminology is used for the
values."n"n:code:`<p>`"nASSOCIATION is a relationship with no
containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of
the container and its children. In the COMPOSITION case,"nthe children
cannot exist without the container. For AGGREGATION, the life cycles"nof
the container and children are totally independent. Known values are:
"ASSOCIATION", "AGGREGATION", "COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the
relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"structDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"termTemplateDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
]
}
# response body for status code(s): 200
response.json() == {
"businessMetadataDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"classificationDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType
names in the classificationDef, ensures that classifications
can"nonly be applied to those entityTypes."n"n"n.. raw:: html"n"n
<ul>"n <li>Any subtypes of the entity types inherit the
restriction</li>"n <li>Any classificationDef subtypes inherit the
parents entityTypes restrictions</li>"n <li>Any classificationDef
subtypes can further restrict the parents entityTypes restrictions by
specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there
are no restrictions</li>"n <li>An empty entityTypes list when there
are parent restrictions means that the subtype picks up the parents
restrictions</li>"n <li>If a list of entityTypes are supplied,
where one inherits from another, this will be rejected. This should
encourage cleaner classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"entityDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isLegacyAttribute": bool, # Optional.
Determines if it is a legacy attribute.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"relationshipTypeName": "str", # Optional.
The name of the relationship type.
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"enumDefs": [
{
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the
type definition.
"elementDefs": [
{
"description": "str", # Optional. The
description of the enum element definition.
"ordinal": 0.0, # Optional. The ordinal of
the enum element definition.
"value": "str" # Optional. The value of the
enum element definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"relationshipDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipCategory": "str", # Optional. The Relationship
category determines the style of relationship around containment and
lifecycle."nUML terminology is used for the
values."n"n:code:`<p>`"nASSOCIATION is a relationship with no
containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of
the container and its children. In the COMPOSITION case,"nthe children
cannot exist without the container. For AGGREGATION, the life cycles"nof
the container and children are totally independent. Known values are:
"ASSOCIATION", "AGGREGATION", "COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the
relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"structDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"termTemplateDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
]
}
delete_type_by_name
Delete API for type identified by its name.
delete_type_by_name(name: str, **kwargs: Any) -> NoneParameters
Returns
None
Return type
Exceptions
delete_type_definitions
Delete API for all types in bulk.
delete_type_definitions(types_def: collections.abc.MutableMapping[str, Any], **kwargs: Any) -> NoneParameters
- types_def
- <xref:JSON>
Required
A composite object that captures all types to be deleted.
Returns
None
Return type
Exceptions
Examples
# JSON input template you can fill out and use as your body input.
types_def = {
"businessMetadataDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"classificationDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType
names in the classificationDef, ensures that classifications
can"nonly be applied to those entityTypes."n"n"n.. raw:: html"n"n
<ul>"n <li>Any subtypes of the entity types inherit the
restriction</li>"n <li>Any classificationDef subtypes inherit the
parents entityTypes restrictions</li>"n <li>Any classificationDef
subtypes can further restrict the parents entityTypes restrictions by
specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there
are no restrictions</li>"n <li>An empty entityTypes list when there
are parent restrictions means that the subtype picks up the parents
restrictions</li>"n <li>If a list of entityTypes are supplied,
where one inherits from another, this will be rejected. This should
encourage cleaner classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"entityDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isLegacyAttribute": bool, # Optional.
Determines if it is a legacy attribute.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"relationshipTypeName": "str", # Optional.
The name of the relationship type.
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"enumDefs": [
{
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the
type definition.
"elementDefs": [
{
"description": "str", # Optional. The
description of the enum element definition.
"ordinal": 0.0, # Optional. The ordinal of
the enum element definition.
"value": "str" # Optional. The value of the
enum element definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"relationshipDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipCategory": "str", # Optional. The Relationship
category determines the style of relationship around containment and
lifecycle."nUML terminology is used for the
values."n"n:code:`<p>`"nASSOCIATION is a relationship with no
containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of
the container and its children. In the COMPOSITION case,"nthe children
cannot exist without the container. For AGGREGATION, the life cycles"nof
the container and children are totally independent. Known values are:
"ASSOCIATION", "AGGREGATION", "COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the
relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"structDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"termTemplateDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
]
}
get_all_type_definitions
Get all type definitions in Atlas in bulk.
get_all_type_definitions(*, include_term_template: Optional[bool] = False, type: Optional[str] = None, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
- include_term_template
- bool
Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template. Default value is False.
- type
- str
Typedef name as search filter when get typedefs. Known values are: "enum", "entity", "classification", "relationship", "struct", and "term_template". Default value is None.
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"businessMetadataDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"classificationDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType
names in the classificationDef, ensures that classifications
can"nonly be applied to those entityTypes."n"n"n.. raw:: html"n"n
<ul>"n <li>Any subtypes of the entity types inherit the
restriction</li>"n <li>Any classificationDef subtypes inherit the
parents entityTypes restrictions</li>"n <li>Any classificationDef
subtypes can further restrict the parents entityTypes restrictions by
specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there
are no restrictions</li>"n <li>An empty entityTypes list when there
are parent restrictions means that the subtype picks up the parents
restrictions</li>"n <li>If a list of entityTypes are supplied,
where one inherits from another, this will be rejected. This should
encourage cleaner classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"entityDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isLegacyAttribute": bool, # Optional.
Determines if it is a legacy attribute.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"relationshipTypeName": "str", # Optional.
The name of the relationship type.
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"enumDefs": [
{
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the
type definition.
"elementDefs": [
{
"description": "str", # Optional. The
description of the enum element definition.
"ordinal": 0.0, # Optional. The ordinal of
the enum element definition.
"value": "str" # Optional. The value of the
enum element definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"relationshipDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipCategory": "str", # Optional. The Relationship
category determines the style of relationship around containment and
lifecycle."nUML terminology is used for the
values."n"n:code:`<p>`"nASSOCIATION is a relationship with no
containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of
the container and its children. In the COMPOSITION case,"nthe children
cannot exist without the container. For AGGREGATION, the life cycles"nof
the container and children are totally independent. Known values are:
"ASSOCIATION", "AGGREGATION", "COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the
relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"structDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"termTemplateDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
]
}
get_business_metadata_def_by_guid
Get the businessMetadata definition for the given guid.
get_business_metadata_def_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_business_metadata_def_by_name
Get the businessMetadata definition by it's name (unique).
get_business_metadata_def_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_classification_def_by_guid
Get the classification definition for the given GUID.
get_classification_def_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType names in the
classificationDef, ensures that classifications can"nonly be applied to those
entityTypes."n"n"n.. raw:: html"n"n <ul>"n <li>Any subtypes of the entity
types inherit the restriction</li>"n <li>Any classificationDef subtypes
inherit the parents entityTypes restrictions</li>"n <li>Any
classificationDef subtypes can further restrict the parents entityTypes
restrictions by specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there are no
restrictions</li>"n <li>An empty entityTypes list when there are parent
restrictions means that the subtype picks up the parents restrictions</li>"n
<li>If a list of entityTypes are supplied, where one inherits from another,
this will be rejected. This should encourage cleaner
classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_classification_def_by_name
Get the classification definition by its name (unique).
get_classification_def_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType names in the
classificationDef, ensures that classifications can"nonly be applied to those
entityTypes."n"n"n.. raw:: html"n"n <ul>"n <li>Any subtypes of the entity
types inherit the restriction</li>"n <li>Any classificationDef subtypes
inherit the parents entityTypes restrictions</li>"n <li>Any
classificationDef subtypes can further restrict the parents entityTypes
restrictions by specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there are no
restrictions</li>"n <li>An empty entityTypes list when there are parent
restrictions means that the subtype picks up the parents restrictions</li>"n
<li>If a list of entityTypes are supplied, where one inherits from another,
this will be rejected. This should encourage cleaner
classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_entity_definition_by_guid
Get the Entity definition for the given GUID.
get_entity_definition_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isLegacyAttribute": bool, # Optional. Determines if it is a
legacy attribute.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"relationshipTypeName": "str", # Optional. The name of the
relationship type.
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_entity_definition_by_name
Get the entity definition by its name (unique).
get_entity_definition_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isLegacyAttribute": bool, # Optional. Determines if it is a
legacy attribute.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"relationshipTypeName": "str", # Optional. The name of the
relationship type.
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_enum_def_by_guid
Get the enum definition for the given GUID.
get_enum_def_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the type definition.
"elementDefs": [
{
"description": "str", # Optional. The description of the
enum element definition.
"ordinal": 0.0, # Optional. The ordinal of the enum element
definition.
"value": "str" # Optional. The value of the enum element
definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_enum_def_by_name
Get the enum definition by its name (unique).
get_enum_def_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the type definition.
"elementDefs": [
{
"description": "str", # Optional. The description of the
enum element definition.
"ordinal": 0.0, # Optional. The ordinal of the enum element
definition.
"value": "str" # Optional. The value of the enum element
definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_relationship_def_by_guid
Get the relationship definition for the given GUID.
get_relationship_def_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"relationshipCategory": "str", # Optional. The Relationship category
determines the style of relationship around containment and lifecycle."nUML
terminology is used for the values."n"n:code:`<p>`"nASSOCIATION is a relationship
with no containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of the
container and its children. In the COMPOSITION case,"nthe children cannot exist
without the container. For AGGREGATION, the life cycles"nof the container and
children are totally independent. Known values are: "ASSOCIATION", "AGGREGATION",
"COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_relationship_def_by_name
Get the relationship definition by its name (unique).
get_relationship_def_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"relationshipCategory": "str", # Optional. The Relationship category
determines the style of relationship around containment and lifecycle."nUML
terminology is used for the values."n"n:code:`<p>`"nASSOCIATION is a relationship
with no containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of the
container and its children. In the COMPOSITION case,"nthe children cannot exist
without the container. For AGGREGATION, the life cycles"nof the container and
children are totally independent. Known values are: "ASSOCIATION", "AGGREGATION",
"COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_struct_def_by_guid
Get the struct definition for the given GUID.
get_struct_def_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_struct_def_by_name
Get the struct definition by its name (unique).
get_struct_def_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_term_template_def_by_guid
Get the term template definition for the given GUID.
get_term_template_def_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_term_template_def_by_name
Get the term template definition by its name (unique).
get_term_template_def_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"description": "str", # Optional. The description of the type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_type_definition_by_guid
Get the type definition for the given GUID.
get_type_definition_by_guid(guid: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the type definition.
"elementDefs": [
{
"description": "str", # Optional. The description of the
enum element definition.
"ordinal": 0.0, # Optional. The ordinal of the enum element
definition.
"value": "str" # Optional. The value of the enum element
definition.
}
],
"endDef1": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"entityTypes": [
"str" # Optional. Specifying a list of entityType names in the
classificationDef, ensures that classifications can"nonly be applied to those
entityTypes."n"n"n.. raw:: html"n"n <ul>"n <li>Any subtypes of the entity
types inherit the restriction</li>"n <li>Any classificationDef subtypes
inherit the parents entityTypes restrictions</li>"n <li>Any
classificationDef subtypes can further restrict the parents entityTypes
restrictions by specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there are no
restrictions</li>"n <li>An empty entityTypes list when there are parent
restrictions means that the subtype picks up the parents restrictions</li>"n
<li>If a list of entityTypes are supplied, where one inherits from another,
this will be rejected. This should encourage cleaner
classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isLegacyAttribute": bool, # Optional. Determines if it is a
legacy attribute.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"relationshipTypeName": "str", # Optional. The name of the
relationship type.
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"relationshipCategory": "str", # Optional. The Relationship category
determines the style of relationship around containment and lifecycle."nUML
terminology is used for the values."n"n:code:`<p>`"nASSOCIATION is a relationship
with no containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of the
container and its children. In the COMPOSITION case,"nthe children cannot exist
without the container. For AGGREGATION, the life cycles"nof the container and
children are totally independent. Known values are: "ASSOCIATION", "AGGREGATION",
"COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the relationship.
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
get_type_definition_by_name
Get the type definition by its name (unique).
get_type_definition_by_name(name: str, **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# response body for status code(s): 200
response.json() == {
"attributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"category": "str", # Optional. The enum of type category. Known values are:
"PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY",
"ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the record.
"createdBy": "str", # Optional. The user who created the record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency of the date
format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines if grouping is
used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The maximum of
fraction digits.
"maximumIntegerDigits": 0, # Optional. The maximum of
integer digits.
"minimumFractionDigits": 0, # Optional. The minimum of
fraction digits.
"minimumIntegerDigits": 0, # Optional. The minimum of
integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional. Determines if only
integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum of rounding mode.
Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP",
"HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of available IDs.
],
"default": ...,
"displayName": "str", # Optional. The display name of the
timezone.
"dstSavings": 0, # Optional. The value of the daylight
saving time.
"id": "str", # Optional. The ID of the timezone.
"rawOffset": 0 # Optional. The raw offset of the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the type definition.
"elementDefs": [
{
"description": "str", # Optional. The description of the
enum element definition.
"ordinal": 0.0, # Optional. The ordinal of the enum element
definition.
"value": "str" # Optional. The value of the enum element
definition.
}
],
"endDef1": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"description": "str", # Optional. The description of the
relationship end definition.
"isContainer": bool, # Optional. Determines if it is container.
"isLegacyAttribute": bool, # Optional. Determines if it is a legacy
attribute.
"name": "str", # Optional. The name of the relationship end
definition.
"type": "str" # Optional. The type of the relationship end.
},
"entityTypes": [
"str" # Optional. Specifying a list of entityType names in the
classificationDef, ensures that classifications can"nonly be applied to those
entityTypes."n"n"n.. raw:: html"n"n <ul>"n <li>Any subtypes of the entity
types inherit the restriction</li>"n <li>Any classificationDef subtypes
inherit the parents entityTypes restrictions</li>"n <li>Any
classificationDef subtypes can further restrict the parents entityTypes
restrictions by specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there are no
restrictions</li>"n <li>An empty entityTypes list when there are parent
restrictions means that the subtype picks up the parents restrictions</li>"n
<li>If a list of entityTypes are supplied, where one inherits from another,
this will be rejected. This should encourage cleaner
classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional. single-valued attribute or
multi-valued attribute. Known values are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} # Optional. The parameters
of the constraint definition.
},
"type": "str" # Optional. The type of the
constraint.
}
],
"defaultValue": "str", # Optional. The default value of the
attribute.
"description": "str", # Optional. The description of the
attribute.
"includeInNotification": bool, # Optional. Determines if it
is included in notification.
"isIndexable": bool, # Optional. Determines if it is
indexable.
"isLegacyAttribute": bool, # Optional. Determines if it is a
legacy attribute.
"isOptional": bool, # Optional. Determines if it is
optional.
"isUnique": bool, # Optional. Determines if it unique.
"name": "str", # Optional. The name of the attribute.
"options": {
"str": "str" # Optional. The options for the
attribute.
},
"relationshipTypeName": "str", # Optional. The name of the
relationship type.
"typeName": "str", # Optional. The name of the type.
"valuesMaxCount": 0, # Optional. The maximum count of the
values.
"valuesMinCount": 0 # Optional. The minimum count of the
values.
}
],
"relationshipCategory": "str", # Optional. The Relationship category
determines the style of relationship around containment and lifecycle."nUML
terminology is used for the values."n"n:code:`<p>`"nASSOCIATION is a relationship
with no containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of the
container and its children. In the COMPOSITION case,"nthe children cannot exist
without the container. For AGGREGATION, the life cycles"nof the container and
children are totally independent. Known values are: "ASSOCIATION", "AGGREGATION",
"COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the relationship.
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the record.
"updatedBy": "str", # Optional. The user who updated the record.
"version": 0.0 # Optional. The version of the record.
}
list_type_definition_headers
List all type definitions returned as a list of minimal information header.
list_type_definition_headers(*, include_term_template: Optional[bool] = False, type: Optional[str] = None, **kwargs: Any) -> List[collections.abc.MutableMapping[str, Any]]Parameters
- include_term_template
- bool
Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template. Default value is False.
- type
- str
Typedef name as search filter when get typedefs. Known values are: "enum", "entity", "classification", "relationship", "struct", and "term_template". Default value is None.
Returns
list of JSON object
Return type
list[<xref:JSON>]
Exceptions
Examples
# response body for status code(s): 200
response.json() == [
{
"category": "str", # Optional. The enum of type category. Known
values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE".
"guid": "str", # Optional. The GUID of the type definition.
"name": "str" # Optional. The name of the type definition.
}
]
update_atlas_type_definitions
Update all types in bulk, changes detected in the type definitions would be persisted.
update_atlas_type_definitions(types_def: collections.abc.MutableMapping[str, Any], **kwargs: Any) -> collections.abc.MutableMapping[str, Any]Parameters
- types_def
- <xref:JSON>
Required
A composite object that captures all type definition changes.
Returns
JSON object
Return type
<xref:JSON>
Exceptions
Examples
# JSON input template you can fill out and use as your body input.
types_def = {
"businessMetadataDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"classificationDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType
names in the classificationDef, ensures that classifications
can"nonly be applied to those entityTypes."n"n"n.. raw:: html"n"n
<ul>"n <li>Any subtypes of the entity types inherit the
restriction</li>"n <li>Any classificationDef subtypes inherit the
parents entityTypes restrictions</li>"n <li>Any classificationDef
subtypes can further restrict the parents entityTypes restrictions by
specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there
are no restrictions</li>"n <li>An empty entityTypes list when there
are parent restrictions means that the subtype picks up the parents
restrictions</li>"n <li>If a list of entityTypes are supplied,
where one inherits from another, this will be rejected. This should
encourage cleaner classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"entityDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isLegacyAttribute": bool, # Optional.
Determines if it is a legacy attribute.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"relationshipTypeName": "str", # Optional.
The name of the relationship type.
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"enumDefs": [
{
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the
type definition.
"elementDefs": [
{
"description": "str", # Optional. The
description of the enum element definition.
"ordinal": 0.0, # Optional. The ordinal of
the enum element definition.
"value": "str" # Optional. The value of the
enum element definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"relationshipDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipCategory": "str", # Optional. The Relationship
category determines the style of relationship around containment and
lifecycle."nUML terminology is used for the
values."n"n:code:`<p>`"nASSOCIATION is a relationship with no
containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of
the container and its children. In the COMPOSITION case,"nthe children
cannot exist without the container. For AGGREGATION, the life cycles"nof
the container and children are totally independent. Known values are:
"ASSOCIATION", "AGGREGATION", "COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the
relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"structDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"termTemplateDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
]
}
# response body for status code(s): 200
response.json() == {
"businessMetadataDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"classificationDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"entityTypes": [
"str" # Optional. Specifying a list of entityType
names in the classificationDef, ensures that classifications
can"nonly be applied to those entityTypes."n"n"n.. raw:: html"n"n
<ul>"n <li>Any subtypes of the entity types inherit the
restriction</li>"n <li>Any classificationDef subtypes inherit the
parents entityTypes restrictions</li>"n <li>Any classificationDef
subtypes can further restrict the parents entityTypes restrictions by
specifying a subset of the entityTypes</li>"n <li>An empty
entityTypes list when there are no parent restrictions means there
are no restrictions</li>"n <li>An empty entityTypes list when there
are parent restrictions means that the subtype picks up the parents
restrictions</li>"n <li>If a list of entityTypes are supplied,
where one inherits from another, this will be rejected. This should
encourage cleaner classificationsDefs</li>"n </ul>.
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"entityDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipAttributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isLegacyAttribute": bool, # Optional.
Determines if it is a legacy attribute.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"relationshipTypeName": "str", # Optional.
The name of the relationship type.
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"serviceType": "str", # Optional. The service type.
"subTypes": [
"str" # Optional. An array of sub types.
],
"superTypes": [
"str" # Optional. An array of super types.
],
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"enumDefs": [
{
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"defaultValue": "str", # Optional. The default value.
"description": "str", # Optional. The description of the
type definition.
"elementDefs": [
{
"description": "str", # Optional. The
description of the enum element definition.
"ordinal": 0.0, # Optional. The ordinal of
the enum element definition.
"value": "str" # Optional. The value of the
enum element definition.
}
],
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"relationshipDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"endDef1": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"endDef2": {
"cardinality": "str", # Optional. single-valued
attribute or multi-valued attribute. Known values are: "SINGLE",
"LIST", "SET".
"description": "str", # Optional. The description of
the relationship end definition.
"isContainer": bool, # Optional. Determines if it is
container.
"isLegacyAttribute": bool, # Optional. Determines if
it is a legacy attribute.
"name": "str", # Optional. The name of the
relationship end definition.
"type": "str" # Optional. The type of the
relationship end.
},
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"relationshipCategory": "str", # Optional. The Relationship
category determines the style of relationship around containment and
lifecycle."nUML terminology is used for the
values."n"n:code:`<p>`"nASSOCIATION is a relationship with no
containment. :code:`<br>`"nCOMPOSITION and AGGREGATION are containment
relationships."n"n:code:`<p>`"nThe difference being in the lifecycles of
the container and its children. In the COMPOSITION case,"nthe children
cannot exist without the container. For AGGREGATION, the life cycles"nof
the container and children are totally independent. Known values are:
"ASSOCIATION", "AGGREGATION", "COMPOSITION".
"relationshipLabel": "str", # Optional. The label of the
relationship.
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"structDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
],
"termTemplateDefs": [
{
"attributeDefs": [
{
"cardinality": "str", # Optional.
single-valued attribute or multi-valued attribute. Known values
are: "SINGLE", "LIST", "SET".
"constraints": [
{
"params": {
"str": {} #
Optional. The parameters of the constraint
definition.
},
"type": "str" # Optional.
The type of the constraint.
}
],
"defaultValue": "str", # Optional. The
default value of the attribute.
"description": "str", # Optional. The
description of the attribute.
"includeInNotification": bool, # Optional.
Determines if it is included in notification.
"isIndexable": bool, # Optional. Determines
if it is indexable.
"isOptional": bool, # Optional. Determines
if it is optional.
"isUnique": bool, # Optional. Determines if
it unique.
"name": "str", # Optional. The name of the
attribute.
"options": {
"str": "str" # Optional. The options
for the attribute.
},
"typeName": "str", # Optional. The name of
the type.
"valuesMaxCount": 0, # Optional. The maximum
count of the values.
"valuesMinCount": 0 # Optional. The minimum
count of the values.
}
],
"category": "str", # Optional. The enum of type category.
Known values are: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT",
"CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP",
"TERM_TEMPLATE".
"createTime": 0.0, # Optional. The created time of the
record.
"createdBy": "str", # Optional. The user who created the
record.
"dateFormatter": {
"availableLocales": [
"str" # Optional. An array of available
locales.
],
"calendar": 0.0, # Optional. The date format.
"dateInstance": ...,
"dateTimeInstance": ...,
"instance": ...,
"lenient": bool, # Optional. Determines the leniency
of the date format.
"numberFormat": {
"availableLocales": [
"str" # Optional. The number format.
],
"currency": "str", # Optional. The currency.
"currencyInstance": ...,
"groupingUsed": bool, # Optional. Determines
if grouping is used.
"instance": ...,
"integerInstance": ...,
"maximumFractionDigits": 0, # Optional. The
maximum of fraction digits.
"maximumIntegerDigits": 0, # Optional. The
maximum of integer digits.
"minimumFractionDigits": 0, # Optional. The
minimum of fraction digits.
"minimumIntegerDigits": 0, # Optional. The
minimum of integer digits.
"numberInstance": ...,
"parseIntegerOnly": bool, # Optional.
Determines if only integer is parsed.
"percentInstance": ...,
"roundingMode": "str" # Optional. The enum
of rounding mode. Known values are: "UP", "DOWN", "CEILING",
"FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY".
},
"timeInstance": ...,
"timeZone": {
"availableIds": [
"str" # Optional. An array of
available IDs.
],
"default": ...,
"displayName": "str", # Optional. The
display name of the timezone.
"dstSavings": 0, # Optional. The value of
the daylight saving time.
"id": "str", # Optional. The ID of the
timezone.
"rawOffset": 0 # Optional. The raw offset of
the timezone.
}
},
"description": "str", # Optional. The description of the
type definition.
"guid": "str", # Optional. The GUID of the type definition.
"lastModifiedTS": "str", # Optional. ETag for concurrency
control.
"name": "str", # Optional. The name of the type definition.
"options": {
"str": "str" # Optional. The options for the type
definition.
},
"serviceType": "str", # Optional. The service type.
"typeVersion": "str", # Optional. The version of the type.
"updateTime": 0.0, # Optional. The update time of the
record.
"updatedBy": "str", # Optional. The user who updated the
record.
"version": 0.0 # Optional. The version of the record.
}
]
}
Feedback
Submit and view feedback for