oracle.oci.oci_data_connectivity_data_preview_actions – Perform actions on a DataPreview 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_preview_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DataPreview resource in Oracle Cloud Infrastructure

  • For action=create, provide data preview on live schema.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • create
The action to perform on the DataPreview.
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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • PRIVATE_END_POINT
  • PUBLIC_END_POINT
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
    Choices:
  • ACTIVE
  • INACTIVE
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
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
Specifies whether the parameter is a class field.
is_static
boolean
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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
    Choices:
  • PRIMITIVE
  • STRUCTURED
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
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
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
    Choices:
  • no
  • yes
Specifies whether the parameter is an input value.
Applicable when model_type is 'PARAMETER'
is_mandatory
boolean
    Choices:
  • no
  • yes
Specifies whether the field is mandatory.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
is_output
boolean
    Choices:
  • no
  • yes
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
    Choices:
  • OUTPUT_PORT
  • SHAPE
  • SHAPE_FIELD
  • INPUT_PORT
  • PARAMETER
  • NATIVE_SHAPE_FIELD
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
    Choices:
  • no
  • yes
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
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
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
    Choices:
  • MIN
  • MAX
  • COUNT
  • SUM
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
    Choices:
  • DATA
  • CONTROL
  • MODEL
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
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
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
    Choices:
  • CONFIGURED_TYPE
  • DERIVED_TYPE
  • DATA_TYPE
  • STRUCTURED_TYPE
  • COMPOSITE_TYPE
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
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
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
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
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
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
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.