Oracle Cloud Infrastructure Documentation
Try Free Tier

Integration Common Types

DBMS_CLOUD_OCI_INTEGRATION_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_INTEGRATION_ATTACHMENT_DETAILS_T Type

Description of an attachments for this instance

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_attachment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  target_role varchar2(32767),
  is_implicit number,
  target_id varchar2(32767),
  target_instance_url varchar2(32767),
  target_service_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_attachment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_attachment_details_t (
    target_role varchar2,
    is_implicit number,
    target_id varchar2,
    target_instance_url varchar2,
    target_service_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

target_role

(required) The role of the target attachment. * `PARENT` - The target instance is the parent of this attachment. * `CHILD` - The target instance is the child of this attachment.

Allowed values are: 'PARENT', 'CHILD'

is_implicit

(required) * If role == `PARENT`, the attached instance was created by this service instance * If role == `CHILD`, this instance was created from attached instance on behalf of a user

target_id

(required) The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this instance is attached.

target_instance_url

(required) The dataplane instance URL of the attached instance

target_service_type

(required) The type of the target instance, such as \"FUSION\".

DBMS_CLOUD_OCI_INTEGRATION_CHANGE_INTEGRATION_INSTANCE_COMPARTMENT_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_change_integration_instance_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_change_integration_instance_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_change_integration_instance_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(optional) Compartment Identifier.

DBMS_CLOUD_OCI_INTEGRATION_NETWORK_ENDPOINT_DETAILS_T Type

Base representation of a network endpoint.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_network_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  network_endpoint_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_network_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_network_endpoint_details_t (
    network_endpoint_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

network_endpoint_type

(required) The type of network endpoint.

Allowed values are: 'PUBLIC'

DBMS_CLOUD_OCI_INTEGRATION_CHANGE_INTEGRATION_INSTANCE_NETWORK_ENDPOINT_DETAILS_T Type

Input payload to update an Integration instance endpoint details. An empty payload will clear out any existing configuration. Some actions may not be applicable to specific integration types, see Differences in Instance Management for details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_change_integration_instance_network_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_change_integration_instance_network_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_change_integration_instance_network_endpoint_details_t (
    network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

network_endpoint_details

(optional)

DBMS_CLOUD_OCI_INTEGRATION_OUTBOUND_CONNECTION_T Type

Base representation for Outbound Connection (Reverse Connection).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_outbound_connection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  outbound_connection_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_outbound_connection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_outbound_connection_t (
    outbound_connection_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

outbound_connection_type

(required) The type of Outbound Connection.

Allowed values are: 'PRIVATE_ENDPOINT', 'NONE'

DBMS_CLOUD_OCI_INTEGRATION_CHANGE_PRIVATE_ENDPOINT_OUTBOUND_CONNECTION_DETAILS_T Type

Input payload to ADD/REMOVE Private Endpoint Outbound Connection for given IntegrationInstance. Some actions may not be applicable to specific integration types, see Differences in Instance Management for details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_change_private_endpoint_outbound_connection_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  private_endpoint_outbound_connection dbms_cloud_oci_integration_outbound_connection_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_change_private_endpoint_outbound_connection_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_change_private_endpoint_outbound_connection_details_t (
    private_endpoint_outbound_connection dbms_cloud_oci_integration_outbound_connection_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

private_endpoint_outbound_connection

(optional)

DBMS_CLOUD_OCI_INTEGRATION_CREATE_CUSTOM_ENDPOINT_DETAILS_T Type

Details for a custom endpoint for the integration instance (update).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_create_custom_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  certificate_secret_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_create_custom_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_create_custom_endpoint_details_t (
    hostname varchar2,
    certificate_secret_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) A custom hostname to be used for the integration instance URL, in FQDN format.

certificate_secret_id

(optional) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate.

DBMS_CLOUD_OCI_INTEGRATION_CREATE_CUSTOM_ENDPOINT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_integration_create_custom_endpoint_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_create_custom_endpoint_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_integration_create_custom_endpoint_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_INTEGRATION_CREATE_INTEGRATION_INSTANCE_DETAILS_T Type

The information about new IntegrationInstance. Some properties may not be applicable to specific integration types, see Differences in Instance Management for details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_create_integration_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  integration_instance_type varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  is_byol number,
  idcs_at varchar2(32767),
  message_packs number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_integration_create_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_integration_create_custom_endpoint_details_tbl,
  consumption_model varchar2(32767),
  is_file_server_enabled number,
  network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t,
  shape varchar2(32767),
  domain_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_create_integration_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_create_integration_instance_details_t (
    display_name varchar2,
    compartment_id varchar2,
    integration_instance_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_byol number,
    idcs_at varchar2,
    message_packs number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_integration_create_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_integration_create_custom_endpoint_details_tbl,
    consumption_model varchar2,
    is_file_server_enabled number,
    network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t,
    shape varchar2,
    domain_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(required) Integration Instance Identifier.

compartment_id

(required) Compartment Identifier.

integration_instance_type

(required) Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX

Allowed values are: 'STANDARD', 'ENTERPRISE', 'STANDARDX', 'ENTERPRISEX'

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_byol

(required) Bring your own license.

idcs_at

(optional) IDCS Authentication token. This is required for all realms with IDCS. Its optional as its not required for non IDCS realms.

message_packs

(required) The number of configured message packs

is_visual_builder_enabled

(optional) Visual Builder is enabled or not.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints to be used for the integration instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance).

consumption_model

(optional) Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement.

Allowed values are: 'UCM', 'GOV', 'OIC4SAAS'

is_file_server_enabled

(optional) The file server is enabled or not.

network_endpoint_details

(optional)

shape

(optional) Shape

Allowed values are: 'DEVELOPMENT', 'PRODUCTION'

domain_id

(optional) The OCID of the identity domain, that will be used to determine the corresponding Idcs Stripe and create an Idcs application within the stripe. This parameter is mutually exclusive with parameter: idcsAt, i.e only one of two parameters should be specified.

DBMS_CLOUD_OCI_INTEGRATION_CUSTOM_ENDPOINT_DETAILS_T Type

Details for a custom endpoint for the integration instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_custom_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  certificate_secret_id varchar2(32767),
  certificate_secret_version number,
  alias varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_custom_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_custom_endpoint_details_t (
    hostname varchar2,
    certificate_secret_id varchar2,
    certificate_secret_version number,
    alias varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) A custom hostname to be used for the integration instance URL, in FQDN format.

certificate_secret_id

(optional) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

certificate_secret_version

(optional) The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

alias

(optional) When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata.

DBMS_CLOUD_OCI_INTEGRATION_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_INTEGRATION_IDCS_INFO_DETAILS_T Type

Information for IDCS access

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_idcs_info_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  idcs_app_location_url varchar2(32767),
  idcs_app_display_name varchar2(32767),
  idcs_app_id varchar2(32767),
  idcs_app_name varchar2(32767),
  instance_primary_audience_url varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_idcs_info_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_idcs_info_details_t (
    idcs_app_location_url varchar2,
    idcs_app_display_name varchar2,
    idcs_app_id varchar2,
    idcs_app_name varchar2,
    instance_primary_audience_url varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

idcs_app_location_url

(required) URL for the location of the IDCS Application (used by IDCS APIs)

idcs_app_display_name

(required) The IDCS application display name associated with the instance

idcs_app_id

(required) The IDCS application ID associated with the instance

idcs_app_name

(required) The IDCS application name associated with the instance

instance_primary_audience_url

(required) The URL used as the primary audience for integration flows in this instance type: string

DBMS_CLOUD_OCI_INTEGRATION_CUSTOM_ENDPOINT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_integration_custom_endpoint_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_custom_endpoint_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_integration_custom_endpoint_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_INTEGRATION_ATTACHMENT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_integration_attachment_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_attachment_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_integration_attachment_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_INTEGRATION_INTEGRATION_INSTANCE_T Type

Description of Integration Instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_integration_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  integration_instance_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  state_message varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  is_byol number,
  instance_url varchar2(32767),
  message_packs number,
  is_file_server_enabled number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_integration_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_integration_custom_endpoint_details_tbl,
  consumption_model varchar2(32767),
  network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t,
  idcs_info dbms_cloud_oci_integration_idcs_info_details_t,
  attachments dbms_cloud_oci_integration_attachment_details_tbl,
  shape varchar2(32767),
  private_endpoint_outbound_connection dbms_cloud_oci_integration_outbound_connection_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_integration_instance_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_integration_instance_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    integration_instance_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    state_message varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_byol number,
    instance_url varchar2,
    message_packs number,
    is_file_server_enabled number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_integration_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_integration_custom_endpoint_details_tbl,
    consumption_model varchar2,
    network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t,
    idcs_info dbms_cloud_oci_integration_idcs_info_details_t,
    attachments dbms_cloud_oci_integration_attachment_details_tbl,
    shape varchar2,
    private_endpoint_outbound_connection dbms_cloud_oci_integration_outbound_connection_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation.

display_name

(required) Integration Instance Identifier, can be renamed.

compartment_id

(required) Compartment Identifier.

integration_instance_type

(required) Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX

Allowed values are: 'STANDARD', 'ENTERPRISE', 'STANDARDX', 'ENTERPRISEX'

time_created

(optional) The time the the IntegrationInstance was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the IntegrationInstance was updated. An RFC3339 formatted datetime string.

lifecycle_state

(optional) The current state of the integration instance.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

state_message

(optional) An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_byol

(required) Bring your own license.

instance_url

(required) The Integration Instance URL.

message_packs

(required) The number of configured message packs (if any)

is_file_server_enabled

(optional) The file server is enabled or not.

is_visual_builder_enabled

(optional) VisualBuilder is enabled or not.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints used for the integration instance URL.

consumption_model

(optional) The entitlement used for billing purposes.

Allowed values are: 'UCM', 'GOV', 'OIC4SAAS'

network_endpoint_details

(optional)

idcs_info

(optional)

attachments

(optional) A list of associated attachments to other services

shape

(optional) Shape

Allowed values are: 'DEVELOPMENT', 'PRODUCTION'

private_endpoint_outbound_connection

(optional)

DBMS_CLOUD_OCI_INTEGRATION_INTEGRATION_INSTANCE_SUMMARY_T Type

Summary of the Integration Instance.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_integration_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  integration_instance_type varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  state_message varchar2(32767),
  is_byol number,
  instance_url varchar2(32767),
  message_packs number,
  is_file_server_enabled number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_integration_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_integration_custom_endpoint_details_tbl,
  consumption_model varchar2(32767),
  network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  shape varchar2(32767),
  private_endpoint_outbound_connection dbms_cloud_oci_integration_outbound_connection_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_integration_instance_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_integration_instance_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    integration_instance_type varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    state_message varchar2,
    is_byol number,
    instance_url varchar2,
    message_packs number,
    is_file_server_enabled number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_integration_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_integration_custom_endpoint_details_tbl,
    consumption_model varchar2,
    network_endpoint_details dbms_cloud_oci_integration_network_endpoint_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    shape varchar2,
    private_endpoint_outbound_connection dbms_cloud_oci_integration_outbound_connection_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation.

display_name

(required) Integration Instance Identifier, can be renamed.

compartment_id

(required) Compartment Identifier.

integration_instance_type

(required) Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX

Allowed values are: 'STANDARD', 'ENTERPRISE', 'STANDARDX', 'ENTERPRISEX'

time_created

(optional) The time the the Integration Instance was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the IntegrationInstance was updated. An RFC3339 formatted datetime string.

lifecycle_state

(optional) The current state of the Integration Instance.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

state_message

(optional) An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

is_byol

(required) Bring your own license.

instance_url

(required) The Integration Instance URL.

message_packs

(required) The number of configured message packs (if any)

is_file_server_enabled

(optional) The file server is enabled or not.

is_visual_builder_enabled

(optional) Visual Builder is enabled or not.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints used for the integration instance URL.

consumption_model

(optional) The entitlement used for billing purposes.

Allowed values are: 'UCM', 'GOV', 'OIC4SAAS'

network_endpoint_details

(optional)

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

shape

(optional) Shape

Allowed values are: 'DEVELOPMENT', 'PRODUCTION'

private_endpoint_outbound_connection

(optional)

DBMS_CLOUD_OCI_INTEGRATION_NONE_OUTBOUND_CONNECTION_T Type

Details required for removing Private Endpoint Outbound Connection (ReverseConnection).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_none_outbound_connection_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_integration_outbound_connection_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_none_outbound_connection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_none_outbound_connection_t (
    outbound_connection_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_integration_none_outbound_connection_t is a subtype of the dbms_cloud_oci_integration_outbound_connection_t type.

DBMS_CLOUD_OCI_INTEGRATION_PRIVATE_ENDPOINT_OUTBOUND_CONNECTION_T Type

Details required for creating Private Endpoint Outbound Connection (ReverseConnection).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_private_endpoint_outbound_connection_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_integration_outbound_connection_t (
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_integration_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_private_endpoint_outbound_connection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_private_endpoint_outbound_connection_t (
    outbound_connection_type varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_integration_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_integration_private_endpoint_outbound_connection_t is a subtype of the dbms_cloud_oci_integration_outbound_connection_t type.

Fields

Field Description

subnet_id

(required) Customer Private Network VCN Subnet OCID. This is a required argument.

nsg_ids

(optional) One or more Network security group Ids. This is an optional argument.

DBMS_CLOUD_OCI_INTEGRATION_VIRTUAL_CLOUD_NETWORK_T Type

Virtual Cloud Network definition.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_virtual_cloud_network_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  allowlisted_ips dbms_cloud_oci_integration_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_virtual_cloud_network_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_virtual_cloud_network_t (
    id varchar2,
    allowlisted_ips dbms_cloud_oci_integration_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The Virtual Cloud Network OCID.

allowlisted_ips

(optional) Source IP addresses or IP address ranges ingress rules. (ex: \"168.122.59.5\", \"10.20.30.0/26\") An invalid IP or CIDR block will result in a 400 response.

DBMS_CLOUD_OCI_INTEGRATION_VIRTUAL_CLOUD_NETWORK_TBL Type

Nested table type of dbms_cloud_oci_integration_virtual_cloud_network_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_virtual_cloud_network_tbl FORCE IS TABLE OF (dbms_cloud_oci_integration_virtual_cloud_network_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_INTEGRATION_PUBLIC_ENDPOINT_DETAILS_T Type

Public endpoint configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_public_endpoint_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_integration_network_endpoint_details_t (
  allowlisted_http_ips dbms_cloud_oci_integration_varchar2_tbl,
  allowlisted_http_vcns dbms_cloud_oci_integration_virtual_cloud_network_tbl,
  is_integration_vcn_allowlisted number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_public_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_public_endpoint_details_t (
    network_endpoint_type varchar2,
    allowlisted_http_ips dbms_cloud_oci_integration_varchar2_tbl,
    allowlisted_http_vcns dbms_cloud_oci_integration_virtual_cloud_network_tbl,
    is_integration_vcn_allowlisted number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_integration_public_endpoint_details_t is a subtype of the dbms_cloud_oci_integration_network_endpoint_details_t type.

Fields

Field Description

allowlisted_http_ips

(optional) Source IP addresses or IP address ranges ingress rules. (ex: \"168.122.59.5\", \"10.20.30.0/26\") An invalid IP or CIDR block will result in a 400 response.

allowlisted_http_vcns

(optional) Virtual Cloud Networks allowed to access this network endpoint.

is_integration_vcn_allowlisted

(optional) The Integration service's VCN is allow-listed to allow integrations to call back into other integrations

DBMS_CLOUD_OCI_INTEGRATION_UPDATE_CUSTOM_ENDPOINT_DETAILS_T Type

Details for a custom endpoint for the integration instance (update).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_update_custom_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  certificate_secret_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_update_custom_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_update_custom_endpoint_details_t (
    hostname varchar2,
    certificate_secret_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

hostname

(required) A custom hostname to be used for the integration instance URL, in FQDN format.

certificate_secret_id

(optional) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret. Note the update will fail if this is not a valid certificate.

DBMS_CLOUD_OCI_INTEGRATION_UPDATE_CUSTOM_ENDPOINT_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_integration_update_custom_endpoint_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_update_custom_endpoint_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_integration_update_custom_endpoint_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_INTEGRATION_UPDATE_INTEGRATION_INSTANCE_DETAILS_T Type

The information to be updated. Some properties may not be applicable to specific integration types, see Differences in Instance Management for details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_update_integration_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  integration_instance_type varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  is_byol number,
  message_packs number,
  is_file_server_enabled number,
  is_visual_builder_enabled number,
  custom_endpoint dbms_cloud_oci_integration_update_custom_endpoint_details_t,
  alternate_custom_endpoints dbms_cloud_oci_integration_update_custom_endpoint_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_update_integration_instance_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_update_integration_instance_details_t (
    display_name varchar2,
    integration_instance_type varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    is_byol number,
    message_packs number,
    is_file_server_enabled number,
    is_visual_builder_enabled number,
    custom_endpoint dbms_cloud_oci_integration_update_custom_endpoint_details_t,
    alternate_custom_endpoints dbms_cloud_oci_integration_update_custom_endpoint_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Integration Instance Identifier.

integration_instance_type

(optional) Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX

Allowed values are: 'STANDARD', 'ENTERPRISE', 'STANDARDX', 'ENTERPRISEX'

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

is_byol

(optional) Bring your own license.

message_packs

(optional) The number of configured message packs

is_file_server_enabled

(optional) The file server is enabled or not.

is_visual_builder_enabled

(optional) Visual Builder is enabled or not.

custom_endpoint

(optional)

alternate_custom_endpoints

(optional) A list of alternate custom endpoints to be used for the integration instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance).

DBMS_CLOUD_OCI_INTEGRATION_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request is affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'STOPPED', 'STARTED', 'DELETED', 'IN_PROGRESS'

identifier

(required) The identifier of the resource the work request affects.

entity_uri

(optional) The URI path that the user can do a GET on to access the resource metadata.

DBMS_CLOUD_OCI_INTEGRATION_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_integration_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_integration_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_INTEGRATION_WORK_REQUEST_T Type

A description of work request status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_integration_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_integration_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_INTEGRATION_INSTANCE', 'UPDATE_INTEGRATION_INSTANCE', 'STOP_INTEGRATION_INSTANCE', 'START_INTEGRATION_INSTANCE', 'DELETE_INTEGRATION_INSTANCE', 'CHANGE_PRIVATE_ENDPOINT_OUTBOUND_CONNECTION', 'ENABLE_PROCESS_AUTOMATION'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_INTEGRATION_WORK_REQUEST_ERROR_T Type

Errors related to a specific work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing

message

(required) A human-readable error string.

l_timestamp

(required) The date and time the error occurred.

DBMS_CLOUD_OCI_INTEGRATION_WORK_REQUEST_LOG_ENTRY_T Type

Log entries related to a specific work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) The description of an action that occurred.

l_timestamp

(required) The date and time the log entry occurred.

DBMS_CLOUD_OCI_INTEGRATION_WORK_REQUEST_SUMMARY_T Type

A description of work request status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_integration_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_integration_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_integration_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_integration_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_INTEGRATION_INSTANCE', 'UPDATE_INTEGRATION_INSTANCE', 'STOP_INTEGRATION_INSTANCE', 'START_INTEGRATION_INSTANCE', 'DELETE_INTEGRATION_INSTANCE', 'CHANGE_PRIVATE_ENDPOINT_OUTBOUND_CONNECTION', 'ENABLE_PROCESS_AUTOMATION'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

Was this article helpful?