oracle.oci.oci_data_connectivity_data_profile_actions – Perform actions on a DataProfile resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_data_connectivity_data_profile_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a DataProfile resource in Oracle Cloud Infrastructure
For action=create, execute data profiling on live schema.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
action
string
/ required
|
|
The action to perform on the DataProfile.
|
||||||||||
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||||||||||
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||||||||||
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|||||||||||
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|||||||||||
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
||||||||||
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
||||||||||
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|||||||||||
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|||||||||||
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|||||||||||
connection
dictionary
|
||||||||||||
connection_properties
list
/ elements=dictionary
|
The properties of the connection.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
value
string
|
The value for the connection name property.
|
|||||||||||
description
string
|
User-defined description for the connection.
|
|||||||||||
identifier
string
/ required
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
is_default
boolean
|
|
The default property of the connection.
|
||||||||||
key
string
/ required
|
Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create.
|
|||||||||||
metadata
dictionary
|
||||||||||||
aggregator
dictionary
|
||||||||||||
description
string
|
The description of the aggregator.
|
|||||||||||
identifier
string
|
The identifier of the aggregator.
|
|||||||||||
key
string
|
The key of the aggregator object.
|
|||||||||||
name
string
|
The name of the aggregator.
|
|||||||||||
type
string
|
The type of the aggregator.
|
|||||||||||
aggregator_key
string
|
The owning object key for this object.
|
|||||||||||
created_by
string
|
The user that created the object.
|
|||||||||||
created_by_name
string
|
The user that created the object.
|
|||||||||||
identifier_path
string
|
The full path to identify the object.
|
|||||||||||
info_fields
dictionary
|
Information property fields.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether this object is a favorite.
|
||||||||||
labels
list
/ elements=string
|
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version of the object.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by
string
|
The user that updated the object.
|
|||||||||||
updated_by_name
string
|
The user that updated the object.
|
|||||||||||
model_type
string
|
The type of the object.
|
|||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
/ required
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
primary_schema
dictionary
|
||||||||||||
default_connection
string
|
The default connection key.
|
|||||||||||
description
string
|
User-defined description for the schema.
|
|||||||||||
external_key
string
|
The external key of the object.
|
|||||||||||
identifier
string
/ required
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
is_has_containers
boolean
|
|
Specifies whether the schema has containers.
|
||||||||||
key
string
/ required
|
The object key.
|
|||||||||||
metadata
dictionary
|
||||||||||||
aggregator
dictionary
|
||||||||||||
description
string
|
The description of the aggregator.
|
|||||||||||
identifier
string
|
The identifier of the aggregator.
|
|||||||||||
key
string
|
The key of the aggregator object.
|
|||||||||||
name
string
|
The name of the aggregator.
|
|||||||||||
type
string
|
The type of the aggregator.
|
|||||||||||
aggregator_key
string
|
The owning object key for this object.
|
|||||||||||
created_by
string
|
The user that created the object.
|
|||||||||||
created_by_name
string
|
The user that created the object.
|
|||||||||||
identifier_path
string
|
The full path to identify the object.
|
|||||||||||
info_fields
dictionary
|
Information property fields.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether this object is a favorite.
|
||||||||||
labels
list
/ elements=string
|
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version of the object.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by
string
|
The user that updated the object.
|
|||||||||||
updated_by_name
string
|
The user that updated the object.
|
|||||||||||
model_type
string
/ required
|
The object type.
|
|||||||||||
model_version
string
|
The model version of the object.
|
|||||||||||
name
string
/ required
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
resource_name
string
|
A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters.
|
|||||||||||
properties
dictionary
|
All the properties of the connection in a key-value map format.
|
|||||||||||
registry_metadata
dictionary
|
||||||||||||
aggregator_key
string
|
The owning object's key for this object.
|
|||||||||||
created_by_user_id
string
|
The ID of the user who created the object.
|
|||||||||||
created_by_user_name
string
|
The name of the user who created the object.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether the object is a favorite.
|
||||||||||
key
string
|
The identifying key for the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by_user_id
string
|
The ID of the user who updated the object.
|
|||||||||||
updated_by_user_name
string
|
The name of the user who updated the object.
|
|||||||||||
type
string
|
Specific Connection Type
|
|||||||||||
data_asset
dictionary
|
||||||||||||
asset_properties
dictionary
|
Additional properties for the data asset.
|
|||||||||||
default_connection
dictionary
|
||||||||||||
connection_properties
list
/ elements=dictionary
|
The properties of the connection.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
value
string
|
The value for the connection name property.
|
|||||||||||
description
string
|
User-defined description for the connection.
|
|||||||||||
identifier
string
/ required
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
is_default
boolean
|
|
The default property of the connection.
|
||||||||||
key
string
/ required
|
Generated key that can be used in API calls to identify the connection. In scenarios where reference to the connection is required, a value can be passed in create.
|
|||||||||||
metadata
dictionary
|
||||||||||||
aggregator
dictionary
|
||||||||||||
description
string
|
The description of the aggregator.
|
|||||||||||
identifier
string
|
The identifier of the aggregator.
|
|||||||||||
key
string
|
The key of the aggregator object.
|
|||||||||||
name
string
|
The name of the aggregator.
|
|||||||||||
type
string
|
The type of the aggregator.
|
|||||||||||
aggregator_key
string
|
The owning object key for this object.
|
|||||||||||
created_by
string
|
The user that created the object.
|
|||||||||||
created_by_name
string
|
The user that created the object.
|
|||||||||||
identifier_path
string
|
The full path to identify the object.
|
|||||||||||
info_fields
dictionary
|
Information property fields.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether this object is a favorite.
|
||||||||||
labels
list
/ elements=string
|
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version of the object.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by
string
|
The user that updated the object.
|
|||||||||||
updated_by_name
string
|
The user that updated the object.
|
|||||||||||
model_type
string
|
The type of the object.
|
|||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
/ required
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
primary_schema
dictionary
|
||||||||||||
default_connection
string
|
The default connection key.
|
|||||||||||
description
string
|
User-defined description for the schema.
|
|||||||||||
external_key
string
|
The external key of the object.
|
|||||||||||
identifier
string
/ required
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
is_has_containers
boolean
|
|
Specifies whether the schema has containers.
|
||||||||||
key
string
/ required
|
The object key.
|
|||||||||||
metadata
dictionary
|
||||||||||||
aggregator
dictionary
|
||||||||||||
description
string
|
The description of the aggregator.
|
|||||||||||
identifier
string
|
The identifier of the aggregator.
|
|||||||||||
key
string
|
The key of the aggregator object.
|
|||||||||||
name
string
|
The name of the aggregator.
|
|||||||||||
type
string
|
The type of the aggregator.
|
|||||||||||
aggregator_key
string
|
The owning object key for this object.
|
|||||||||||
created_by
string
|
The user that created the object.
|
|||||||||||
created_by_name
string
|
The user that created the object.
|
|||||||||||
identifier_path
string
|
The full path to identify the object.
|
|||||||||||
info_fields
dictionary
|
Information property fields.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether this object is a favorite.
|
||||||||||
labels
list
/ elements=string
|
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version of the object.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by
string
|
The user that updated the object.
|
|||||||||||
updated_by_name
string
|
The user that updated the object.
|
|||||||||||
model_type
string
/ required
|
The object type.
|
|||||||||||
model_version
string
|
The model version of the object.
|
|||||||||||
name
string
/ required
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
resource_name
string
|
A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters.
|
|||||||||||
properties
dictionary
|
All the properties of the connection in a key-value map format.
|
|||||||||||
registry_metadata
dictionary
|
||||||||||||
aggregator_key
string
|
The owning object's key for this object.
|
|||||||||||
created_by_user_id
string
|
The ID of the user who created the object.
|
|||||||||||
created_by_user_name
string
|
The name of the user who created the object.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether the object is a favorite.
|
||||||||||
key
string
|
The identifying key for the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by_user_id
string
|
The ID of the user who updated the object.
|
|||||||||||
updated_by_user_name
string
|
The name of the user who updated the object.
|
|||||||||||
type
string
|
Specific Connection Type
|
|||||||||||
description
string
|
User-defined description of the data asset.
|
|||||||||||
end_points
list
/ elements=dictionary
|
The list of endpoints with which this data asset is associated.
|
|||||||||||
compartment_id
string
|
The compartmentId of the private endpoint resource.
Applicable when model_type is 'PRIVATE_END_POINT'
|
|||||||||||
data_assets
list
/ elements=dictionary
|
The list of data assets that belong to the endpoint.
|
|||||||||||
asset_properties
dictionary
|
Additional properties for the data asset.
|
|||||||||||
default_connection
dictionary
|
||||||||||||
description
string
|
User-defined description of the data asset.
|
|||||||||||
end_points
list
/ elements=dictionary
|
The list of endpoints with which this data asset is associated.
|
|||||||||||
external_key
string
|
The external key of the object.
|
|||||||||||
identifier
string
/ required
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
key
string
/ required
|
Currently not used while creating a data asset. Reserved for future.
|
|||||||||||
metadata
dictionary
|
||||||||||||
model_type
string
|
The type of the object.
|
|||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
/ required
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
native_type_system
dictionary
|
||||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
properties
dictionary
|
All the properties for the data asset in a key-value map format.
|
|||||||||||
registry_metadata
dictionary
|
||||||||||||
type
string
|
Specific DataAsset Type
|
|||||||||||
dcms_endpoint_id
string
|
The endpoint ID provided by control plane.
Required when model_type is 'PRIVATE_END_POINT'
|
|||||||||||
description
string
|
User-defined description of the endpoint.
|
|||||||||||
dns_proxy_ip
string
|
The IP address of the DNS proxy.
Applicable when model_type is 'PRIVATE_END_POINT'
|
|||||||||||
dns_zones
list
/ elements=string
|
Array of DNS zones to be used during the private endpoint resolution.
Applicable when model_type is 'PRIVATE_END_POINT'
|
|||||||||||
identifier
string
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
key
string
|
Generated key that can be used in API calls to identify the endpoint. In scenarios where reference to the endpoint is required, a value can be passed in create.
|
|||||||||||
model_type
string
/ required
|
|
The type of the endpoint.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'PRIVATE_END_POINT'
|
|||||||||||
pe_id
string
|
The OCID of the private endpoint resource.
Applicable when model_type is 'PRIVATE_END_POINT'
|
|||||||||||
private_endpoint_ip
string
|
The OCID of the private endpoint resource.
Applicable when model_type is 'PRIVATE_END_POINT'
|
|||||||||||
state
string
|
|
Specifies the private endpoint state.
Applicable when model_type is 'PRIVATE_END_POINT'
|
||||||||||
external_key
string
|
The external key of the object.
|
|||||||||||
identifier
string
/ required
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
key
string
/ required
|
Currently not used while creating a data asset. Reserved for future.
|
|||||||||||
metadata
dictionary
|
||||||||||||
aggregator
dictionary
|
||||||||||||
description
string
|
The description of the aggregator.
|
|||||||||||
identifier
string
|
The identifier of the aggregator.
|
|||||||||||
key
string
|
The key of the aggregator object.
|
|||||||||||
name
string
|
The name of the aggregator.
|
|||||||||||
type
string
|
The type of the aggregator.
|
|||||||||||
aggregator_key
string
|
The owning object key for this object.
|
|||||||||||
created_by
string
|
The user that created the object.
|
|||||||||||
created_by_name
string
|
The user that created the object.
|
|||||||||||
identifier_path
string
|
The full path to identify the object.
|
|||||||||||
info_fields
dictionary
|
Information property fields.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether this object is a favorite.
|
||||||||||
labels
list
/ elements=string
|
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version of the object.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by
string
|
The user that updated the object.
|
|||||||||||
updated_by_name
string
|
The user that updated the object.
|
|||||||||||
model_type
string
|
The type of the object.
|
|||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
/ required
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
native_type_system
dictionary
|
||||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
identifier
string
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
|
The type of the object.
|
|||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
type_mapping_from
dictionary
|
The type system to map from.
|
|||||||||||
type_mapping_to
dictionary
|
The type system to map to.
|
|||||||||||
types
list
/ elements=dictionary
|
An array of types.
|
|||||||||||
config_definition
dictionary
|
||||||||||||
config_parameter_definitions
dictionary
|
The parameter configuration details.
|
|||||||||||
class_field_name
string
|
The parameter class field name.
|
|||||||||||
default_value
dictionary
|
The default value for the parameter.
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
is_class_field_value
boolean
|
|
Specifies whether the parameter is a class field.
|
||||||||||
is_static
boolean
|
|
Specifies whether the parameter is static.
|
||||||||||
parameter_name
string
|
This object represents the configurable properties for an object type.
|
|||||||||||
parameter_type
dictionary
|
||||||||||||
config_definition
dictionary
|
Applicable when model_type is one of ['DATA_TYPE', 'CONFIGURED_TYPE', 'COMPOSITE_TYPE']
|
|||||||||||
config_parameter_definitions
dictionary
|
The parameter configuration details.
|
|||||||||||
is_contained
boolean
|
|
Specifies whether the configuration is contained.
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
|
The type of the object.
|
|||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
config_values
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
dt_type
string
|
|
The data type.
Applicable when model_type is 'DATA_TYPE'
|
||||||||||
elements
list
/ elements=dictionary
|
An array of elements.
Applicable when model_type is 'COMPOSITE_TYPE'
|
|||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
default_value
dictionary
|
The default value of the parameter.
Applicable when model_type is 'PARAMETER'
|
|||||||||||
default_value_string
string
|
The default value.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
fields
list
/ elements=dictionary
|
An array of fields.
Applicable when model_type is one of ['INPUT_PORT', 'OUTPUT_PORT']
|
|||||||||||
config_values
dictionary
|
||||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
is_input
boolean
|
|
Specifies whether the parameter is an input value.
Applicable when model_type is 'PARAMETER'
|
||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
|
||||||||||
is_output
boolean
|
|
Specifies whether the parameter is an output value.
Applicable when model_type is 'PARAMETER'
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
native_shape_field
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
default_value_string
string
|
The default value.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
Applicable when model_type is 'SHAPE_FIELD'
|
||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'SHAPE_FIELD'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
type
dictionary
/ required
|
The type reference.
Required when model_type is 'SHAPE_FIELD'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
output_aggregation_type
string
|
|
The output aggregation type.
Applicable when model_type is 'PARAMETER'
|
||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
port_type
string
|
|
The port details of the data asset type.
Applicable when model_type is one of ['INPUT_PORT', 'OUTPUT_PORT']
|
||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
|
|||||||||||
root_object_default_value
dictionary
|
The default value of the parameter, which can be an object in DIS, such as a data entity.
Applicable when model_type is 'PARAMETER'
|
|||||||||||
type
dictionary
|
Applicable when model_type is one of ['SHAPE', 'SHAPE_FIELD', 'PARAMETER']
Required when model_type is 'NATIVE_SHAPE_FIELD'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
type_name
string
|
The type of value the parameter was created for.
Applicable when model_type is 'PARAMETER'
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent_type
dictionary
|
Applicable when model_type is 'COMPOSITE_TYPE'
|
|||||||||||
config_definition
dictionary
|
||||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
elements
list
/ elements=dictionary
|
An array of elements.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent_type
dictionary
|
||||||||||||
schema
dictionary
|
Applicable when model_type is 'STRUCTURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
type_system_name
string
|
The data type system name.
Applicable when model_type is 'DATA_TYPE'
|
|||||||||||
wrapped_type
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
is_contained
boolean
|
|
Specifies whether the configuration is contained.
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
|
The type of the object.
|
|||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
dt_type
string
|
|
The data type.
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
type_system_name
string
|
The data type system name.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
properties
dictionary
|
All the properties for the data asset in a key-value map format.
|
|||||||||||
registry_metadata
dictionary
|
||||||||||||
aggregator_key
string
|
The owning object's key for this object.
|
|||||||||||
created_by_user_id
string
|
The ID of the user who created the object.
|
|||||||||||
created_by_user_name
string
|
The name of the user who created the object.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether the object is a favorite.
|
||||||||||
key
string
|
The identifying key for the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by_user_id
string
|
The ID of the user who updated the object.
|
|||||||||||
updated_by_user_name
string
|
The name of the user who updated the object.
|
|||||||||||
type
string
|
Specific DataAsset Type
|
|||||||||||
data_entity
dictionary
|
||||||||||||
data_format
dictionary
|
Applicable when model_type is 'FILE_ENTITY'
|
|||||||||||
compression_config
dictionary
|
Applicable when model_type is 'FILE_ENTITY'
|
|||||||||||
codec
string
/ required
|
|
Compression algorithm
Required when model_type is 'FILE_ENTITY'
|
||||||||||
format_attribute
dictionary
|
Applicable when model_type is 'FILE_ENTITY'
|
|||||||||||
compression
string
|
The compression for the file.
Applicable when model_type is one of ['PARQUET_FORMAT', 'AVRO_FORMAT']
|
|||||||||||
data_address
string
|
Range of the data. For example, "'My Sheet'!B3:C35"
Applicable when model_type is 'EXCEL_FORMAT'
|
|||||||||||
delimiter
string
|
The delimiter for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
encoding
string
|
The encoding for the file.
Applicable when model_type is one of ['CSV_FORMAT', 'JSON_FORMAT']
|
|||||||||||
escape_character
string
|
The escape character for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
has_header
boolean
|
|
Defines whether the file has a header row.
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
header
boolean
|
|
Whether the dataAddress contains the header with column names. If false - column names fill be generated.
Applicable when model_type is 'EXCEL_FORMAT'
|
||||||||||
is_file_pattern
boolean
|
|
Defines whether a file pattern is supported.
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
is_multiline
boolean
|
|
Defines whether the file has a multiline content
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
is_quote_all
boolean
|
|
Defines whether the quote entire content while performing read/write.
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
is_trailing_delimiter
boolean
|
|
Defines whether the file has a trailing delimiter
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
model_type
string
/ required
|
|
The type of the format attribute.
|
||||||||||
password
string
|
Workbook password if it is password protected.
Applicable when model_type is 'EXCEL_FORMAT'
|
|||||||||||
quote_character
string
|
The quote character for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
timestamp_format
string
|
Format for timestamp information.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
type
string
/ required
|
|
type
Required when model_type is 'FILE_ENTITY'
|
||||||||||
derived_properties
dictionary
|
Property-bag (key-value pairs where key is Shape Field resource name and value is object)
Applicable when model_type is 'DERIVED_ENTITY'
|
|||||||||||
description
string
|
Detailed description of the object.
Applicable when model_type is one of ['VIEW_ENTITY', 'SQL_ENTITY', 'DATA_STORE_ENTITY', 'TABLE_ENTITY', 'FILE_ENTITY']
|
|||||||||||
entity_properties
dictionary
|
Map<String, String> for entity properties
|
|||||||||||
entity_type
string
|
|
The entity type.
Applicable when model_type is one of ['VIEW_ENTITY', 'SQL_ENTITY', 'DATA_STORE_ENTITY', 'TABLE_ENTITY', 'FILE_ENTITY']
|
||||||||||
external_key
string
|
The external key of the object.
Applicable when model_type is one of ['VIEW_ENTITY', 'SQL_ENTITY', 'DATA_STORE_ENTITY', 'TABLE_ENTITY', 'FILE_ENTITY']
|
|||||||||||
filters
string
|
Filters present in the datastore. It can be null.
Applicable when model_type is 'DATA_STORE_ENTITY'
|
|||||||||||
foreign_keys
list
/ elements=dictionary
|
An array of foreign keys.
Applicable when model_type is one of ['VIEW_ENTITY', 'SQL_ENTITY', 'DATA_STORE_ENTITY', 'TABLE_ENTITY', 'FILE_ENTITY']
|
|||||||||||
attribute_refs
list
/ elements=dictionary
|
An array of attribute references.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
attribute
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'TABLE_ENTITY'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
native_shape_field
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
default_value_string
string
|
The default value.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
Applicable when model_type is 'TABLE_ENTITY'
|
||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'TABLE_ENTITY'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
type
dictionary
/ required
|
The type reference.
Required when model_type is 'TABLE_ENTITY'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
type
dictionary
|
The type reference.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
delete_rule
integer
|
The delete rule.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
key
string
|
The object key.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
model_type
string
/ required
|
|
The key type.
Required when model_type is 'TABLE_ENTITY'
|
||||||||||
model_version
string
|
The model version of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
reference_unique_key
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
attribute_refs
list
/ elements=dictionary
|
An array of attribute references.
|
|||||||||||
attribute
dictionary
|
||||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
|
|||||||||||
string_value
string
|
A string value of the parameter.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
native_shape_field
dictionary
|
||||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
|
|||||||||||
string_value
string
|
A string value of the parameter.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
default_value_string
string
|
The default value.
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
position
integer
|
The position of the attribute.
|
|||||||||||
type
dictionary
/ required
|
The type reference.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
type
dictionary
|
The type reference.
|
|||||||||||
position
integer
|
The position of the attribute.
|
|||||||||||
key
string
|
The object key.
|
|||||||||||
model_type
string
/ required
|
|
The key type.
|
||||||||||
model_version
string
|
The model version of the object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
update_rule
integer
|
The update rule.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
identifier
string
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
is_effective_date_disabled
boolean
|
|
It shows whether the effective date is disabled.
Applicable when model_type is 'DATA_STORE_ENTITY'
|
||||||||||
is_flex_data_store
boolean
|
|
It shows whether the datastore is of flex type.
Applicable when model_type is 'DATA_STORE_ENTITY'
|
||||||||||
is_silent_error
boolean
|
|
It shows whether the extraction of this datastore will stop when an error occurs.
Applicable when model_type is 'DATA_STORE_ENTITY'
|
||||||||||
key
string
|
The object key.
|
|||||||||||
metadata
dictionary
|
||||||||||||
aggregator
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
description
string
|
The description of the aggregator.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
identifier
string
|
The identifier of the aggregator.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
key
string
|
The key of the aggregator object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
name
string
|
The name of the aggregator.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
type
string
|
The type of the aggregator.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
aggregator_key
string
|
The owning object key for this object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
created_by
string
|
The user that created the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
created_by_name
string
|
The user that created the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
identifier_path
string
|
The full path to identify the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
info_fields
dictionary
|
Information property fields.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether this object is a favorite.
Applicable when model_type is 'TABLE_ENTITY'
|
||||||||||
labels
list
/ elements=string
|
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
registry_version
integer
|
The registry version of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
time_created
string
|
The date and time that the object was created.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
updated_by
string
|
The user that updated the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
updated_by_name
string
|
The user that updated the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
mode
string
|
|
Determines whether entity is treated as source or target
Applicable when model_type is 'DERIVED_ENTITY'
|
||||||||||
model_type
string
/ required
|
|
The data entity type.
|
||||||||||
model_version
string
|
The model version of the object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Required when model_type is 'DERIVED_ENTITY'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
other_type_label
string
|
Specifies other type label.
Applicable when model_type is one of ['VIEW_ENTITY', 'SQL_ENTITY', 'DATA_STORE_ENTITY', 'TABLE_ENTITY', 'FILE_ENTITY']
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
ref_data_object
dictionary
|
Applicable when model_type is 'DERIVED_ENTITY'
|
|||||||||||
external_key
string
|
The external key for the object.
|
|||||||||||
key
string
|
The object key.
|
|||||||||||
model_type
string
/ required
|
|
The input Operation type.
|
||||||||||
model_version
string
|
The object's model version.
|
|||||||||||
name
string
|
Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is unique, editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow reference across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'API'
|
|||||||||||
resource_name
string
|
The resource name.
|
|||||||||||
resource_name
string
|
The resource name.
Required when model_type is 'DERIVED_ENTITY'
|
|||||||||||
shape
dictionary
|
||||||||||||
config_values
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'TABLE_ENTITY'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
type
dictionary
|
Applicable when model_type is 'TABLE_ENTITY'
|
|||||||||||
config_definition
dictionary
|
Applicable when model_type is one of ['DATA_TYPE', 'CONFIGURED_TYPE', 'COMPOSITE_TYPE']
|
|||||||||||
config_parameter_definitions
dictionary
|
The parameter configuration details.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
class_field_name
string
|
The parameter class field name.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
default_value
dictionary
|
The default value for the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
is_class_field_value
boolean
|
|
Specifies whether the parameter is a class field.
Applicable when model_type is 'CONFIGURED_TYPE'
|
||||||||||
is_static
boolean
|
|
Specifies whether the parameter is static.
Applicable when model_type is 'CONFIGURED_TYPE'
|
||||||||||
parameter_name
string
|
This object represents the configurable properties for an object type.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parameter_type
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
is_contained
boolean
|
|
Specifies whether the configuration is contained.
Applicable when model_type is 'CONFIGURED_TYPE'
|
||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
model_type
string
|
The type of the object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
dt_type
string
|
|
The data type.
Applicable when model_type is 'DATA_TYPE'
|
||||||||||
elements
list
/ elements=dictionary
|
An array of elements.
Applicable when model_type is 'COMPOSITE_TYPE'
|
|||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
default_value
dictionary
|
The default value of the parameter.
Applicable when model_type is 'PARAMETER'
|
|||||||||||
default_value_string
string
|
The default value.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
fields
list
/ elements=dictionary
|
An array of fields.
Applicable when model_type is one of ['INPUT_PORT', 'OUTPUT_PORT']
|
|||||||||||
config_values
dictionary
|
||||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
is_input
boolean
|
|
Specifies whether the parameter is an input value.
Applicable when model_type is 'PARAMETER'
|
||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
|
||||||||||
is_output
boolean
|
|
Specifies whether the parameter is an output value.
Applicable when model_type is 'PARAMETER'
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
native_shape_field
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
default_value_string
string
|
The default value.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
Applicable when model_type is 'SHAPE_FIELD'
|
||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'SHAPE_FIELD'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'SHAPE_FIELD'
|
|||||||||||
type
dictionary
/ required
|
The type reference.
Required when model_type is 'SHAPE_FIELD'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
output_aggregation_type
string
|
|
The output aggregation type.
Applicable when model_type is 'PARAMETER'
|
||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'OUTPUT_PORT'
|
|||||||||||
port_type
string
|
|
The port details of the data asset type.
Applicable when model_type is one of ['INPUT_PORT', 'OUTPUT_PORT']
|
||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
|
|||||||||||
root_object_default_value
dictionary
|
The default value of the parameter, which can be an object in DIS, such as a data entity.
Applicable when model_type is 'PARAMETER'
|
|||||||||||
type
dictionary
|
Applicable when model_type is one of ['SHAPE', 'SHAPE_FIELD', 'PARAMETER']
Required when model_type is 'NATIVE_SHAPE_FIELD'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
type_name
string
|
The type of value the parameter was created for.
Applicable when model_type is 'PARAMETER'
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
parent_type
dictionary
|
Applicable when model_type is 'COMPOSITE_TYPE'
|
|||||||||||
config_definition
dictionary
|
||||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
elements
list
/ elements=dictionary
|
An array of elements.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent_type
dictionary
|
||||||||||||
schema
dictionary
|
Applicable when model_type is 'STRUCTURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
type_system_name
string
|
The data type system name.
Applicable when model_type is 'DATA_TYPE'
|
|||||||||||
wrapped_type
dictionary
|
Applicable when model_type is 'CONFIGURED_TYPE'
|
|||||||||||
description
string
|
A user-defined description for the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The property which differentiates the subtypes.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
shape_id
string
|
The shape ID.
|
|||||||||||
sql_query
string
|
sqlQuery
Applicable when model_type is 'SQL_ENTITY'
|
|||||||||||
supports_incremental
boolean
|
|
It shows whether the datastore supports incremental extract.
Applicable when model_type is 'DATA_STORE_ENTITY'
|
||||||||||
unique_keys
list
/ elements=dictionary
|
An array of unique keys.
Applicable when model_type is one of ['VIEW_ENTITY', 'SQL_ENTITY', 'DATA_STORE_ENTITY', 'TABLE_ENTITY', 'FILE_ENTITY']
|
|||||||||||
attribute_refs
list
/ elements=dictionary
|
An array of attribute references.
|
|||||||||||
attribute
dictionary
|
||||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
|
|||||||||||
string_value
string
|
A string value of the parameter.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
native_shape_field
dictionary
|
||||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
|
|||||||||||
string_value
string
|
A string value of the parameter.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
default_value_string
string
|
The default value.
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
position
integer
|
The position of the attribute.
|
|||||||||||
type
dictionary
/ required
|
The type reference.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
type
dictionary
|
The type reference.
|
|||||||||||
position
integer
|
The position of the attribute.
|
|||||||||||
key
string
|
The object key.
|
|||||||||||
model_type
string
/ required
|
|
The key type.
|
||||||||||
model_version
string
|
The model version of the object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
endpoint_id
string
|
Endpoint ID used for getDataAssetFullDetails.
|
|||||||||||
profile_config
dictionary
|
||||||||||||
attributes
list
/ elements=string
|
Array of column names to profile. If empty, all the columns in the entity are profiled.
|
|||||||||||
data_type_threshold
integer
|
A data type has to qualify at least this percentage threshold to be considered an inferred data type for a column.
|
|||||||||||
functions
list
/ elements=string
|
|
Array of enum strings to decide which profile functions to run. If empty, all the supported functions are run.
|
||||||||||
pattern_threshold
integer
|
A pattern has to qualify at least this percentage threshold to be considered a pattern on its own. Patterns that do not qualify are clubbed together into 'Others' pattern.
|
|||||||||||
top_n_val_freq
integer
|
The maximum number of value frequencies to return per column. The VFs are sorted descending on frequency, and ascending on value, and then topN are returned and rest discarded.
|
|||||||||||
read_operation_config
dictionary
|
||||||||||||
data_format
dictionary
|
||||||||||||
compression_config
dictionary
|
||||||||||||
codec
string
/ required
|
|
Compression algorithm
|
||||||||||
format_attribute
dictionary
|
||||||||||||
compression
string
|
The compression for the file.
Applicable when model_type is one of ['PARQUET_FORMAT', 'AVRO_FORMAT']
|
|||||||||||
data_address
string
|
Range of the data. For example, "'My Sheet'!B3:C35"
Applicable when model_type is 'EXCEL_FORMAT'
|
|||||||||||
delimiter
string
|
The delimiter for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
encoding
string
|
The encoding for the file.
Applicable when model_type is one of ['CSV_FORMAT', 'JSON_FORMAT']
|
|||||||||||
escape_character
string
|
The escape character for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
has_header
boolean
|
|
Defines whether the file has a header row.
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
header
boolean
|
|
Whether the dataAddress contains the header with column names. If false - column names fill be generated.
Applicable when model_type is 'EXCEL_FORMAT'
|
||||||||||
is_file_pattern
boolean
|
|
Defines whether a file pattern is supported.
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
is_multiline
boolean
|
|
Defines whether the file has a multiline content
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
is_quote_all
boolean
|
|
Defines whether the quote entire content while performing read/write.
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
is_trailing_delimiter
boolean
|
|
Defines whether the file has a trailing delimiter
Applicable when model_type is 'CSV_FORMAT'
|
||||||||||
model_type
string
/ required
|
|
The type of the format attribute.
|
||||||||||
password
string
|
Workbook password if it is password protected.
Applicable when model_type is 'EXCEL_FORMAT'
|
|||||||||||
quote_character
string
|
The quote character for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
timestamp_format
string
|
Format for timestamp information.
Applicable when model_type is 'CSV_FORMAT'
|
|||||||||||
type
string
/ required
|
|
type
|
||||||||||
derived_attributes
dictionary
|
this map is used for passing BIP report/REST parameter values.
|
|||||||||||
key
string
|
The object key.
|
|||||||||||
model_type
string
/ required
|
|
The type of data operation.
|
||||||||||
model_version
string
|
The model version of the object.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
operations
list
/ elements=dictionary
|
An array of operations.
|
|||||||||||
condition
string
|
The join condition.
Required when model_type is 'JOIN'
|
|||||||||||
filter_condition
string
|
The filter condition.
Applicable when model_type is 'FILTER'
|
|||||||||||
is_distinct
boolean
|
|
Specifies whether the object is distinct.
Applicable when model_type is 'SELECT'
|
||||||||||
model_type
string
/ required
|
|
The type of operation.
|
||||||||||
policy
string
|
|
The type of join.
Required when model_type is 'JOIN'
|
||||||||||
query
string
|
A query string.
Required when model_type is 'QUERY'
|
|||||||||||
select_columns
list
/ elements=dictionary
|
An array of selected columns.
Required when model_type is 'SELECT'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'SELECT'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'SELECT'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'SELECT'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'SELECT'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'SELECT'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'SELECT'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'SELECT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SELECT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SELECT'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'SELECT'
|
|||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'SELECT'
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'SELECT'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'SELECT'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'SELECT'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'SELECT'
|
|||||||||||
native_shape_field
dictionary
|
Applicable when model_type is 'SELECT'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'SELECT'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'SELECT'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'SELECT'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'SELECT'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'SELECT'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'SELECT'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'SELECT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SELECT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SELECT'
|
|||||||||||
default_value_string
string
|
The default value.
Applicable when model_type is 'SELECT'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'SELECT'
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
Applicable when model_type is 'SELECT'
|
||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'SELECT'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'SELECT'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'SELECT'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'SELECT'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'SELECT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SELECT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SELECT'
|
|||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'SELECT'
|
|||||||||||
type
dictionary
/ required
|
The type reference.
Required when model_type is 'SELECT'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'SELECT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SELECT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SELECT'
|
|||||||||||
type
dictionary
|
The type reference.
Applicable when model_type is 'SELECT'
|
|||||||||||
sort_clauses
list
/ elements=dictionary
|
The sort clause.
Required when model_type is 'SORT'
|
|||||||||||
field
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'SORT'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'SORT'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'SORT'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'SORT'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'SORT'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'SORT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SORT'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'SORT'
|
|||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'SORT'
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'SORT'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'SORT'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'SORT'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'SORT'
|
|||||||||||
native_shape_field
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
config_values
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
config_param_values
dictionary
|
The configuration parameter values.
Applicable when model_type is 'SORT'
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
Applicable when model_type is 'SORT'
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
Applicable when model_type is 'SORT'
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
Applicable when model_type is 'SORT'
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
Applicable when model_type is 'SORT'
|
|||||||||||
string_value
string
|
A string value of the parameter.
Applicable when model_type is 'SORT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SORT'
|
|||||||||||
default_value_string
string
|
The default value.
Applicable when model_type is 'SORT'
|
|||||||||||
description
string
|
A detailed description of the object.
Applicable when model_type is 'SORT'
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
Applicable when model_type is 'SORT'
|
||||||||||
key
string
|
The key of the object.
Applicable when model_type is 'SORT'
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
Required when model_type is 'SORT'
|
||||||||||
model_version
string
|
The model version of an object.
Applicable when model_type is 'SORT'
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'SORT'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'SORT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SORT'
|
|||||||||||
position
integer
|
The position of the attribute.
Applicable when model_type is 'SORT'
|
|||||||||||
type
dictionary
/ required
|
The type reference.
Required when model_type is 'SORT'
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'SORT'
|
|||||||||||
parent_ref
dictionary
|
Applicable when model_type is 'SORT'
|
|||||||||||
parent
string
|
Key of the parent object.
Applicable when model_type is 'SORT'
|
|||||||||||
type
dictionary
|
The type reference.
Applicable when model_type is 'SORT'
|
|||||||||||
order
string
|
|
The sort order.
Applicable when model_type is 'SORT'
|
||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
partition_config
dictionary
|
||||||||||||
key_range
dictionary
|
||||||||||||
key
dictionary
|
||||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
|
|||||||||||
string_value
string
|
A string value of the parameter.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
key
string
|
The key of the object.
|
|||||||||||
labels
list
/ elements=string
|
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
native_shape_field
dictionary
|
||||||||||||
config_values
dictionary
|
||||||||||||
config_param_values
dictionary
|
The configuration parameter values.
|
|||||||||||
int_value
integer
|
An integer value of the parameter.
|
|||||||||||
object_value
dictionary
|
An object value of the parameter.
|
|||||||||||
parameter_value
string
|
Reference to the parameter by its key.
|
|||||||||||
ref_value
dictionary
|
The root object reference value.
|
|||||||||||
string_value
string
|
A string value of the parameter.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
default_value_string
string
|
The default value.
|
|||||||||||
description
string
|
A detailed description of the object.
|
|||||||||||
is_mandatory
boolean
|
|
Specifies whether the field is mandatory.
|
||||||||||
key
string
|
The key of the object.
|
|||||||||||
model_type
string
/ required
|
|
The type of the types object.
|
||||||||||
model_version
string
|
The model version of an object.
|
|||||||||||
name
string
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
position
integer
|
The position of the attribute.
|
|||||||||||
type
dictionary
/ required
|
The type reference.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
type
dictionary
|
The type reference.
|
|||||||||||
range
list
/ elements=string
|
The key range.
|
|||||||||||
model_type
string
/ required
|
|
The type of partition configuration.
|
||||||||||
partition_number
integer
|
The partition number for the key range.
|
|||||||||||
read_attribute
dictionary
|
||||||||||||
external_storage
dictionary
|
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
bucket
string
|
Bucket name where BICC extracts and stores the files.
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
host
string
|
Object Storage host URL. DO not give http/https.
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
model_type
string
/ required
|
|
The type of the abstract read attribute.
Required when model_type is 'BICC_READ_ATTRIBUTE'
|
||||||||||
namespace
string
|
Namespace of the OOS bucket.
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
storage_id
string
|
ID of the external stoarge configured in the BICC console. Usually it's numeric.
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
storage_name
string
|
Name of the external storage configured in the BICC console.
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
tenancy_id
string
|
Tenancy OCID of the OOS bucket.
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
extract_strategy
string
|
|
Extraction Strategy - FULL|INCREMENTAL
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
||||||||||
fetch_size
integer
|
The fetch size for reading.
|
|||||||||||
initial_extract_date
string
|
Date from where extract should start.
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
last_extract_date
string
|
Date last extracted
Applicable when model_type is 'BICC_READ_ATTRIBUTE'
|
|||||||||||
model_type
string
/ required
|
|
The type of the abstract read attribute.
|
||||||||||
read_raw_data
boolean
|
|
Specifies if the readOperationConfig operation should trigger a raw data preview flow.
|
||||||||||
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|||||||||||
registry_id
string
/ required
|
The registry OCID.
aliases: id |
|||||||||||
schema
dictionary
|
||||||||||||
default_connection
string
|
The default connection key.
|
|||||||||||
description
string
|
User-defined description for the schema.
|
|||||||||||
external_key
string
|
The external key of the object.
|
|||||||||||
identifier
string
/ required
|
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
|
|||||||||||
is_has_containers
boolean
|
|
Specifies whether the schema has containers.
|
||||||||||
key
string
/ required
|
The object key.
|
|||||||||||
metadata
dictionary
|
||||||||||||
aggregator
dictionary
|
||||||||||||
description
string
|
The description of the aggregator.
|
|||||||||||
identifier
string
|
The identifier of the aggregator.
|
|||||||||||
key
string
|
The key of the aggregator object.
|
|||||||||||
name
string
|
The name of the aggregator.
|
|||||||||||
type
string
|
The type of the aggregator.
|
|||||||||||
aggregator_key
string
|
The owning object key for this object.
|
|||||||||||
created_by
string
|
The user that created the object.
|
|||||||||||
created_by_name
string
|
The user that created the object.
|
|||||||||||
identifier_path
string
|
The full path to identify the object.
|
|||||||||||
info_fields
dictionary
|
Information property fields.
|
|||||||||||
is_favorite
boolean
|
|
Specifies whether this object is a favorite.
|
||||||||||
labels
list
/ elements=string
|
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
|
|||||||||||
registry_version
integer
|
The registry version of the object.
|
|||||||||||
time_created
string
|
The date and time that the object was created.
|
|||||||||||
time_updated
string
|
The date and time that the object was updated.
|
|||||||||||
updated_by
string
|
The user that updated the object.
|
|||||||||||
updated_by_name
string
|
The user that updated the object.
|
|||||||||||
model_type
string
/ required
|
The object type.
|
|||||||||||
model_version
string
|
The model version of the object.
|
|||||||||||
name
string
/ required
|
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
|
|||||||||||
object_status
integer
|
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
|
|||||||||||
object_version
integer
|
The version of the object that is used to track changes in the object instance.
|
|||||||||||
parent_ref
dictionary
|
||||||||||||
parent
string
|
Key of the parent object.
|
|||||||||||
resource_name
string
|
A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters.
|
|||||||||||
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action create on data_profile
oci_data_connectivity_data_profile_actions:
# required
registry_id: "ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx"
action: create
# optional
read_operation_config:
# required
model_type: READ_OPERATION_CONFIG
# optional
derived_attributes: null
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
operations:
- # required
query: query_example
model_type: QUERY
data_format:
# required
type: JSON
# optional
format_attribute:
# required
model_type: AVRO_FORMAT
# optional
compression: compression_example
compression_config:
# required
codec: NONE
partition_config:
# required
model_type: KEYRANGEPARTITIONCONFIG
# optional
partition_number: 56
key_range:
# optional
key:
# required
model_type: SHAPE
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
type: null
labels: [ "labels_example" ]
native_shape_field:
# required
model_type: SHAPE
type: null
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
position: 56
default_value_string: default_value_string_example
is_mandatory: true
range: [ "range_example" ]
read_attribute:
# required
model_type: ORACLE_READ_ATTRIBUTE
# optional
fetch_size: 56
object_status: 56
read_raw_data: true
data_asset:
# required
key: key_example
name: name_example
identifier: identifier_example
# optional
model_version: model_version_example
model_type: model_type_example
description: description_example
object_status: 56
object_version: 56
external_key: external_key_example
asset_properties: null
properties: null
type: type_example
native_type_system:
# optional
key: key_example
model_type: model_type_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
description: description_example
object_version: 56
type_mapping_to: null
type_mapping_from: null
object_status: 56
identifier: identifier_example
types:
- # required
model_type: STRUCTURED_TYPE
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
object_status: 56
description: description_example
dt_type: PRIMITIVE
type_system_name: type_system_name_example
config_definition:
# optional
key: key_example
model_type: model_type_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
is_contained: true
object_status: 56
config_parameter_definitions:
# optional
parameter_type:
# required
model_type: CONFIGURED_TYPE
# optional
wrapped_type:
# required
model_type: STRUCTURED_TYPE
# optional
key: key_example
model_version: model_version_example
parent_ref: null
name: name_example
object_status: 56
description: description_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
object_status: 56
description: description_example
config_definition:
# optional
key: key_example
model_type: model_type_example
model_version: model_version_example
parent_ref: null
name: name_example
is_contained: true
object_status: 56
config_parameter_definitions: null
parameter_name: parameter_name_example
description: description_example
default_value: null
class_field_name: class_field_name_example
is_static: true
is_class_field_value: true
registry_metadata:
# optional
aggregator_key: aggregator_key_example
labels: [ "labels_example" ]
registry_version: 56
key: key_example
is_favorite: true
created_by_user_id: "ocid1.createdbyuser.oc1..xxxxxxEXAMPLExxxxxx"
created_by_user_name: created_by_user_name_example
updated_by_user_id: "ocid1.updatedbyuser.oc1..xxxxxxEXAMPLExxxxxx"
updated_by_user_name: updated_by_user_name_example
time_created: time_created_example
time_updated: time_updated_example
metadata:
# optional
created_by: created_by_example
created_by_name: created_by_name_example
updated_by: updated_by_example
updated_by_name: updated_by_name_example
time_created: time_created_example
time_updated: time_updated_example
aggregator_key: aggregator_key_example
aggregator:
# optional
type: type_example
key: key_example
name: name_example
identifier: identifier_example
description: description_example
identifier_path: identifier_path_example
info_fields: null
registry_version: 56
labels: [ "labels_example" ]
is_favorite: true
default_connection:
# required
key: key_example
name: name_example
identifier: identifier_example
# optional
model_version: model_version_example
model_type: model_type_example
description: description_example
object_version: 56
object_status: 56
primary_schema:
# required
key: key_example
model_type: model_type_example
name: name_example
identifier: identifier_example
# optional
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
resource_name: resource_name_example
description: description_example
object_version: 56
external_key: external_key_example
is_has_containers: true
default_connection: default_connection_example
object_status: 56
metadata:
# optional
created_by: created_by_example
created_by_name: created_by_name_example
updated_by: updated_by_example
updated_by_name: updated_by_name_example
time_created: time_created_example
time_updated: time_updated_example
aggregator_key: aggregator_key_example
aggregator:
# optional
type: type_example
key: key_example
name: name_example
identifier: identifier_example
description: description_example
identifier_path: identifier_path_example
info_fields: null
registry_version: 56
labels: [ "labels_example" ]
is_favorite: true
connection_properties:
- # optional
name: name_example
value: value_example
properties: null
type: type_example
is_default: true
metadata:
# optional
created_by: created_by_example
created_by_name: created_by_name_example
updated_by: updated_by_example
updated_by_name: updated_by_name_example
time_created: time_created_example
time_updated: time_updated_example
aggregator_key: aggregator_key_example
aggregator:
# optional
type: type_example
key: key_example
name: name_example
identifier: identifier_example
description: description_example
identifier_path: identifier_path_example
info_fields: null
registry_version: 56
labels: [ "labels_example" ]
is_favorite: true
registry_metadata:
# optional
aggregator_key: aggregator_key_example
labels: [ "labels_example" ]
registry_version: 56
key: key_example
is_favorite: true
created_by_user_id: "ocid1.createdbyuser.oc1..xxxxxxEXAMPLExxxxxx"
created_by_user_name: created_by_user_name_example
updated_by_user_id: "ocid1.updatedbyuser.oc1..xxxxxxEXAMPLExxxxxx"
updated_by_user_name: updated_by_user_name_example
time_created: time_created_example
time_updated: time_updated_example
end_points:
- # required
dcms_endpoint_id: "ocid1.dcmsendpoint.oc1..xxxxxxEXAMPLExxxxxx"
model_type: PRIVATE_END_POINT
# optional
pe_id: "ocid1.pe.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
dns_proxy_ip: dns_proxy_ip_example
private_endpoint_ip: private_endpoint_ip_example
dns_zones: [ "dns_zones_example" ]
state: ACTIVE
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
description: description_example
object_version: 56
object_status: 56
identifier: identifier_example
data_assets:
- # required
key: key_example
name: name_example
identifier: identifier_example
# optional
model_version: model_version_example
model_type: model_type_example
description: description_example
object_status: 56
object_version: 56
external_key: external_key_example
asset_properties: null
properties: null
type: type_example
native_type_system: null
registry_metadata: null
metadata: null
default_connection: null
end_points: [ "end_points_example" ]
connection:
# required
key: key_example
name: name_example
identifier: identifier_example
# optional
model_version: model_version_example
model_type: model_type_example
description: description_example
object_version: 56
object_status: 56
primary_schema:
# required
key: key_example
model_type: model_type_example
name: name_example
identifier: identifier_example
# optional
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
resource_name: resource_name_example
description: description_example
object_version: 56
external_key: external_key_example
is_has_containers: true
default_connection: default_connection_example
object_status: 56
metadata:
# optional
created_by: created_by_example
created_by_name: created_by_name_example
updated_by: updated_by_example
updated_by_name: updated_by_name_example
time_created: time_created_example
time_updated: time_updated_example
aggregator_key: aggregator_key_example
aggregator:
# optional
type: type_example
key: key_example
name: name_example
identifier: identifier_example
description: description_example
identifier_path: identifier_path_example
info_fields: null
registry_version: 56
labels: [ "labels_example" ]
is_favorite: true
connection_properties:
- # optional
name: name_example
value: value_example
properties: null
type: type_example
is_default: true
metadata:
# optional
created_by: created_by_example
created_by_name: created_by_name_example
updated_by: updated_by_example
updated_by_name: updated_by_name_example
time_created: time_created_example
time_updated: time_updated_example
aggregator_key: aggregator_key_example
aggregator:
# optional
type: type_example
key: key_example
name: name_example
identifier: identifier_example
description: description_example
identifier_path: identifier_path_example
info_fields: null
registry_version: 56
labels: [ "labels_example" ]
is_favorite: true
registry_metadata:
# optional
aggregator_key: aggregator_key_example
labels: [ "labels_example" ]
registry_version: 56
key: key_example
is_favorite: true
created_by_user_id: "ocid1.createdbyuser.oc1..xxxxxxEXAMPLExxxxxx"
created_by_user_name: created_by_user_name_example
updated_by_user_id: "ocid1.updatedbyuser.oc1..xxxxxxEXAMPLExxxxxx"
updated_by_user_name: updated_by_user_name_example
time_created: time_created_example
time_updated: time_updated_example
schema:
# required
key: key_example
model_type: model_type_example
name: name_example
identifier: identifier_example
# optional
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
resource_name: resource_name_example
description: description_example
object_version: 56
external_key: external_key_example
is_has_containers: true
default_connection: default_connection_example
object_status: 56
metadata:
# optional
created_by: created_by_example
created_by_name: created_by_name_example
updated_by: updated_by_example
updated_by_name: updated_by_name_example
time_created: time_created_example
time_updated: time_updated_example
aggregator_key: aggregator_key_example
aggregator:
# optional
type: type_example
key: key_example
name: name_example
identifier: identifier_example
description: description_example
identifier_path: identifier_path_example
info_fields: null
registry_version: 56
labels: [ "labels_example" ]
is_favorite: true
data_entity:
# required
model_type: TABLE_ENTITY
# optional
description: description_example
external_key: external_key_example
entity_type: TABLE
other_type_label: other_type_label_example
unique_keys:
- # required
model_type: PRIMARY_KEY
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
attribute_refs:
- # optional
position: 56
attribute:
# required
model_type: SHAPE
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
type: null
labels: [ "labels_example" ]
native_shape_field:
# required
model_type: SHAPE
type: null
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
position: 56
default_value_string: default_value_string_example
is_mandatory: true
object_status: 56
foreign_keys:
- # required
model_type: FOREIGN_KEY
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
attribute_refs:
- # optional
position: 56
attribute:
# required
model_type: SHAPE
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
type: null
labels: [ "labels_example" ]
native_shape_field:
# required
model_type: SHAPE
type: null
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
position: 56
default_value_string: default_value_string_example
is_mandatory: true
update_rule: 56
delete_rule: 56
reference_unique_key:
# required
model_type: PRIMARY_KEY
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
attribute_refs:
- # optional
position: 56
attribute:
# required
model_type: SHAPE
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
type: null
labels: [ "labels_example" ]
native_shape_field:
# required
model_type: SHAPE
type: null
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
position: 56
default_value_string: default_value_string_example
is_mandatory: true
object_status: 56
object_status: 56
entity_properties: null
metadata:
# optional
created_by: created_by_example
created_by_name: created_by_name_example
updated_by: updated_by_example
updated_by_name: updated_by_name_example
time_created: time_created_example
time_updated: time_updated_example
aggregator_key: aggregator_key_example
aggregator:
# optional
type: type_example
key: key_example
name: name_example
identifier: identifier_example
description: description_example
identifier_path: identifier_path_example
info_fields: null
registry_version: 56
labels: [ "labels_example" ]
is_favorite: true
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
object_version: 56
shape:
# required
model_type: SHAPE
# optional
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
object_status: 56
name: name_example
description: description_example
type:
# required
model_type: CONFIGURED_TYPE
# optional
wrapped_type:
# required
model_type: STRUCTURED_TYPE
# optional
key: key_example
model_version: model_version_example
parent_ref: null
name: name_example
object_status: 56
description: description_example
config_values:
# optional
config_param_values:
# optional
string_value: string_value_example
int_value: 56
object_value: null
ref_value: null
parameter_value: parameter_value_example
parent_ref:
# optional
parent: parent_example
key: key_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
object_status: 56
description: description_example
config_definition:
# optional
key: key_example
model_type: model_type_example
model_version: model_version_example
parent_ref:
# optional
parent: parent_example
name: name_example
is_contained: true
object_status: 56
config_parameter_definitions:
# optional
parameter_type:
# required
model_type: STRUCTURED_TYPE
# optional
key: key_example
model_version: model_version_example
parent_ref: null
name: name_example
object_status: 56
description: description_example
parameter_name: parameter_name_example
description: description_example
default_value: null
class_field_name: class_field_name_example
is_static: true
is_class_field_value: true
shape_id: "ocid1.shape.oc1..xxxxxxEXAMPLExxxxxx"
resource_name: resource_name_example
object_status: 56
identifier: identifier_example
profile_config:
# optional
attributes: [ "attributes_example" ]
functions: [ "ATTRIBUTE_COUNT" ]
top_n_val_freq: 56
pattern_threshold: 56
data_type_threshold: 56
endpoint_id: "ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)