ODA Common Types
DBMS_CLOUD_OCI_ODA_VARCHAR2_TBL Type
Nested table type of varchar2(32767).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_CHANNEL_T Type
Properties of a Channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_channel_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
description varchar2(32767),
category varchar2(32767),
l_type varchar2(32767),
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Channel was created. |
|
|
(required) The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(optional) A short description of the Channel. |
|
|
(required) The category of the Channel. Allowed values are: 'AGENT', 'APPLICATION', 'BOT', 'BOT_AS_AGENT', 'SYSTEM', 'EVENT' |
|
|
(required) The Channel type. Allowed values are: 'ANDROID', 'APPEVENT', 'APPLICATION', 'CORTANA', 'FACEBOOK', 'IOS', 'MSTEAMS', 'OSS', 'OSVC', 'SERVICECLOUD', 'SLACK', 'TEST', 'TWILIO', 'WEB', 'WEBHOOK' |
|
|
(optional) The number of milliseconds before a session expires. |
|
|
(required) The Channel's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_ANDROID_CHANNEL_T Type
The configuration for an Android channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_android_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_android_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_android_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_android_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_APP_EVENT_CHANNEL_T Type
The configuration for an Application Event channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_app_event_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
outbound_url varchar2(32767),
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_app_event_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_app_event_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_app_event_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The URL for sending errors and responses to. |
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_APPLICATION_CHANNEL_T Type
The configuration for an Application channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_application_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
outbound_url varchar2(32767),
is_authenticated_user_id number,
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_application_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_application_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
is_authenticated_user_id number,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_application_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The URL to send response and error messages to. |
|
|
(required) True if the user id in the AIC message should be treated as an authenticated user id. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_AUTHENTICATION_PROVIDER_T Type
Settings for the Authentication Provider.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_authentication_provider_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
grant_type varchar2(32767),
identity_provider varchar2(32767),
name varchar2(32767),
token_endpoint_url varchar2(32767),
authorization_endpoint_url varchar2(32767),
short_authorization_code_request_url varchar2(32767),
revoke_token_endpoint_url varchar2(32767),
client_id varchar2(32767),
scopes varchar2(32767),
subject_claim varchar2(32767),
refresh_token_retention_period_in_days number,
redirect_url varchar2(32767),
is_visible number,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_authentication_provider_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_authentication_provider_t (
id varchar2,
grant_type varchar2,
identity_provider varchar2,
name varchar2,
token_endpoint_url varchar2,
authorization_endpoint_url varchar2,
short_authorization_code_request_url varchar2,
revoke_token_endpoint_url varchar2,
client_id varchar2,
scopes varchar2,
subject_claim varchar2,
refresh_token_retention_period_in_days number,
redirect_url varchar2,
is_visible number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Authentication Provider was created. |
|
|
(required) The grant type for the Authentication Provider. Allowed values are: 'CLIENT_CREDENTIALS', 'AUTHORIZATION_CODE' |
|
|
(required) Which type of Identity Provider (IDP) you are using. Allowed values are: 'GENERIC', 'OAM', 'GOOGLE', 'MICROSOFT' |
|
|
(required) A name to identify the Authentication Provider. |
|
|
(required) The IDPs URL for requesting access tokens. |
|
|
(optional) The IDPs URL for the page that users authenticate with by entering the user name and password. |
|
|
(optional) A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. |
|
|
(optional) If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service. |
|
|
(required) The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID. |
|
|
(required) A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that’s necessary to get the refresh token (typically offline_access). |
|
|
(optional) The access-token profile claim to use to identify the user. |
|
|
(optional) The number of days to keep the refresh token in the Digital Assistant cache. |
|
|
(optional) The OAuth Redirect URL. |
|
|
(required) Whether this Authentication Provider is visible in the ODA UI. |
|
|
(required) The Authentication Provider's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_AUTHENTICATION_PROVIDER_SUMMARY_T Type
Summary of the Authentication Provider.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_authentication_provider_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
grant_type varchar2(32767),
identity_provider varchar2(32767),
name varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_authentication_provider_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_authentication_provider_summary_t (
id varchar2,
grant_type varchar2,
identity_provider varchar2,
name varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Authentication Provider was created. |
|
|
(required) The grant type for the Authentication Provider. Allowed values are: 'CLIENT_CREDENTIALS', 'AUTHORIZATION_CODE' |
|
|
(required) Which type of Identity Provider (IDP) you are using. Allowed values are: 'GENERIC', 'OAM', 'GOOGLE', 'MICROSOFT' |
|
|
(required) A name to identify the Authentication Provider. |
|
|
(required) The Authentication Provider's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_AUTHENTICATION_PROVIDER_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_authentication_provider_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_authentication_provider_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_authentication_provider_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_AUTHENTICATION_PROVIDER_COLLECTION_T Type
A collection of Authentication Provider summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_authentication_provider_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_authentication_provider_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_authentication_provider_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_authentication_provider_collection_t (
items dbms_cloud_oci_oda_authentication_provider_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Authentication Provider summaries. |
DBMS_CLOUD_OCI_ODA_BOT_T Type
Metadata for a Bot resource.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_bot_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
version varchar2(32767),
display_name varchar2(32767),
category varchar2(32767),
description varchar2(32767),
namespace varchar2(32767),
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
platform_version varchar2(32767),
base_id varchar2(32767),
multilingual_mode varchar2(32767),
primary_language_tag varchar2(32767),
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_bot_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_bot_t (
id varchar2,
name varchar2,
version varchar2,
display_name varchar2,
category varchar2,
description varchar2,
namespace varchar2,
lifecycle_state varchar2,
lifecycle_details varchar2,
platform_version varchar2,
base_id varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the resource was created. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's category. This is used to group resource's together. |
|
|
(optional) A short description of the resource. |
|
|
(optional) The resource's namespace. |
|
|
(required) The resource's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) The resource's publish state. Allowed values are: 'PUBLISHED', 'DRAFT' |
|
|
(required) The ODA Platform Version for this resource. |
|
|
(optional) The unique identifier for the base reource (when this resource extends another). |
|
|
(optional) The multilingual mode for the resource. Allowed values are: 'NATIVE', 'TRANSLATION' |
|
|
(optional) The primary language for the resource. |
|
|
(optional) A list of native languages supported by this resource. |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CHANGE_ODA_INSTANCE_COMPARTMENT_DETAILS_T Type
Properties required to move a Digital Assistant instance from one compartment to another.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_change_oda_instance_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_change_oda_instance_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_change_oda_instance_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Identifier of the compartment into which the Digital Assistant instance should be moved. |
DBMS_CLOUD_OCI_ODA_CHANGE_ODA_PRIVATE_ENDPOINT_COMPARTMENT_DETAILS_T Type
Properties required to move an ODA Private Endpoint from one compartment to another.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_change_oda_private_endpoint_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_change_oda_private_endpoint_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_change_oda_private_endpoint_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment that the ODA private endpoint belongs to. |
DBMS_CLOUD_OCI_ODA_CHANNEL_SUMMARY_T Type
Summary of the Channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_channel_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
description varchar2(32767),
category varchar2(32767),
l_type varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_channel_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_channel_summary_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Channel was created. |
|
|
(required) The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(optional) A short description of the Channel. |
|
|
(required) The category of the Channel. Allowed values are: 'AGENT', 'APPLICATION', 'BOT', 'BOT_AS_AGENT', 'SYSTEM', 'EVENT' |
|
|
(required) The Channel type. Allowed values are: 'ANDROID', 'APPEVENT', 'APPLICATION', 'CORTANA', 'FACEBOOK', 'IOS', 'MSTEAMS', 'OSS', 'OSVC', 'SERVICECLOUD', 'SLACK', 'TEST', 'TWILIO', 'WEB', 'WEBHOOK' |
|
|
(required) The Channel's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CHANNEL_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_channel_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_channel_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_channel_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_CHANNEL_COLLECTION_T Type
A collection of Channel summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_channel_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_channel_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_channel_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_channel_collection_t (
items dbms_cloud_oci_oda_channel_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Channel summaries. |
DBMS_CLOUD_OCI_ODA_CREATE_DIGITAL_ASSISTANT_DETAILS_T Type
Properties that are required to create a Digital Assistant.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_digital_assistant_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
kind varchar2(32767),
category varchar2(32767),
description varchar2(32767),
platform_version varchar2(32767),
multilingual_mode varchar2(32767),
primary_language_tag varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_digital_assistant_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_digital_assistant_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(required) How to create the Digital Assistant. Allowed values are: 'NEW', 'CLONE', 'VERSION', 'EXTEND' |
|
|
(optional) The resource's category. This is used to group resource's together. |
|
|
(optional) A short description of the resource. |
|
|
(optional) The ODA Platform Version for this resource. |
|
|
(optional) The multilingual mode for the resource. Allowed values are: 'NATIVE', 'TRANSLATION' |
|
|
(optional) The primary language for the resource. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CLONE_DIGITAL_ASSISTANT_DETAILS_T Type
Properties that are required to create a new Digital Assistant by cloning an existing Digital Assistant.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_clone_digital_assistant_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_digital_assistant_details_t (
id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_clone_digital_assistant_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_clone_digital_assistant_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
id varchar2,
name varchar2,
display_name varchar2,
version varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_clone_digital_assistant_details_t is a subtype of the dbms_cloud_oci_oda_create_digital_assistant_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The unique identifier of the Digital Assistant to clone. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
DBMS_CLOUD_OCI_ODA_CREATE_SKILL_DETAILS_T Type
Properties that are required to create a Skill.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_skill_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
kind varchar2(32767),
category varchar2(32767),
description varchar2(32767),
platform_version varchar2(32767),
multilingual_mode varchar2(32767),
primary_language_tag varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_skill_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_skill_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(required) How to create the Skill. Allowed values are: 'NEW', 'CLONE', 'VERSION', 'EXTEND' |
|
|
(optional) The resource's category. This is used to group resource's together. |
|
|
(optional) A short description of the resource. |
|
|
(optional) The ODA Platform Version for this resource. |
|
|
(optional) The multilingual mode for the resource. Allowed values are: 'NATIVE', 'TRANSLATION' |
|
|
(optional) The primary language for the resource. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CLONE_SKILL_DETAILS_T Type
Properties that are required to create a new Skill by cloning an existing Skill.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_clone_skill_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_skill_details_t (
id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_clone_skill_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_clone_skill_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
id varchar2,
name varchar2,
display_name varchar2,
version varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_clone_skill_details_t is a subtype of the dbms_cloud_oci_oda_create_skill_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The unique identifier of the Skill to clone. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_PARAMETER_VALUE_T Type
Properties for configuring a Parameter in a Digital Assistant instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_parameter_value_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
l_type varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_value_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_value_t (
name varchar2,
l_type varchar2,
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Parameter name. This must be unique within the parent resource. |
|
|
(required) The value type. Allowed values are: 'STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'SECURE' |
|
|
(required) The current value. The value will be interpreted based on the `type`. |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_PARAMETER_VALUE_TBL Type
Nested table type of dbms_cloud_oci_oda_digital_assistant_parameter_value_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_parameter_value_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_digital_assistant_parameter_value_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_CONFIGURE_DIGITAL_ASSISTANT_PARAMETERS_DETAILS_T Type
Properties for configuring the Digital Assistant Parameters in a Digital Assistant instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_configure_digital_assistant_parameters_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
parameters dbms_cloud_oci_oda_digital_assistant_parameter_value_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_configure_digital_assistant_parameters_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_configure_digital_assistant_parameters_details_t (
parameters dbms_cloud_oci_oda_digital_assistant_parameter_value_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The values to use to configure the Digital Assistant Parameters. |
DBMS_CLOUD_OCI_ODA_CORTANA_CHANNEL_T Type
The configuration for a Cortana channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_cortana_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
msa_app_id varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_cortana_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_cortana_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_cortana_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_CHANNEL_DETAILS_T Type
Properties that are required to create a Channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_channel_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(required) The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(optional) A short description of the Channel. |
|
|
(required) The Channel type. Allowed values are: 'ANDROID', 'APPEVENT', 'APPLICATION', 'CORTANA', 'FACEBOOK', 'IOS', 'MSTEAMS', 'OSS', 'OSVC', 'SERVICECLOUD', 'SLACK', 'TEST', 'TWILIO', 'WEB', 'WEBHOOK' |
|
|
(optional) The number of milliseconds before a session expires. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CREATE_ANDROID_CHANNEL_DETAILS_T Type
Properties required to create an Android channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_android_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_android_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_android_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_android_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_CHANNEL_RESULT_T Type
Properties of a Channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_channel_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
description varchar2(32767),
category varchar2(32767),
l_type varchar2(32767),
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Channel was created. |
|
|
(required) The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(optional) A short description of the Channel. |
|
|
(required) The category of the Channel. Allowed values are: 'AGENT', 'APPLICATION', 'BOT', 'BOT_AS_AGENT', 'SYSTEM', 'EVENT' |
|
|
(required) The Channel type. Allowed values are: 'ANDROID', 'APPEVENT', 'APPLICATION', 'CORTANA', 'FACEBOOK', 'IOS', 'MSTEAMS', 'OSS', 'OSVC', 'SERVICECLOUD', 'SLACK', 'TEST', 'TWILIO', 'WEB', 'WEBHOOK' |
|
|
(optional) The number of milliseconds before a session expires. |
|
|
(required) The Channel's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CREATE_ANDROID_CHANNEL_RESULT_T Type
The configuration for an Android channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_android_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
secret_key varchar2(32767),
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_android_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_android_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
secret_key varchar2,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_android_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key. |
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_APP_EVENT_CHANNEL_DETAILS_T Type
Properties required to create an Application Event channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_app_event_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
outbound_url varchar2(32767),
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_app_event_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_app_event_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_app_event_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The URL for sending errors and responses to. |
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_APP_EVENT_CHANNEL_RESULT_T Type
The configuration for an Application Event channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_app_event_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
secret_key varchar2(32767),
outbound_url varchar2(32767),
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_app_event_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_app_event_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
secret_key varchar2,
outbound_url varchar2,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_app_event_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key. |
|
|
(required) The URL for sending errors and responses to. |
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_APPLICATION_CHANNEL_DETAILS_T Type
Properties required to create an Application channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_application_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
outbound_url varchar2(32767),
is_authenticated_user_id number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_application_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_application_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
is_authenticated_user_id number
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_application_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The URL to send response and error messages to. |
|
|
(required) True if the user id in the AIC message should be treated as an authenticated user id. |
DBMS_CLOUD_OCI_ODA_CREATE_APPLICATION_CHANNEL_RESULT_T Type
The configuration for an Application channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_application_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
secret_key varchar2(32767),
outbound_url varchar2(32767),
is_authenticated_user_id number,
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_application_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_application_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
secret_key varchar2,
outbound_url varchar2,
is_authenticated_user_id number,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_application_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key. |
|
|
(optional) The URL to send response and error messages to. |
|
|
(required) True if the user id in the AIC message should be treated as an authenticated user id. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_AUTHENTICATION_PROVIDER_DETAILS_T Type
Properties required to create a new Authentication Provider.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_authentication_provider_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
grant_type varchar2(32767),
identity_provider varchar2(32767),
name varchar2(32767),
token_endpoint_url varchar2(32767),
authorization_endpoint_url varchar2(32767),
short_authorization_code_request_url varchar2(32767),
revoke_token_endpoint_url varchar2(32767),
client_id varchar2(32767),
client_secret varchar2(32767),
scopes varchar2(32767),
subject_claim varchar2(32767),
refresh_token_retention_period_in_days number,
redirect_url varchar2(32767),
is_visible number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_authentication_provider_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_authentication_provider_details_t (
grant_type varchar2,
identity_provider varchar2,
name varchar2,
token_endpoint_url varchar2,
authorization_endpoint_url varchar2,
short_authorization_code_request_url varchar2,
revoke_token_endpoint_url varchar2,
client_id varchar2,
client_secret varchar2,
scopes varchar2,
subject_claim varchar2,
refresh_token_retention_period_in_days number,
redirect_url varchar2,
is_visible number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The grant type for the Authentication Provider. Allowed values are: 'CLIENT_CREDENTIALS', 'AUTHORIZATION_CODE' |
|
|
(required) Which type of Identity Provider (IDP) you are using. Allowed values are: 'GENERIC', 'OAM', 'GOOGLE', 'MICROSOFT' |
|
|
(required) A name to identify the Authentication Provider. |
|
|
(required) The IDPs URL for requesting access tokens. |
|
|
(optional) The IDPs URL for the page that users authenticate with by entering the user name and password. |
|
|
(optional) A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. |
|
|
(optional) If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service. |
|
|
(required) The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID. |
|
|
(required) The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret. |
|
|
(required) A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that’s necessary to get the refresh token (typically offline_access). |
|
|
(optional) The access-token profile claim to use to identify the user. |
|
|
(optional) The number of days to keep the refresh token in the Digital Assistant cache. |
|
|
(optional) The OAuth Redirect URL. |
|
|
(optional) Whether this Authentication Provider is visible in the ODA UI. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CREATE_CORTANA_CHANNEL_DETAILS_T Type
Properties required to create a Cortana channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_cortana_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
msa_app_id varchar2(32767),
msa_app_password varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_cortana_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_cortana_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
msa_app_password varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_cortana_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(required) The client secret that you obtained from your bot registration. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_CORTANA_CHANNEL_RESULT_T Type
The configuration for a Cortana channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_cortana_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
msa_app_id varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_cortana_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_cortana_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_cortana_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_DIGITAL_ASSISTANT_VERSION_DETAILS_T Type
Properties that are required to create a new version of an existing Digital Assistant.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_digital_assistant_version_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_digital_assistant_details_t (
id varchar2(32767),
version varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_digital_assistant_version_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_digital_assistant_version_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
id varchar2,
version varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_digital_assistant_version_details_t is a subtype of the dbms_cloud_oci_oda_create_digital_assistant_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The unique identifier of the Digital Assistant to create a new version of. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
DBMS_CLOUD_OCI_ODA_CREATE_FACEBOOK_CHANNEL_DETAILS_T Type
Properties required to create a Facebook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_facebook_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
app_secret varchar2(32767),
page_access_token varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_facebook_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_facebook_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
app_secret varchar2,
page_access_token varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_facebook_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The app secret for your Facebook app. |
|
|
(required) The page access token that you generated for your Facebook page. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_FACEBOOK_CHANNEL_RESULT_T Type
The configuration for a Facebook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_facebook_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
verify_token varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_facebook_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_facebook_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
verify_token varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_facebook_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Facebook verify token. This is used by Facebook when verifying the webhook channel. This is only returned this once. If it is lost the keys will need to be rotated to generate a new verify token. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_IMPORTED_PACKAGE_DETAILS_T Type
Payload for creating an imported package
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_imported_package_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
current_package_id varchar2(32767),
parameter_values json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_imported_package_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_imported_package_details_t (
current_package_id varchar2,
parameter_values json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) ID of the package to import. |
|
|
(optional) A list of parameter values to use when importing the given package. Must match those defined in the import contract. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CREATE_IOS_CHANNEL_DETAILS_T Type
Properties required to create an iOS channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_ios_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ios_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ios_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_ios_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_IOS_CHANNEL_RESULT_T Type
The configuration for an iOS channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_ios_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
secret_key varchar2(32767),
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ios_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ios_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
secret_key varchar2,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_ios_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key. |
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_MS_TEAMS_CHANNEL_DETAILS_T Type
Properties required to create an MS Teams channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_ms_teams_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
msa_app_id varchar2(32767),
msa_app_password varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ms_teams_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ms_teams_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
msa_app_password varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_ms_teams_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(required) The client secret that you obtained from your bot registration. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_MS_TEAMS_CHANNEL_RESULT_T Type
The configuration for an MS Teams channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_ms_teams_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
msa_app_id varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ms_teams_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_ms_teams_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_ms_teams_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_NEW_DIGITAL_ASSISTANT_DETAILS_T Type
Properties that are required to create a Digital Assistant from scratch.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_new_digital_assistant_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_digital_assistant_details_t (
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_new_digital_assistant_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_new_digital_assistant_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
name varchar2,
display_name varchar2,
version varchar2,
native_language_tags dbms_cloud_oci_oda_varchar2_tbl
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_new_digital_assistant_details_t is a subtype of the dbms_cloud_oci_oda_create_digital_assistant_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
|
|
(optional) A list of native languages supported by this resource. |
DBMS_CLOUD_OCI_ODA_CREATE_NEW_SKILL_DETAILS_T Type
Properties that are required to create a Skill from scratch.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_new_skill_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_skill_details_t (
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_new_skill_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_new_skill_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
name varchar2,
display_name varchar2,
version varchar2,
native_language_tags dbms_cloud_oci_oda_varchar2_tbl
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_new_skill_details_t is a subtype of the dbms_cloud_oci_oda_create_skill_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's display name. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
|
|
(optional) A list of native languages supported by this resource. |
DBMS_CLOUD_OCI_ODA_CREATE_OSS_CHANNEL_DETAILS_T Type
Properties required to create an Oracle Streaming Service (OSS) channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_oss_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2(32767),
outbound_message_topic varchar2(32767),
bootstrap_servers varchar2(32767),
security_protocol varchar2(32767),
sasl_mechanism varchar2(32767),
tenancy_name varchar2(32767),
user_name varchar2(32767),
stream_pool_id varchar2(32767),
auth_token varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oss_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oss_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2,
outbound_message_topic varchar2,
bootstrap_servers varchar2,
security_protocol varchar2,
sasl_mechanism varchar2,
tenancy_name varchar2,
user_name varchar2,
stream_pool_id varchar2,
auth_token varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_oss_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
|
|
(required) The topic inbound messages are received on. |
|
|
(required) The topic outbound messages are sent on. |
|
|
(required) The Oracle Streaming Service bootstrap servers. |
|
|
(required) The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(required) The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(required) The tenancy to use when connecting to the Oracle Streaming Service. |
|
|
(required) The user name to use when connecting to the Oracle Streaming Service. |
|
|
(required) The stream pool OCI to use when connecting to the Oracle Streaming Service. |
|
|
(required) The authentication token to use when connecting to the Oracle Streaming Service. |
DBMS_CLOUD_OCI_ODA_CREATE_OSS_CHANNEL_RESULT_T Type
The configuration for an Oracle Streaming Service (OSS) channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_oss_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2(32767),
outbound_message_topic varchar2(32767),
bootstrap_servers varchar2(32767),
security_protocol varchar2(32767),
sasl_mechanism varchar2(32767),
tenancy_name varchar2(32767),
user_name varchar2(32767),
stream_pool_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oss_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oss_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2,
outbound_message_topic varchar2,
bootstrap_servers varchar2,
security_protocol varchar2,
sasl_mechanism varchar2,
tenancy_name varchar2,
user_name varchar2,
stream_pool_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_oss_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
|
|
(required) The topic inbound messages are received on. |
|
|
(required) The topic outbound messages are sent on. |
|
|
(required) The Oracle Streaming Service bootstrap servers. |
|
|
(required) The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(required) The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(required) The tenancy to use when connecting to the Oracle Streaming Service. |
|
|
(required) The user name to use when connecting to the Oracle Streaming Service. |
|
|
(required) The stream pool OCI to use when connecting to the Oracle Streaming Service. |
DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_ATTACHMENT_OWNER_T Type
Details about an attachment owner
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_attachment_owner_t FORCE AUTHID CURRENT_USER IS OBJECT (
owner_service_name varchar2(32767),
owner_service_tenancy varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_owner_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_owner_t (
owner_service_name varchar2,
owner_service_tenancy varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Name of the owner service principal |
|
|
(required) Tenancy OCID of the owner service principal |
DBMS_CLOUD_OCI_ODA_CREATE_ODA_INSTANCE_ATTACHMENT_DETAILS_T Type
Properties required to create an ODA instance attachment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_oda_instance_attachment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
attach_to_id varchar2(32767),
attachment_type varchar2(32767),
attachment_metadata varchar2(32767),
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_attachment_owner_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_instance_attachment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_instance_attachment_details_t (
attach_to_id varchar2,
attachment_type varchar2,
attachment_metadata varchar2,
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_attachment_owner_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this ODA instance is being attached. |
|
|
(required) The type of target instance which this ODA instance is being attached. Allowed values are: 'FUSION' |
|
|
(optional) Attachment specific metadata. Defined by the target service. |
|
|
(optional) List of operations that are restricted while this instance is attached. |
|
|
(required) |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CREATE_ODA_INSTANCE_DETAILS_T Type
Properties that are required to create a Digital Assistant instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_oda_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
shape_name varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
is_role_based_access number,
identity_domain varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_instance_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_instance_details_t (
display_name varchar2,
description varchar2,
compartment_id varchar2,
shape_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
is_role_based_access number,
identity_domain varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. |
|
|
(optional) Description of the Digital Assistant instance. |
|
|
(required) Identifier of the compartment. |
|
|
(required) Shape or size of the instance. Allowed values are: 'DEVELOPMENT', 'PRODUCTION' |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
|
(optional) Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) |
|
|
(optional) If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. |
DBMS_CLOUD_OCI_ODA_CREATE_ODA_PRIVATE_ENDPOINT_ATTACHMENT_DETAILS_T Type
Properties that are required to create an ODA private endpoint attachment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_oda_private_endpoint_attachment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
oda_instance_id varchar2(32767),
oda_private_endpoint_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_private_endpoint_attachment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_private_endpoint_attachment_details_t (
oda_instance_id varchar2,
oda_private_endpoint_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_CREATE_ODA_PRIVATE_ENDPOINT_DETAILS_T Type
Properties that can be specified to create an ODA private endpoint.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_oda_private_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
subnet_id varchar2(32767),
nsg_ids dbms_cloud_oci_oda_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_private_endpoint_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_private_endpoint_details_t (
display_name varchar2,
description varchar2,
compartment_id varchar2,
subnet_id varchar2,
nsg_ids dbms_cloud_oci_oda_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value. |
|
|
(optional) Description of the ODA private endpoint. |
|
|
(required) The OCID of the compartment that the ODA private endpoint belongs to. |
|
|
(required) The OCID of the subnet that the private endpoint belongs to. |
|
|
(optional) List of OCIDs of network security groups |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_SCAN_LISTENER_INFO_T Type
Customer's Real Application Cluster (RAC)'s SCAN listener FQDN, port or list IPs and their ports.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_scan_listener_info_t FORCE AUTHID CURRENT_USER IS OBJECT (
scan_listener_fqdn varchar2(32767),
scan_listener_ip varchar2(32767),
scan_listener_port number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_scan_listener_info_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_scan_listener_info_t (
scan_listener_fqdn varchar2,
scan_listener_ip varchar2,
scan_listener_port number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) FQDN of the customer's Real Application Cluster (RAC)'s SCAN listeners. |
|
|
(optional) A SCAN listener's IP of the customer's Real Application Cluster (RAC). |
|
|
(optional) The port that customer's Real Application Cluster (RAC)'s SCAN listeners are listening on. |
DBMS_CLOUD_OCI_ODA_SCAN_LISTENER_INFO_TBL Type
Nested table type of dbms_cloud_oci_oda_scan_listener_info_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_scan_listener_info_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_scan_listener_info_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_CREATE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY_DETAILS_T Type
Properties that are required to create an ODA Private Endpoint Scan Proxy.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_oda_private_endpoint_scan_proxy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
scan_listener_type varchar2(32767),
protocol varchar2(32767),
scan_listener_infos dbms_cloud_oci_oda_scan_listener_info_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_private_endpoint_scan_proxy_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_oda_private_endpoint_scan_proxy_details_t (
scan_listener_type varchar2,
protocol varchar2,
scan_listener_infos dbms_cloud_oci_oda_scan_listener_info_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Type indicating whether Scan listener is specified by its FQDN or list of IPs |
|
|
(required) The protocol used for communication between client, scanProxy and RAC's scan listeners |
|
|
(required) The FQDN/IPs and port information of customer's Real Application Cluster (RAC)'s SCAN listeners. |
DBMS_CLOUD_OCI_ODA_CREATE_OSVC_CHANNEL_DETAILS_T Type
Properties required to create an OSVC channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_osvc_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
host varchar2(32767),
port varchar2(32767),
user_name varchar2(32767),
password varchar2(32767),
total_session_count number,
channel_service varchar2(32767),
authentication_provider_name varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_osvc_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_osvc_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
host varchar2,
port varchar2,
user_name varchar2,
password varchar2,
total_session_count number,
channel_service varchar2,
authentication_provider_name varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_osvc_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. |
|
|
(required) The port. |
|
|
(required) The user name for the digital-assistant agent. |
|
|
(required) The password for the digital-assistant agent. |
|
|
(required) The total session count. |
|
|
(optional) The type of OSVC service. Allowed values are: 'OSVC', 'FUSION' |
|
|
(required) The name of the Authentication Provider to use to authenticate the user. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_OSVC_CHANNEL_RESULT_T Type
The configuration for an OSVC channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_osvc_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
host varchar2(32767),
port varchar2(32767),
user_name varchar2(32767),
total_session_count number,
channel_service varchar2(32767),
authentication_provider_name varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_osvc_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_osvc_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
host varchar2,
port varchar2,
user_name varchar2,
total_session_count number,
channel_service varchar2,
authentication_provider_name varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_osvc_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. |
|
|
(required) The port. |
|
|
(required) The user name for the digital-assistant agent. |
|
|
(required) The total session count. |
|
|
(required) The type of OSVC service. Allowed values are: 'OSVC', 'FUSION' |
|
|
(required) The name of the Authentication Provider to use to authenticate the user. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_SERVICE_CLOUD_CHANNEL_DETAILS_T Type
Properties required to create an Service Cloud channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_service_cloud_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
domain_name varchar2(32767),
host_name_prefix varchar2(32767),
user_name varchar2(32767),
password varchar2(32767),
client_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_service_cloud_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_service_cloud_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
domain_name varchar2,
host_name_prefix varchar2,
user_name varchar2,
password varchar2,
client_type varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_service_cloud_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(required) The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(required) The user name for an Oracle B2C Service staff member who has the necessary profile permissions. |
|
|
(required) The password for the Oracle B2C Service staff member who has the necessary profile permissions. |
|
|
(required) The type of Service Cloud client. Allowed values are: 'WSDL', 'REST' |
DBMS_CLOUD_OCI_ODA_CREATE_SERVICE_CLOUD_CHANNEL_RESULT_T Type
The configuration for a Service Cloud agent channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_service_cloud_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
domain_name varchar2(32767),
host_name_prefix varchar2(32767),
user_name varchar2(32767),
client_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_service_cloud_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_service_cloud_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
domain_name varchar2,
host_name_prefix varchar2,
user_name varchar2,
client_type varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_service_cloud_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(required) The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(required) The user name for an Oracle B2C Service staff member who has the necessary profile permissions. |
|
|
(required) The type of Service Cloud client. Allowed values are: 'WSDL', 'REST' |
DBMS_CLOUD_OCI_ODA_CREATE_SKILL_PARAMETER_DETAILS_T Type
Properties that are required to create a Skill Parameter.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_skill_parameter_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_skill_parameter_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_skill_parameter_details_t (
name varchar2,
display_name varchar2,
description varchar2,
l_type varchar2,
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Parameter name. This must be unique within the parent resource. |
|
|
(required) The display name for the Parameter. |
|
|
(optional) A description of the Parameter. |
|
|
(required) The value type. Allowed values are: 'STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'SECURE' |
|
|
(required) The current value. The value will be interpreted based on the `type`. |
DBMS_CLOUD_OCI_ODA_CREATE_SKILL_VERSION_DETAILS_T Type
Properties that are required to create a new version of an existing Skill.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_skill_version_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_skill_details_t (
id varchar2(32767),
version varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_skill_version_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_skill_version_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
id varchar2,
version varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_skill_version_details_t is a subtype of the dbms_cloud_oci_oda_create_skill_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The unique identifier of the Skill to create a new version of. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
DBMS_CLOUD_OCI_ODA_CREATE_SLACK_CHANNEL_DETAILS_T Type
Properties required to create a Slack channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_slack_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
client_id varchar2(32767),
auth_success_url varchar2(32767),
auth_error_url varchar2(32767),
signing_secret varchar2(32767),
client_secret varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_slack_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_slack_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
client_id varchar2,
auth_success_url varchar2,
auth_error_url varchar2,
signing_secret varchar2,
client_secret varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_slack_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Slack Client Id for the Slack app. |
|
|
(optional) The URL to redirect to when authentication is successful. |
|
|
(optional) The URL to redirect to when authentication is unsuccessful. |
|
|
(required) The Signing Secret for the Slack App. |
|
|
(required) The Client Secret for the Slack App. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_SLACK_CHANNEL_RESULT_T Type
The configuration for a Slack channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_slack_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
client_id varchar2(32767),
auth_success_url varchar2(32767),
auth_error_url varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_slack_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_slack_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
client_id varchar2,
auth_success_url varchar2,
auth_error_url varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_slack_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Slack Client Id for the Slack app. |
|
|
(optional) The URL to redirect to when authentication is successful. |
|
|
(optional) The URL to redirect to when authentication is unsuccessful. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_TEST_CHANNEL_RESULT_T Type
The configuration for the Test channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_test_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
secret_key varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_test_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_test_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
secret_key varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_test_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_TRANSLATOR_DETAILS_T Type
Properties that are required to create a Translator.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_translator_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
l_type varchar2(32767),
base_url varchar2(32767),
auth_token varchar2(32767),
properties json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_translator_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_translator_details_t (
l_type varchar2,
base_url varchar2,
auth_token varchar2,
properties json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Translation Service to use for this Translator. Allowed values are: 'GOOGLE', 'MICROSOFT' |
|
|
(required) The base URL for invoking the Translation Service. |
|
|
(required) The authentication token to use when invoking the Translation Service |
|
|
(optional) Properties used when invoking the translation service. Each property is a simple key-value pair. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_CREATE_TWILIO_CHANNEL_DETAILS_T Type
Properties required to create a Twilio channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_twilio_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
account_sid varchar2(32767),
phone_number varchar2(32767),
auth_token varchar2(32767),
is_mms_enabled number,
original_connectors_url varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_twilio_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_twilio_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
account_sid varchar2,
phone_number varchar2,
auth_token varchar2,
is_mms_enabled number,
original_connectors_url varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_twilio_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Account SID for the Twilio number. |
|
|
(required) The Twilio phone number. |
|
|
(required) The Auth Token for the Twilio number. |
|
|
(required) Whether MMS is enabled for this channel or not. |
|
|
(optional) The original connectors URL (used for backward compatibility). |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_TWILIO_CHANNEL_RESULT_T Type
The configuration for a Twilio channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_twilio_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
account_sid varchar2(32767),
phone_number varchar2(32767),
is_mms_enabled number,
original_connectors_url varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_twilio_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_twilio_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
account_sid varchar2,
phone_number varchar2,
is_mms_enabled number,
original_connectors_url varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_twilio_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Account SID for the Twilio number. |
|
|
(required) The Twilio phone number. |
|
|
(required) Whether MMS is enabled for this channel or not. |
|
|
(optional) The original connectors URL (used for backward compatibility). |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_CREATE_WEB_CHANNEL_DETAILS_T Type
Properties required to create a Web channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_web_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_web_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_web_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_web_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_WEB_CHANNEL_RESULT_T Type
The configuration for a Web channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_web_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
secret_key varchar2(32767),
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_web_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_web_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
secret_key varchar2,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_web_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key. |
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_WEBHOOK_CHANNEL_DETAILS_T Type
Properties required to create a Webhook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_webhook_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_details_t (
outbound_url varchar2(32767),
payload_version varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_webhook_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_webhook_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
payload_version varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_webhook_channel_details_t is a subtype of the dbms_cloud_oci_oda_create_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The URL to send responses to. |
|
|
(required) The version for payloads. Allowed values are: '1.0', '1.1' |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_CREATE_WEBHOOK_CHANNEL_RESULT_T Type
The configuration for a Webhook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_create_webhook_channel_result_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_channel_result_t (
secret_key varchar2(32767),
outbound_url varchar2(32767),
payload_version varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_webhook_channel_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_create_webhook_channel_result_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
secret_key varchar2,
outbound_url varchar2,
payload_version varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_create_webhook_channel_result_t is a subtype of the dbms_cloud_oci_oda_create_channel_result_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key. |
|
|
(required) The URL to send responses to. |
|
|
(required) The version for payloads. Allowed values are: '1.0', '1.1' |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_RESOURCE_TYPE_DEFAULT_PARAMETER_VALUES_T Type
Default values needed to import a resource type for a package.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_resource_type_default_parameter_values_t FORCE AUTHID CURRENT_USER IS OBJECT (
resource_type varchar2(32767),
parameter_values json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_resource_type_default_parameter_values_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_resource_type_default_parameter_values_t (
resource_type varchar2,
parameter_values json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The type of resource to which these resourceType-specific parameter values apply |
|
|
(required) A list of parameter values used to import the package. |
DBMS_CLOUD_OCI_ODA_RESOURCE_TYPE_DEFAULT_PARAMETER_VALUES_TBL Type
Nested table type of dbms_cloud_oci_oda_resource_type_default_parameter_values_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_resource_type_default_parameter_values_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_resource_type_default_parameter_values_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_DEFAULT_PARAMETER_VALUES_T Type
Default values for parameters required to import a package
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_default_parameter_values_t FORCE AUTHID CURRENT_USER IS OBJECT (
resource_types_default_parameter_values dbms_cloud_oci_oda_resource_type_default_parameter_values_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_default_parameter_values_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_default_parameter_values_t (
resource_types_default_parameter_values dbms_cloud_oci_oda_resource_type_default_parameter_values_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A list of resource type specific default parameter values, one set for each resource type listed in the package definition. |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_T Type
Digital Assistant metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
version varchar2(32767),
display_name varchar2(32767),
category varchar2(32767),
description varchar2(32767),
namespace varchar2(32767),
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
platform_version varchar2(32767),
base_id varchar2(32767),
multilingual_mode varchar2(32767),
primary_language_tag varchar2(32767),
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_t (
id varchar2,
name varchar2,
version varchar2,
display_name varchar2,
category varchar2,
description varchar2,
namespace varchar2,
lifecycle_state varchar2,
lifecycle_details varchar2,
platform_version varchar2,
base_id varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the resource was created. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's category. This is used to group resource's together. |
|
|
(optional) A short description of the resource. |
|
|
(optional) The resource's namespace. |
|
|
(required) The resource's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) The resource's publish state. Allowed values are: 'PUBLISHED', 'DRAFT' |
|
|
(required) The ODA Platform Version for this resource. |
|
|
(optional) The unique identifier for the base reource (when this resource extends another). |
|
|
(optional) The multilingual mode for the resource. Allowed values are: 'NATIVE', 'TRANSLATION' |
|
|
(optional) The primary language for the resource. |
|
|
(optional) A list of native languages supported by this resource. |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_SUMMARY_T Type
Summary of a Digital Assistant.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
version varchar2(32767),
display_name varchar2(32767),
namespace varchar2(32767),
category varchar2(32767),
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
platform_version varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_summary_t (
id varchar2,
name varchar2,
version varchar2,
display_name varchar2,
namespace varchar2,
category varchar2,
lifecycle_state varchar2,
lifecycle_details varchar2,
platform_version varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the resource was created. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
|
|
(required) The resource's display name. |
|
|
(required) The resource's namespace. |
|
|
(required) The resource's category. This is used to group resource's together. |
|
|
(required) The resource's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) The resource's publish state. Allowed values are: 'PUBLISHED', 'DRAFT' |
|
|
(required) The ODA Platform Version for this resource. |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_digital_assistant_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_digital_assistant_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_COLLECTION_T Type
A collection of Digital Assistant summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_digital_assistant_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_collection_t (
items dbms_cloud_oci_oda_digital_assistant_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Digital Assistant summaries. |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_PARAMETER_T Type
Metadata for a Digital Assistant Parameter.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_parameter_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
value varchar2(32767),
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_t (
name varchar2,
display_name varchar2,
description varchar2,
l_type varchar2,
value varchar2,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Parameter name. This must be unique within the parent resource. |
|
|
(required) The display name for the Parameter. |
|
|
(optional) A description of the Parameter. |
|
|
(required) The value type. Allowed values are: 'STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'SECURE' |
|
|
(required) The current value. The value will be interpreted based on the `type`. |
|
|
(required) The Parameter's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_PARAMETER_SUMMARY_T Type
Metadata for a Digital Assistant Parameter property.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_parameter_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
value varchar2(32767),
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_summary_t (
name varchar2,
display_name varchar2,
description varchar2,
l_type varchar2,
value varchar2,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Parameter name. This must be unique within the parent resource. |
|
|
(required) The display name for the Parameter. |
|
|
(optional) A description of the Parameter. |
|
|
(required) The value type. Allowed values are: 'STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'SECURE' |
|
|
(optional) The current value. The value will be interpreted based on the `type`. |
|
|
(required) The Parameter's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_PARAMETER_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_digital_assistant_parameter_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_parameter_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_digital_assistant_parameter_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_DIGITAL_ASSISTANT_PARAMETER_COLLECTION_T Type
A collection of Digital Assistant Parameter summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_digital_assistant_parameter_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_digital_assistant_parameter_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_digital_assistant_parameter_collection_t (
items dbms_cloud_oci_oda_digital_assistant_parameter_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Digital Assistant Parameter summaries. |
DBMS_CLOUD_OCI_ODA_ERROR_BODY_T Type
Error Information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_error_body_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_error_body_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_error_body_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A short error code that defines the error, which is useful for programmatic parsing. |
|
|
(required) A human-readable error string. |
DBMS_CLOUD_OCI_ODA_STORAGE_LOCATION_T Type
Properties that point to a specific object in Object Storage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_storage_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
region_id varchar2(32767),
compartment_id varchar2(32767),
namespace_name varchar2(32767),
bucket_name varchar2(32767),
object_name varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_storage_location_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_storage_location_t (
region_id varchar2,
compartment_id varchar2,
namespace_name varchar2,
bucket_name varchar2,
object_name varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The region id. |
|
|
(required) The unique identifier for the compartment. |
|
|
(required) The Object Storage namespace. |
|
|
(required) The name of the bucket. |
|
|
(required) The name of the object. |
DBMS_CLOUD_OCI_ODA_EXPORT_BOT_DETAILS_T Type
Properties to export a Bot to Object Storage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_export_bot_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
target dbms_cloud_oci_oda_storage_location_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_export_bot_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_export_bot_details_t (
target dbms_cloud_oci_oda_storage_location_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) |
DBMS_CLOUD_OCI_ODA_EXPORT_DIGITAL_ASSISTANT_DETAILS_T Type
Properties that specify where in Object Storage to export the Digital Assistant to.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_export_digital_assistant_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
target dbms_cloud_oci_oda_storage_location_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_export_digital_assistant_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_export_digital_assistant_details_t (
target dbms_cloud_oci_oda_storage_location_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) |
DBMS_CLOUD_OCI_ODA_EXPORT_SKILL_DETAILS_T Type
Properties that specify where in Object Storage to export the Skill to.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_export_skill_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
target dbms_cloud_oci_oda_storage_location_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_export_skill_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_export_skill_details_t (
target dbms_cloud_oci_oda_storage_location_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) |
DBMS_CLOUD_OCI_ODA_EXTEND_DIGITAL_ASSISTANT_DETAILS_T Type
Properties that are required to create a new Digital Assistant by extending an existing Digital Assistant.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_extend_digital_assistant_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_digital_assistant_details_t (
id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_extend_digital_assistant_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_extend_digital_assistant_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
id varchar2,
name varchar2,
display_name varchar2,
version varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_extend_digital_assistant_details_t is a subtype of the dbms_cloud_oci_oda_create_digital_assistant_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The unique identifier of the Digital Assistant to extend. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
DBMS_CLOUD_OCI_ODA_EXTEND_SKILL_DETAILS_T Type
Properties that are required to create a new Skill by extending an existing Skill.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_extend_skill_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_create_skill_details_t (
id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_extend_skill_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_extend_skill_details_t (
kind varchar2,
category varchar2,
description varchar2,
platform_version varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
id varchar2,
name varchar2,
display_name varchar2,
version varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_extend_skill_details_t is a subtype of the dbms_cloud_oci_oda_create_skill_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The unique identifier of the Skill to extend. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
DBMS_CLOUD_OCI_ODA_FACEBOOK_CHANNEL_T Type
The configuration for a Facebook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_facebook_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_facebook_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_facebook_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_facebook_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_IMPORT_BOT_DETAILS_T Type
Properties to import a Bot resource from Object Storage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_import_bot_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
source dbms_cloud_oci_oda_storage_location_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_import_bot_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_import_bot_details_t (
source dbms_cloud_oci_oda_storage_location_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) |
DBMS_CLOUD_OCI_ODA_PARAMETER_DEFINITION_T Type
A parameter to a resource.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_parameter_definition_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
l_type varchar2(32767),
description varchar2(32767),
is_required number,
is_sensitive number,
default_value varchar2(32767),
min_length number,
max_length number,
pattern varchar2(32767),
direction varchar2(32767),
ui_placement_hint varchar2(32767),
resource_type_metadata json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_parameter_definition_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_parameter_definition_t (
name varchar2,
l_type varchar2,
description varchar2,
is_required number,
is_sensitive number,
default_value varchar2,
min_length number,
max_length number,
pattern varchar2,
direction varchar2,
ui_placement_hint varchar2,
resource_type_metadata json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The name of the parameter |
|
|
(required) Enumerated parameter type. Allowed values are: 'STRING', 'URI', 'URL', 'NUMBER', 'BOOLEAN' |
|
|
(optional) Description of the parameter. |
|
|
(optional) Is this parameter required. Ignored for parameters with direction = OUTPUT. |
|
|
(optional) Is the data for this parameter sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.) |
|
|
(optional) Default value for the parameter. |
|
|
(optional) Used for character string types such as STRING to constrain the length of the value |
|
|
(optional) Used for character string types such as STRING to constrain the length of the value |
|
|
(optional) Regular expression used to validate the value of a string type such as STRING |
|
|
(optional) Is this parameter an input parameter, output parameter, or both? Allowed values are: 'INPUT', 'OUTPUT' |
|
|
(optional) A forward-slash-delimited 'path' in an imaginary hierarchy, at which this parameter's UI widgets should be placed |
|
|
(optional) Any configuration needed to help the resource type process this parameter (e.g. link to manifest, etc.). |
DBMS_CLOUD_OCI_ODA_PARAMETER_DEFINITION_TBL Type
Nested table type of dbms_cloud_oci_oda_parameter_definition_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_parameter_definition_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_parameter_definition_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_RESOURCE_TYPE_IMPORT_CONTRACT_T Type
The contract guiding the import experience for the consumer and behavior of the resource provider for a single resourceType.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_resource_type_import_contract_t FORCE AUTHID CURRENT_USER IS OBJECT (
resource_type varchar2(32767),
parameters dbms_cloud_oci_oda_parameter_definition_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_resource_type_import_contract_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_resource_type_import_contract_t (
resource_type varchar2,
parameters dbms_cloud_oci_oda_parameter_definition_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The type of resource to which this resourceType-specific contract applies |
|
|
(required) A list of definitions for parameters that are required to import this package into a target instance. |
DBMS_CLOUD_OCI_ODA_RESOURCE_TYPE_IMPORT_CONTRACT_TBL Type
Nested table type of dbms_cloud_oci_oda_resource_type_import_contract_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_resource_type_import_contract_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_resource_type_import_contract_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_IMPORT_CONTRACT_T Type
The contract guiding the import experience for the consumer and behavior of the resource providers for all resource types in a package.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_import_contract_t FORCE AUTHID CURRENT_USER IS OBJECT (
import_contract dbms_cloud_oci_oda_resource_type_import_contract_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_import_contract_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_import_contract_t (
import_contract dbms_cloud_oci_oda_resource_type_import_contract_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A list of resource type specific import contracts, one for each resource type listed in the package definition. |
DBMS_CLOUD_OCI_ODA_IMPORTED_PACKAGE_T Type
An imported/instantiated package within an instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_imported_package_t FORCE AUTHID CURRENT_USER IS OBJECT (
oda_instance_id varchar2(32767),
current_package_id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
status varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
status_message varchar2(32767),
parameter_values json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_imported_package_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_imported_package_t (
oda_instance_id varchar2,
current_package_id varchar2,
name varchar2,
display_name varchar2,
version varchar2,
status varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
status_message varchar2,
parameter_values json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) ID of the host instance. |
|
|
(required) ID of the package. |
|
|
(required) Stable name of the package (the same across versions). |
|
|
(required) Display name of the package (can change across versions). |
|
|
(required) version of the package. |
|
|
(required) Status of the imported package. Allowed values are: 'READY', 'OPERATION_PENDING', 'FAILED' |
|
|
(required) When the imported package was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the imported package was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
|
(required) Short message explaining the status of this imported package. |
|
|
(required) A list of parameter values used to import the package. |
DBMS_CLOUD_OCI_ODA_IMPORTED_PACKAGE_SUMMARY_T Type
A summary of an imported/instantiated package within an instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_imported_package_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
oda_instance_id varchar2(32767),
current_package_id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
status varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_imported_package_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_imported_package_summary_t (
oda_instance_id varchar2,
current_package_id varchar2,
name varchar2,
display_name varchar2,
version varchar2,
status varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) ID of the host instance. |
|
|
(required) ID of the package. |
|
|
(required) Stable name of the package (the same across versions). |
|
|
(required) Display name of the package (can change across versions). |
|
|
(required) version of the package. |
|
|
(required) Status of the imported package. |
|
|
(required) When the imported package was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the imported package was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_IOS_CHANNEL_T Type
The configuration for an iOS channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_ios_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_ios_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_ios_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_ios_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_MS_TEAMS_CHANNEL_T Type
The configuration for an MS Teams channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_ms_teams_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
msa_app_id varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_ms_teams_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_ms_teams_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_ms_teams_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_METADATA_PROPERTY_T Type
Property to describe and object.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_metadata_property_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_metadata_property_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_metadata_property_t (
name varchar2,
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Name of property. |
|
|
(required) Value for the property. |
DBMS_CLOUD_OCI_ODA_OSS_CHANNEL_T Type
The configuration for an Oracle Streaming Service (OSS) channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oss_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2(32767),
outbound_message_topic varchar2(32767),
bootstrap_servers varchar2(32767),
security_protocol varchar2(32767),
sasl_mechanism varchar2(32767),
tenancy_name varchar2(32767),
user_name varchar2(32767),
stream_pool_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oss_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oss_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2,
outbound_message_topic varchar2,
bootstrap_servers varchar2,
security_protocol varchar2,
sasl_mechanism varchar2,
tenancy_name varchar2,
user_name varchar2,
stream_pool_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_oss_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
|
|
(required) The topic inbound messages are received on. |
|
|
(required) The topic outbound messages are sent on. |
|
|
(required) The Oracle Streaming Service bootstrap servers. |
|
|
(required) The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(required) The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(required) The tenancy to use when connecting to the Oracle Streaming Service. |
|
|
(required) The user name to use when connecting to the Oracle Streaming Service. |
|
|
(required) The stream pool OCI to use when connecting to the Oracle Streaming Service. |
DBMS_CLOUD_OCI_ODA_RESTRICTED_OPERATION_T Type
Summary of a restricted operation for a Digital Assistant instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_restricted_operation_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_name varchar2(32767),
restricting_service varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_restricted_operation_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_restricted_operation_t (
operation_name varchar2,
restricting_service varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Name of the restricted operation. |
|
|
(required) Name of the service restricting the operation. |
DBMS_CLOUD_OCI_ODA_RESTRICTED_OPERATION_TBL Type
Nested table type of dbms_cloud_oci_oda_restricted_operation_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_restricted_operation_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_restricted_operation_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_T Type
Description of `OdaServiceInstance` object.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
shape_name varchar2(32767),
web_app_url varchar2(32767),
connector_url varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_sub_state varchar2(32767),
state_message varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
is_role_based_access number,
identity_domain varchar2(32767),
identity_app_guid varchar2(32767),
identity_app_console_url varchar2(32767),
imported_package_names dbms_cloud_oci_oda_varchar2_tbl,
imported_package_ids dbms_cloud_oci_oda_varchar2_tbl,
attachment_types dbms_cloud_oci_oda_varchar2_tbl,
attachment_ids dbms_cloud_oci_oda_varchar2_tbl,
restricted_operations dbms_cloud_oci_oda_restricted_operation_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
shape_name varchar2,
web_app_url varchar2,
connector_url varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_sub_state varchar2,
state_message varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
is_role_based_access number,
identity_domain varchar2,
identity_app_guid varchar2,
identity_app_console_url varchar2,
imported_package_names dbms_cloud_oci_oda_varchar2_tbl,
imported_package_ids dbms_cloud_oci_oda_varchar2_tbl,
attachment_types dbms_cloud_oci_oda_varchar2_tbl,
attachment_ids dbms_cloud_oci_oda_varchar2_tbl,
restricted_operations dbms_cloud_oci_oda_restricted_operation_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the instance was created. |
|
|
(optional) User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value. |
|
|
(optional) Description of the Digital Assistant instance. |
|
|
(required) Identifier of the compartment that the instance belongs to. |
|
|
(required) Shape or size of the instance. Allowed values are: 'DEVELOPMENT', 'PRODUCTION' |
|
|
(optional) URL for the Digital Assistant web application that's associated with the instance. |
|
|
(optional) URL for the connector's endpoint. |
|
|
(optional) When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) The current state of the Digital Assistant instance. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) The current sub-state of the Digital Assistant instance. Allowed values are: 'CREATING', 'STARTING', 'STOPPING', 'CHANGING_COMPARTMENT', 'ACTIVATING_CUSTOMER_ENCRYPTION_KEY', 'UPDATING_CUSTOMER_ENCRYPTION_KEY', 'DEACTIVATING_CUSTOMER_ENCRYPTION_KEY', 'DELETING', 'DELETE_PENDING', 'RECOVERING', 'UPDATING', 'PURGING', 'QUEUED' |
|
|
(optional) A message that describes the current state in more detail. For example, actionable information about an instance that's in the `FAILED` state. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
|
(optional) Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) |
|
|
(optional) If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. |
|
|
(optional) If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain. |
|
|
(optional) If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain. |
|
|
(optional) A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages. |
|
|
(optional) A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages. |
|
|
(optional) A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments. |
|
|
(optional) A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. |
|
|
(optional) A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. |
DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_OWNER_T Type
Details about an ODA instance owner
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_owner_t FORCE AUTHID CURRENT_USER IS OBJECT (
owner_service_name varchar2(32767),
owner_service_tenancy varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_owner_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_owner_t (
owner_service_name varchar2,
owner_service_tenancy varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Name of the owner service principal |
|
|
(required) Tenancy OCID of the owner service principal |
DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_ATTACHMENT_T Type
Description of an ODA instance attachment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_attachment_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
instance_id varchar2(32767),
attach_to_id varchar2(32767),
attachment_type varchar2(32767),
attachment_metadata varchar2(32767),
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_owner_t,
time_created timestamp with time zone,
time_last_update timestamp with time zone,
lifecycle_state varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_t (
id varchar2,
instance_id varchar2,
attach_to_id varchar2,
attachment_type varchar2,
attachment_metadata varchar2,
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_owner_t,
time_created timestamp with time zone,
time_last_update timestamp with time zone,
lifecycle_state varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the ODA instance attachment was created. |
|
|
(required) The OCID of the ODA instance to which the attachment applies. |
|
|
(required) The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached. |
|
|
(required) The type of attachment defined as an enum. Allowed values are: 'FUSION' |
|
|
(optional) Attachment-specific metadata, defined by the target service. |
|
|
(optional) List of operation names that are restricted while this ODA instance is attached. |
|
|
(optional) |
|
|
(optional) The time the attachment was created. An RFC3339 formatted datetime string |
|
|
(optional) The time the attachment was last modified. An RFC3339 formatted datetime string |
|
|
(required) The current state of the attachment. Allowed values are: 'ATTACHING', 'ACTIVE', 'DETACHING', 'INACTIVE', 'FAILED' |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_ATTACHMENT_SUMMARY_T Type
Description of an ODA instance attachment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_attachment_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
instance_id varchar2(32767),
attach_to_id varchar2(32767),
attachment_type varchar2(32767),
attachment_metadata varchar2(32767),
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_owner_t,
time_created timestamp with time zone,
time_last_update timestamp with time zone,
lifecycle_state varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_summary_t (
id varchar2,
instance_id varchar2,
attach_to_id varchar2,
attachment_type varchar2,
attachment_metadata varchar2,
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_owner_t,
time_created timestamp with time zone,
time_last_update timestamp with time zone,
lifecycle_state varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the ODA instance attachment was created. |
|
|
(required) The OCID of the ODA instance to which the attachment applies. |
|
|
(required) The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached. |
|
|
(required) The type of attachment defined as an enum. Allowed values are: 'FUSION' |
|
|
(optional) Attachment-specific metadata, defined by the target service. |
|
|
(optional) List of operation names that are restricted while this ODA instance is attached. |
|
|
(optional) |
|
|
(optional) The time the attachment was created. An RFC3339 formatted datetime string |
|
|
(optional) The time the attachment was last modified. An RFC3339 formatted datetime string |
|
|
(required) The current state of the attachment. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_ATTACHMENT_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_oda_instance_attachment_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_attachment_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_oda_instance_attachment_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_ATTACHMENT_COLLECTION_T Type
Results of a Oda instance attachment search. Contains OdaInstanceAttachment items.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_attachment_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_oda_instance_attachment_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_attachment_collection_t (
items dbms_cloud_oci_oda_oda_instance_attachment_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) List of Oda instance attachments. |
DBMS_CLOUD_OCI_ODA_ODA_INSTANCE_SUMMARY_T Type
Summary of the Digital Assistant instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_instance_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
shape_name varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_sub_state varchar2(32767),
state_message varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
is_role_based_access number,
identity_domain varchar2(32767),
imported_package_names dbms_cloud_oci_oda_varchar2_tbl,
attachment_types dbms_cloud_oci_oda_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_instance_summary_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
shape_name varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_sub_state varchar2,
state_message varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
is_role_based_access number,
identity_domain varchar2,
imported_package_names dbms_cloud_oci_oda_varchar2_tbl,
attachment_types dbms_cloud_oci_oda_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique identifier of the Digital Assistant instance. |
|
|
(optional) User-defined name for the Digital Assistant instance. You can change this value. |
|
|
(optional) Description of the Digital Assistant instance. |
|
|
(required) Identifier of the compartment that the instance belongs to. |
|
|
(optional) Shape or size of the instance. Allowed values are: 'DEVELOPMENT', 'PRODUCTION' |
|
|
(optional) When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) When the Digital Assistant instance was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) The current state of the instance. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) The current sub-state of the Digital Assistant instance. Allowed values are: 'CREATING', 'STARTING', 'STOPPING', 'CHANGING_COMPARTMENT', 'ACTIVATING_CUSTOMER_ENCRYPTION_KEY', 'UPDATING_CUSTOMER_ENCRYPTION_KEY', 'DEACTIVATING_CUSTOMER_ENCRYPTION_KEY', 'DELETING', 'DELETE_PENDING', 'RECOVERING', 'UPDATING', 'PURGING', 'QUEUED' |
|
|
(optional) A message describing the current state in more detail. For example, actionable information about an instance that's in the `FAILED` state. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
|
(optional) Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) |
|
|
(optional) If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. |
|
|
(optional) A list of package names imported into this instance (if any). |
|
|
(optional) A list of attachment types for this instance (if any). |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_T Type
A private endpoint allows Digital Assistant Instance to access resources in a customer's virtual cloud network (VCN).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
subnet_id varchar2(32767),
nsg_ids dbms_cloud_oci_oda_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
subnet_id varchar2,
nsg_ids dbms_cloud_oci_oda_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID that was assigned when the ODA private endpoint was created. |
|
|
(required) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value. |
|
|
(optional) Description of the ODA private endpoint. |
|
|
(required) The OCID of the compartment that the ODA private endpoint belongs to. |
|
|
(optional) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) The current state of the ODA private endpoint. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) The OCID of the subnet that the private endpoint belongs to. |
|
|
(optional) List of OCIDs of network security groups |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_ATTACHMENT_T Type
ODA Private Endpoint Attachment is used to attach ODA Private Endpoint to ODA (Digital Assistant) Instance.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_attachment_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
oda_instance_id varchar2(32767),
oda_private_endpoint_id varchar2(32767),
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_attachment_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_attachment_t (
id varchar2,
oda_instance_id varchar2,
oda_private_endpoint_id varchar2,
compartment_id varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the ODA Private Endpoint Attachment. |
|
|
(required) The OCID of the attached ODA Instance. |
|
|
(required) The OCID of the ODA Private Endpoint. |
|
|
(required) The OCID of the compartment that the ODA private endpoint attachment belongs to. |
|
|
(required) The current state of the ODA Private Endpoint attachment. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_ATTACHMENT_SUMMARY_T Type
Summary of the ODA private endpoint attachment.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
oda_instance_id varchar2(32767),
oda_private_endpoint_id varchar2(32767),
compartment_id varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_t (
id varchar2,
oda_instance_id varchar2,
oda_private_endpoint_id varchar2,
compartment_id varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the ODA Private Endpoint Attachment. |
|
|
(required) The OCID of the attached ODA Instance. |
|
|
(required) The OCID of the ODA Private Endpoint. |
|
|
(required) The OCID of the compartment that the ODA private endpoint attachment belongs to. |
|
|
(required) The current state of the ODA Private Endpoint attachment. |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_ATTACHMENT_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_ATTACHMENT_COLLECTION_T Type
A collection of ODA Private Endpoint Attachment summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_attachment_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_attachment_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_attachment_collection_t (
items dbms_cloud_oci_oda_oda_private_endpoint_attachment_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The ODA Private Endpoint Attachment summaries. |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_SUMMARY_T Type
Summary of the ODA private endpoint.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_summary_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID that was assigned when the ODA private endpoint was created. |
|
|
(optional) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value. |
|
|
(optional) Description of the ODA private endpoint. |
|
|
(required) The OCID of the compartment that the ODA private endpoint belongs to. |
|
|
(optional) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) The current state of the ODA private endpoint. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_oda_private_endpoint_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_oda_private_endpoint_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_COLLECTION_T Type
A collection of ODA Private Endpoint summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_oda_private_endpoint_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_collection_t (
items dbms_cloud_oci_oda_oda_private_endpoint_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The ODA Private Endpoint summaries. |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_SCAN_PROXY_T Type
Details pertaining to a scan proxy instance created for a scan listener FQDN/IPs
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
scan_listener_type varchar2(32767),
protocol varchar2(32767),
scan_listener_infos dbms_cloud_oci_oda_scan_listener_info_tbl,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_t (
id varchar2,
scan_listener_type varchar2,
protocol varchar2,
scan_listener_infos dbms_cloud_oci_oda_scan_listener_info_tbl,
lifecycle_state varchar2,
time_created timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the ODA Private Endpoint Scan Proxy. |
|
|
(required) Type indicating whether Scan listener is specified by its FQDN or list of IPs Allowed values are: 'FQDN', 'IP' |
|
|
(required) The protocol used for communication between client, scanProxy and RAC's scan listeners Allowed values are: 'TCP' |
|
|
(required) The FQDN/IPs and port information of customer's Real Application Cluster (RAC)'s SCAN listeners. |
|
|
(optional) The current state of the ODA Private Endpoint Scan Proxy. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_SCAN_PROXY_SUMMARY_T Type
Details pertaining to a scan proxy instance created for a scan listener FQDN/IPs
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
scan_listener_type varchar2(32767),
protocol varchar2(32767),
scan_listener_infos dbms_cloud_oci_oda_scan_listener_info_tbl,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_t (
id varchar2,
scan_listener_type varchar2,
protocol varchar2,
scan_listener_infos dbms_cloud_oci_oda_scan_listener_info_tbl,
lifecycle_state varchar2,
time_created timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the ODA Private Endpoint Scan Proxy. |
|
|
(required) Type indicating whether Scan listener is specified by its FQDN or list of IPs |
|
|
(required) The protocol used for communication between client, scanProxy and RAC's scan listeners |
|
|
(required) The FQDN/IPs and port information of customer's Real Application Cluster (RAC)'s SCAN listeners. |
|
|
(optional) The current state of the ODA Private Endpoint Scan Proxy. |
|
|
(optional) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_SCAN_PROXY_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_ODA_PRIVATE_ENDPOINT_SCAN_PROXY_COLLECTION_T Type
A collection of ODA Private Endpoint Scan Proxy summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_collection_t (
items dbms_cloud_oci_oda_oda_private_endpoint_scan_proxy_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The ODA Private Endpoint Scan Proxy summaries. |
DBMS_CLOUD_OCI_ODA_OSVC_CHANNEL_T Type
The configuration for an OSVC channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_osvc_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
host varchar2(32767),
port varchar2(32767),
user_name varchar2(32767),
total_session_count number,
channel_service varchar2(32767),
authentication_provider_name varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_osvc_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_osvc_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
host varchar2,
port varchar2,
user_name varchar2,
total_session_count number,
channel_service varchar2,
authentication_provider_name varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_osvc_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. |
|
|
(required) The port. |
|
|
(required) The user name for the digital-assistant agent. |
|
|
(required) The total session count. |
|
|
(required) The type of OSVC service. Allowed values are: 'OSVC', 'FUSION' |
|
|
(required) The name of the Authentication Provider to use to authenticate the user. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_METADATA_PROPERTY_TBL Type
Nested table type of dbms_cloud_oci_oda_metadata_property_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_metadata_property_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_metadata_property_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_RESOURCE_TYPE_METADATA_T Type
Describes resources of a given type within a package.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_resource_type_metadata_t FORCE AUTHID CURRENT_USER IS OBJECT (
resource_type varchar2(32767),
properties dbms_cloud_oci_oda_metadata_property_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_resource_type_metadata_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_resource_type_metadata_t (
resource_type varchar2,
properties dbms_cloud_oci_oda_metadata_property_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The type of the resource described by this metadata object. |
|
|
(optional) Any properties needed to describe the content and its usage for this resource type, and within the containing package. |
DBMS_CLOUD_OCI_ODA_RESOURCE_TYPE_METADATA_TBL Type
Nested table type of dbms_cloud_oci_oda_resource_type_metadata_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_resource_type_metadata_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_resource_type_metadata_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_PACKAGE_T Type
Details of `Package` object.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_package_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
publisher_id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
time_uploaded timestamp with time zone,
time_published timestamp with time zone,
description varchar2(32767),
resource_types dbms_cloud_oci_oda_varchar2_tbl,
resource_types_metadata dbms_cloud_oci_oda_resource_type_metadata_tbl,
publisher_metadata dbms_cloud_oci_oda_metadata_property_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
import_contract dbms_cloud_oci_oda_import_contract_t,
default_parameter_values dbms_cloud_oci_oda_default_parameter_values_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_package_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_package_t (
id varchar2,
publisher_id varchar2,
name varchar2,
display_name varchar2,
version varchar2,
time_uploaded timestamp with time zone,
time_published timestamp with time zone,
description varchar2,
resource_types dbms_cloud_oci_oda_varchar2_tbl,
resource_types_metadata dbms_cloud_oci_oda_resource_type_metadata_tbl,
publisher_metadata dbms_cloud_oci_oda_metadata_property_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
import_contract dbms_cloud_oci_oda_import_contract_t,
default_parameter_values dbms_cloud_oci_oda_default_parameter_values_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Package was registered. |
|
|
(required) ID of the publisher providing the package. |
|
|
(required) Name of package. |
|
|
(required) Display name for the package (displayed in UI and user-facing applications). |
|
|
(required) Version of the package. |
|
|
(required) When the package was uploaded. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the package was last published. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) Description of the package. |
|
|
(required) A list of resource types describing the content of the package. |
|
|
(required) A map of resource type to metadata key/value map that further describes the content for the resource types in this package.. Keys are resource type names, values are a map of name/value pairs per resource type. |
|
|
(required) A map of metadata key/value pairs that further describes the publisher and the platform in which the package might be used. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
|
(required) |
|
|
(required) |
DBMS_CLOUD_OCI_ODA_PACKAGE_SUMMARY_T Type
Summary of `Package` object.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_package_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
publisher_id varchar2(32767),
name varchar2(32767),
display_name varchar2(32767),
version varchar2(32767),
time_published timestamp with time zone,
description varchar2(32767),
resource_types dbms_cloud_oci_oda_varchar2_tbl,
resource_types_metadata dbms_cloud_oci_oda_resource_type_metadata_tbl,
publisher_metadata dbms_cloud_oci_oda_metadata_property_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_package_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_package_summary_t (
id varchar2,
publisher_id varchar2,
name varchar2,
display_name varchar2,
version varchar2,
time_published timestamp with time zone,
description varchar2,
resource_types dbms_cloud_oci_oda_varchar2_tbl,
resource_types_metadata dbms_cloud_oci_oda_resource_type_metadata_tbl,
publisher_metadata dbms_cloud_oci_oda_metadata_property_tbl,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Package was registered. |
|
|
(required) ID of the publisher providing the package. |
|
|
(required) Name of package. |
|
|
(required) Display name for the package (displayed in UI and user-facing applications). |
|
|
(required) Version of the package. |
|
|
(required) When the package was last published. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) Description of the package. |
|
|
(required) A list of resource types describing the content of the package. |
|
|
(required) A map of resource type to metadata key/value map that further describes the content for the resource types in this package.. Keys are resource type names, values are a map of name/value pairs per resource type. |
|
|
(required) A map of metadata key/value pairs that further describes the publisher and the platform in which the package might be used. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_PARAMETER_T Type
Metadata for a Parameter.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_parameter_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
value varchar2(32767),
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_parameter_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_parameter_t (
name varchar2,
display_name varchar2,
description varchar2,
l_type varchar2,
value varchar2,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Parameter name. This must be unique within the parent resource. |
|
|
(required) The display name for the Parameter. |
|
|
(optional) A description of the Parameter. |
|
|
(required) The value type. Allowed values are: 'STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'SECURE' |
|
|
(required) The current value. The value will be interpreted based on the `type`. |
|
|
(required) The Parameter's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_ODA_SERVICE_CLOUD_CHANNEL_T Type
The configuration for a Service Cloud agent channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_service_cloud_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
domain_name varchar2(32767),
host_name_prefix varchar2(32767),
user_name varchar2(32767),
client_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_service_cloud_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_service_cloud_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
domain_name varchar2,
host_name_prefix varchar2,
user_name varchar2,
client_type varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_service_cloud_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(required) The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(required) The user name for an Oracle B2C Service staff member who has the necessary profile permissions. |
|
|
(required) The type of Service Cloud client. Allowed values are: 'WSDL', 'REST' |
DBMS_CLOUD_OCI_ODA_SKILL_T Type
Skill metadata.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
version varchar2(32767),
display_name varchar2(32767),
category varchar2(32767),
description varchar2(32767),
namespace varchar2(32767),
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
platform_version varchar2(32767),
base_id varchar2(32767),
multilingual_mode varchar2(32767),
primary_language_tag varchar2(32767),
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_t (
id varchar2,
name varchar2,
version varchar2,
display_name varchar2,
category varchar2,
description varchar2,
namespace varchar2,
lifecycle_state varchar2,
lifecycle_details varchar2,
platform_version varchar2,
base_id varchar2,
multilingual_mode varchar2,
primary_language_tag varchar2,
native_language_tags dbms_cloud_oci_oda_varchar2_tbl,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the resource was created. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
|
|
(required) The resource's display name. |
|
|
(optional) The resource's category. This is used to group resource's together. |
|
|
(optional) A short description of the resource. |
|
|
(optional) The resource's namespace. |
|
|
(required) The resource's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) The resource's publish state. Allowed values are: 'PUBLISHED', 'DRAFT' |
|
|
(required) The ODA Platform Version for this resource. |
|
|
(optional) The unique identifier for the base reource (when this resource extends another). |
|
|
(optional) The multilingual mode for the resource. Allowed values are: 'NATIVE', 'TRANSLATION' |
|
|
(optional) The primary language for the resource. |
|
|
(optional) A list of native languages supported by this resource. |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_SKILL_SUMMARY_T Type
Summary of a Skill.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
name varchar2(32767),
version varchar2(32767),
display_name varchar2(32767),
namespace varchar2(32767),
category varchar2(32767),
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
platform_version varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_summary_t (
id varchar2,
name varchar2,
version varchar2,
display_name varchar2,
namespace varchar2,
category varchar2,
lifecycle_state varchar2,
lifecycle_details varchar2,
platform_version varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the resource was created. |
|
|
(required) The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(required) The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. |
|
|
(required) The resource's display name. |
|
|
(required) The resource's namespace. |
|
|
(required) The resource's category. This is used to group resource's together. |
|
|
(required) The resource's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) The resource's publish state. Allowed values are: 'PUBLISHED', 'DRAFT' |
|
|
(required) The ODA Platform Version for this resource. |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_SKILL_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_skill_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_skill_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_SKILL_COLLECTION_T Type
A collection of Skill summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_skill_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_collection_t (
items dbms_cloud_oci_oda_skill_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Skill summaries. |
DBMS_CLOUD_OCI_ODA_SKILL_PARAMETER_T Type
Metadata for a Skill Parameter.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_parameter_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
value varchar2(32767),
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_parameter_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_parameter_t (
name varchar2,
display_name varchar2,
description varchar2,
l_type varchar2,
value varchar2,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Parameter name. This must be unique within the parent resource. |
|
|
(required) The display name for the Parameter. |
|
|
(optional) A description of the Parameter. |
|
|
(required) The value type. Allowed values are: 'STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'SECURE' |
|
|
(required) The current value. The value will be interpreted based on the `type`. |
|
|
(required) The Parameter's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_ODA_SKILL_PARAMETER_SUMMARY_T Type
Metadata for a Skill Parameter property.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_parameter_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
value varchar2(32767),
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_parameter_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_parameter_summary_t (
name varchar2,
display_name varchar2,
description varchar2,
l_type varchar2,
value varchar2,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Parameter name. This must be unique within the parent resource. |
|
|
(required) The display name for the Parameter. |
|
|
(optional) A description of the Parameter. |
|
|
(required) The value type. Allowed values are: 'STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'SECURE' |
|
|
(optional) The current value. The value will be interpreted based on the `type`. |
|
|
(required) The Parameter's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
DBMS_CLOUD_OCI_ODA_SKILL_PARAMETER_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_skill_parameter_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_parameter_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_skill_parameter_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_SKILL_PARAMETER_COLLECTION_T Type
A collection of Skill Parameter summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_skill_parameter_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_skill_parameter_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_parameter_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_skill_parameter_collection_t (
items dbms_cloud_oci_oda_skill_parameter_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Skill Parameter summaries. |
DBMS_CLOUD_OCI_ODA_SLACK_CHANNEL_T Type
The configuration for a Slack channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_slack_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
client_id varchar2(32767),
auth_success_url varchar2(32767),
auth_error_url varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_slack_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_slack_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
client_id varchar2,
auth_success_url varchar2,
auth_error_url varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_slack_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Slack Client Id for the Slack app. |
|
|
(optional) The URL to redirect to when authentication is successful. |
|
|
(optional) The URL to redirect to when authentication is unsuccessful. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_TEST_CHANNEL_T Type
The configuration for the Test channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_test_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_test_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_test_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_test_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_TRANSLATOR_T Type
The properties for a Translator.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_translator_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
l_type varchar2(32767),
name varchar2(32767),
base_url varchar2(32767),
lifecycle_state varchar2(32767),
properties json_element_t,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_translator_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_translator_t (
id varchar2,
l_type varchar2,
name varchar2,
base_url varchar2,
lifecycle_state varchar2,
properties json_element_t,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Translator was created. |
|
|
(required) The Translation Service to use for this Translator. Allowed values are: 'GOOGLE', 'MICROSOFT' |
|
|
(required) The descriptive name for this Translator. |
|
|
(required) The base URL for invoking the Translation Service. |
|
|
(required) The Translator's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) Properties used when invoking the translation service. Each property is a simple key-value pair. |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_TRANSLATOR_SUMMARY_T Type
Summary of the Translator.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_translator_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
l_type varchar2(32767),
name varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_translator_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_translator_summary_t (
id varchar2,
l_type varchar2,
name varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Unique immutable identifier that was assigned when the Translator was created. |
|
|
(required) The Translation Service to use for this Translator. Allowed values are: 'GOOGLE', 'MICROSOFT' |
|
|
(required) The descriptive name for this Translator. |
|
|
(required) The Translator's current state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
|
(required) When the resource was created. A date-time string as described in RFC 3339, section 14.29. |
|
|
(required) When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_TRANSLATOR_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_oda_translator_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_translator_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_translator_summary_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_TRANSLATOR_COLLECTION_T Type
A collection of Translator summaries.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_translator_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_oda_translator_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_translator_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_translator_collection_t (
items dbms_cloud_oci_oda_translator_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The Translator summaries. |
DBMS_CLOUD_OCI_ODA_TWILIO_CHANNEL_T Type
The configuration for a Twilio channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_twilio_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
account_sid varchar2(32767),
phone_number varchar2(32767),
is_mms_enabled number,
original_connectors_url varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_twilio_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_twilio_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
account_sid varchar2,
phone_number varchar2,
is_mms_enabled number,
original_connectors_url varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_twilio_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The Account SID for the Twilio number. |
|
|
(required) The Twilio phone number. |
|
|
(required) Whether MMS is enabled for this channel or not. |
|
|
(optional) The original connectors URL (used for backward compatibility). |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_UPDATE_CHANNEL_DETAILS_T Type
Properties to update a Channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_channel_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
description varchar2(32767),
l_type varchar2(32767),
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(optional) The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. |
|
|
(optional) A short description of the Channel. |
|
|
(required) The Channel type. Allowed values are: 'ANDROID', 'APPEVENT', 'APPLICATION', 'CORTANA', 'FACEBOOK', 'IOS', 'MSTEAMS', 'OSS', 'OSVC', 'SERVICECLOUD', 'SLACK', 'TEST', 'TWILIO', 'WEB', 'WEBHOOK' |
|
|
(optional) The number of milliseconds before a session expires. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_ANDROID_CHANNEL_DETAILS_T Type
Properties to update an Android channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_android_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_android_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_android_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_android_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(optional) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_APP_EVENT_CHANNEL_DETAILS_T Type
Properties to update an Application Event channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_app_event_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
outbound_url varchar2(32767),
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_app_event_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_app_event_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_app_event_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The URL for sending errors and responses to. |
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_APPLICATION_CHANNEL_DETAILS_T Type
Properties to update an Application channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_application_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
outbound_url varchar2(32767),
is_authenticated_user_id number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_application_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_application_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
is_authenticated_user_id number
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_application_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The URL to send response and error messages to. |
|
|
(optional) True if the user id in the AIC message should be treated as an authenticated user id. |
DBMS_CLOUD_OCI_ODA_UPDATE_AUTHENTICATION_PROVIDER_DETAILS_T Type
Properties to update an Authentication Provider.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_authentication_provider_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
token_endpoint_url varchar2(32767),
authorization_endpoint_url varchar2(32767),
short_authorization_code_request_url varchar2(32767),
revoke_token_endpoint_url varchar2(32767),
client_id varchar2(32767),
client_secret varchar2(32767),
scopes varchar2(32767),
subject_claim varchar2(32767),
refresh_token_retention_period_in_days number,
redirect_url varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_authentication_provider_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_authentication_provider_details_t (
token_endpoint_url varchar2,
authorization_endpoint_url varchar2,
short_authorization_code_request_url varchar2,
revoke_token_endpoint_url varchar2,
client_id varchar2,
client_secret varchar2,
scopes varchar2,
subject_claim varchar2,
refresh_token_retention_period_in_days number,
redirect_url varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The IDPs URL for requesting access tokens. |
|
|
(optional) The IDPs URL for the page that users authenticate with by entering the user name and password. |
|
|
(optional) A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. |
|
|
(optional) If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service. |
|
|
(optional) The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID. |
|
|
(optional) The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret. |
|
|
(optional) A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that’s necessary to get the refresh token (typically offline_access). |
|
|
(optional) The access-token profile claim to use to identify the user. |
|
|
(optional) The number of days to keep the refresh token in the Digital Assistant cache. |
|
|
(optional) The OAuth Redirect URL. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_CORTANA_CHANNEL_DETAILS_T Type
Properties to update a Cortana channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_cortana_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
msa_app_id varchar2(32767),
msa_app_password varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_cortana_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_cortana_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
msa_app_password varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_cortana_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(optional) The client secret that you obtained from your bot registration. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_DIGITAL_ASSISTANT_DETAILS_T Type
Properties to update a Digital Assistant.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_digital_assistant_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
category varchar2(32767),
description varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_digital_assistant_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_digital_assistant_details_t (
category varchar2,
description varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The resource's category. This is used to group resource's together. |
|
|
(optional) A short description of the resource. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_DIGITAL_ASSISTANT_PARAMETER_DETAILS_T Type
Properties to update a Digital Assistant Parameter.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_digital_assistant_parameter_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_digital_assistant_parameter_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_digital_assistant_parameter_details_t (
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The current value. The value will be interpreted based on the `type`. |
DBMS_CLOUD_OCI_ODA_UPDATE_FACEBOOK_CHANNEL_DETAILS_T Type
Properties to update a Facebook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_facebook_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
app_secret varchar2(32767),
page_access_token varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_facebook_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_facebook_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
app_secret varchar2,
page_access_token varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_facebook_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The app secret for your Facebook app. |
|
|
(optional) The page access token that you generated for your Facebook page. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_IMPORTED_PACKAGE_DETAILS_T Type
Payload for updating an imported package
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_imported_package_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
current_package_id varchar2(32767),
parameter_values json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_imported_package_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_imported_package_details_t (
current_package_id varchar2,
parameter_values json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) ID of the new package (i.e. version) to import, replacing the old imported package. Leave null if no new package resources are required. The name of the new package must must match the name of the already-imported package. |
|
|
(required) A list of the updated parameter values to apply to this imported package. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_IOS_CHANNEL_DETAILS_T Type
Properties to update an iOS channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_ios_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_ios_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_ios_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_ios_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(optional) Whether client authentication is enabled or not. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_MS_TEAMS_CHANNEL_DETAILS_T Type
Properties to update an MS Teams channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_ms_teams_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
msa_app_id varchar2(32767),
msa_app_password varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_ms_teams_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_ms_teams_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
msa_app_id varchar2,
msa_app_password varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_ms_teams_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The Microsoft App ID that you obtained when you created your bot registration in Azure. |
|
|
(optional) The client secret that you obtained from your bot registration. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_OSS_CHANNEL_DETAILS_T Type
Properties to update an Oracle Streaming Service (OSS) channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_oss_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2(32767),
outbound_message_topic varchar2(32767),
bootstrap_servers varchar2(32767),
security_protocol varchar2(32767),
sasl_mechanism varchar2(32767),
tenancy_name varchar2(32767),
user_name varchar2(32767),
stream_pool_id varchar2(32767),
auth_token varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oss_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oss_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
event_sink_bot_ids dbms_cloud_oci_oda_varchar2_tbl,
inbound_message_topic varchar2,
outbound_message_topic varchar2,
bootstrap_servers varchar2,
security_protocol varchar2,
sasl_mechanism varchar2,
tenancy_name varchar2,
user_name varchar2,
stream_pool_id varchar2,
auth_token varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_oss_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The IDs of the Skills and Digital Assistants that the Channel is routed to. |
|
|
(optional) The topic inbound messages are received on. |
|
|
(optional) The topic outbound messages are sent on. |
|
|
(optional) The Oracle Streaming Service bootstrap servers. |
|
|
(optional) The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(optional) The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. |
|
|
(optional) The tenancy to use when connecting to the Oracle Streaming Service. |
|
|
(optional) The user name to use when connecting to the Oracle Streaming Service. |
|
|
(optional) The stream pool OCI to use when connecting to the Oracle Streaming Service. |
|
|
(optional) The authentication token to use when connecting to the Oracle Streaming Service. |
DBMS_CLOUD_OCI_ODA_UPDATE_ODA_INSTANCE_ATTACHMENT_DETAILS_T Type
ODA attachment details to be updated.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_oda_instance_attachment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
attachment_metadata varchar2(32767),
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_attachment_owner_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oda_instance_attachment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oda_instance_attachment_details_t (
attachment_metadata varchar2,
restricted_operations dbms_cloud_oci_oda_varchar2_tbl,
owner dbms_cloud_oci_oda_oda_instance_attachment_owner_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Attachment specific metadata. Defined by the target service. |
|
|
(required) List of operations that are restricted while this instance is attached. |
|
|
(required) |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_ODA_INSTANCE_DETAILS_T Type
The Digital Assistant instance information to be updated.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_oda_instance_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oda_instance_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oda_instance_details_t (
display_name varchar2,
description varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) User-friendly name for the Digital Assistant instance. |
|
|
(optional) Description of the Digital Assistant instance. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_ODA_PRIVATE_ENDPOINT_DETAILS_T Type
The ODA Private Endpoint information to be updated.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_oda_private_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
nsg_ids dbms_cloud_oci_oda_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oda_private_endpoint_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_oda_private_endpoint_details_t (
display_name varchar2,
description varchar2,
nsg_ids dbms_cloud_oci_oda_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value. |
|
|
(optional) Description of the ODA private endpoint. |
|
|
(optional) List of OCIDs of network security groups |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_OSVC_CHANNEL_DETAILS_T Type
Properties required to update an OSVC channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_osvc_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
host varchar2(32767),
port varchar2(32767),
user_name varchar2(32767),
password varchar2(32767),
total_session_count number,
channel_service varchar2(32767),
authentication_provider_name varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_osvc_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_osvc_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
host varchar2,
port varchar2,
user_name varchar2,
password varchar2,
total_session_count number,
channel_service varchar2,
authentication_provider_name varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_osvc_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. |
|
|
(optional) The port. |
|
|
(optional) The user name for the digital-assistant agent. |
|
|
(optional) The password for the digital-assistant agent. |
|
|
(optional) The total session count. |
|
|
(optional) The type of OSVC service. Allowed values are: 'OSVC', 'FUSION' |
|
|
(optional) The name of the Authentication Provider to use to authenticate the user. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_SERVICE_CLOUD_CHANNEL_DETAILS_T Type
Properties to update a Service Cloud agent channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_service_cloud_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
domain_name varchar2(32767),
host_name_prefix varchar2(32767),
user_name varchar2(32767),
password varchar2(32767),
client_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_service_cloud_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_service_cloud_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
domain_name varchar2,
host_name_prefix varchar2,
user_name varchar2,
password varchar2,
client_type varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_service_cloud_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(optional) The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. |
|
|
(optional) The user name for an Oracle B2C Service staff member who has the necessary profile permissions. |
|
|
(optional) The password for the Oracle B2C Service staff member who has the necessary profile permissions. |
|
|
(optional) The type of Service Cloud client. Allowed values are: 'WSDL', 'REST' |
DBMS_CLOUD_OCI_ODA_UPDATE_SKILL_DETAILS_T Type
Properties to update a Skill.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_skill_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
category varchar2(32767),
description varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_skill_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_skill_details_t (
category varchar2,
description varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The resource's category. This is used to group resource's together. |
|
|
(optional) A short description of the resource. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_SKILL_PARAMETER_DETAILS_T Type
Properties to update a Skill Parameter.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_skill_parameter_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_skill_parameter_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_skill_parameter_details_t (
display_name varchar2,
description varchar2,
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The display name for the Parameter. |
|
|
(optional) A description of the Parameter. |
|
|
(optional) The current value. The value will be interpreted based on the `type`. |
DBMS_CLOUD_OCI_ODA_UPDATE_SLACK_CHANNEL_DETAILS_T Type
Properties to update a Slack channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_slack_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
client_id varchar2(32767),
auth_success_url varchar2(32767),
auth_error_url varchar2(32767),
signing_secret varchar2(32767),
client_secret varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_slack_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_slack_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
client_id varchar2,
auth_success_url varchar2,
auth_error_url varchar2,
signing_secret varchar2,
client_secret varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_slack_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The Slack Client Id for the Slack app. |
|
|
(optional) The URL to redirect to when authentication is successful. |
|
|
(optional) The URL to redirect to when authentication is unsuccessful. |
|
|
(optional) The Signing Secret for the Slack App. |
|
|
(optional) The Client Secret for the Slack App. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_TRANSLATOR_DETAILS_T Type
Properties to update a Translator.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_translator_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
base_url varchar2(32767),
auth_token varchar2(32767),
properties json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_translator_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_translator_details_t (
base_url varchar2,
auth_token varchar2,
properties json_element_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The base URL for invoking the Translation Service. |
|
|
(optional) The authentication token to use when invoking the Translation Service |
|
|
(optional) Properties used when invoking the translation service. Each property is a simple key-value pair. |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{\"bar-key\": \"value\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_ODA_UPDATE_TWILIO_CHANNEL_DETAILS_T Type
Properties to update a Twilio channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_twilio_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
account_sid varchar2(32767),
phone_number varchar2(32767),
auth_token varchar2(32767),
is_mms_enabled number,
original_connectors_url varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_twilio_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_twilio_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
account_sid varchar2,
phone_number varchar2,
auth_token varchar2,
is_mms_enabled number,
original_connectors_url varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_twilio_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The Account SID for the Twilio number. |
|
|
(optional) The Twilio phone number. |
|
|
(optional) The Auth Token for the Twilio number. |
|
|
(optional) Whether MMS is enabled for this channel or not. |
|
|
(optional) The original connectors URL (used for backward compatibility). |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_WEB_CHANNEL_DETAILS_T Type
Properties to update a Web channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_web_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_web_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_web_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_web_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(optional) Whether client authentication is enabled or not. |
|
|
(optional) A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_UPDATE_WEBHOOK_CHANNEL_DETAILS_T Type
Properties to update a Webhook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_update_webhook_channel_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_update_channel_details_t (
outbound_url varchar2(32767),
payload_version varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_webhook_channel_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_update_webhook_channel_details_t (
name varchar2,
description varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
payload_version varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_update_webhook_channel_details_t is a subtype of the dbms_cloud_oci_oda_update_channel_details_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The URL to send responses to. |
|
|
(optional) The version for payloads. Allowed values are: '1.0', '1.1' |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_WEB_CHANNEL_T Type
The configuration for a Web channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_web_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2(32767),
bot_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_web_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_web_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
max_token_expiration_time_in_minutes number,
is_client_authentication_enabled number,
allowed_domains varchar2,
bot_id varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_web_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The maximum time until the token expires (in minutes). |
|
|
(required) Whether client authentication is enabled or not. |
|
|
(optional) A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
DBMS_CLOUD_OCI_ODA_WEBHOOK_CHANNEL_T Type
The configuration for a Webhook channel.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_webhook_channel_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_oda_channel_t (
outbound_url varchar2(32767),
payload_version varchar2(32767),
bot_id varchar2(32767),
webhook_url varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_webhook_channel_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_webhook_channel_t (
id varchar2,
name varchar2,
description varchar2,
category varchar2,
l_type varchar2,
session_expiry_duration_in_milliseconds number,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
outbound_url varchar2,
payload_version varchar2,
bot_id varchar2,
webhook_url varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_oda_webhook_channel_t is a subtype of the dbms_cloud_oci_oda_channel_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) The URL to send responses to. |
|
|
(required) The version for payloads. Allowed values are: '1.0', '1.1' |
|
|
(optional) The ID of the Skill or Digital Assistant that the Channel is routed to. |
|
|
(required) The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. |
DBMS_CLOUD_OCI_ODA_WORK_REQUEST_RESOURCE_T Type
A resource created or operated on by a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
resource_action varchar2(32767),
resource_type varchar2(32767),
resource_id varchar2(32767),
status varchar2(32767),
status_message varchar2(32767),
resource_uri varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_resource_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_resource_t (
resource_action varchar2,
resource_type varchar2,
resource_id varchar2,
status varchar2,
status_message varchar2,
resource_uri varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The action to take against the resource. Allowed values are: 'CREATE', 'UPDATE', 'DELETE', 'PURGE', 'RECOVER', 'STOP', 'START', 'CHANGE_COMPARTMENT', 'CHANGE_CUST_ENC_KEY', 'DEACT_CUST_ENC_KEY', 'CREATE_ASSOCIATION', 'DELETE_ASSOCIATION', 'UPDATE_ENTITLEMENTS_FOR_CACCT', 'CREATE_ODA_INSTANCE_ATTACHMENT', 'UPDATE_ODA_INSTANCE_ATTACHMENT', 'DELETE_ODA_INSTANCE_ATTACHMENT', 'CREATE_IMPORTED_PACKAGE', 'UPDATE_IMPORTED_PACKAGE', 'DELETE_IMPORTED_PACKAGE', 'EXPORT' |
|
|
(required) The resource type that the work request affects. |
|
|
(required) The identifier of the resource that is the subject of the request. |
|
|
(required) The current state of the work request. The `SUCCEEDED`, `FAILED`, AND `CANCELED` states correspond to the action being performed. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'CANCELING', 'CANCELED' |
|
|
(optional) Short message providing more detail for the current status. For example, if an operation fails this may include information about the reason for the failure and a possible resolution. |
|
|
(optional) The URI path that the user can do a GET on to access the resource metadata. |
DBMS_CLOUD_OCI_ODA_WORK_REQUEST_RESOURCE_TBL Type
Nested table type of dbms_cloud_oci_oda_work_request_resource_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_oda_work_request_resource_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_ODA_WORK_REQUEST_T Type
The description of work request, including its status.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
oda_instance_id varchar2(32767),
resource_id varchar2(32767),
request_action varchar2(32767),
status varchar2(32767),
status_message varchar2(32767),
resources dbms_cloud_oci_oda_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_oda_work_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_t (
id varchar2,
compartment_id varchar2,
oda_instance_id varchar2,
resource_id varchar2,
request_action varchar2,
status varchar2,
status_message varchar2,
resources dbms_cloud_oci_oda_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 |
|---|---|
|
|
(required) The identifier of the work request. |
|
|
(required) The identifier of the compartment that contains the work request. |
|
|
(required) The identifier of the Digital Assistant instance to which this work request pertains. |
|
|
(required) The identifier of the resource to which this work request pertains. |
|
|
(required) The type of the operation that's associated with the work request. Allowed values are: 'CREATE_ODA_INSTANCE', 'UPGRADE_ODA_INSTANCE', 'DELETE_ODA_INSTANCE', 'PURGE_ODA_INSTANCE', 'RECOVER_ODA_INSTANCE', 'STOP_ODA_INSTANCE', 'START_ODA_INSTANCE', 'CHANGE_ODA_INSTANCE_COMPARTMENT', 'CHANGE_CUST_ENC_KEY', 'DEACT_CUST_ENC_KEY', 'CREATE_ASSOCIATION', 'DELETE_ASSOCIATION', 'CREATE_PCS_INSTANCE', 'UPDATE_ENTITLEMENTS_FOR_CACCT', 'LOOKUP_ODA_INSTANCES_FOR_CACCT', 'CREATE_ODA_INSTANCE_ATTACHMENT', 'UPDATE_ODA_INSTANCE_ATTACHMENT', 'DELETE_ODA_INSTANCE_ATTACHMENT', 'CREATE_IMPORTED_PACKAGE', 'UPDATE_IMPORTED_PACKAGE', 'DELETE_IMPORTED_PACKAGE', 'IMPORT_BOT', 'CREATE_SKILL', 'CLONE_SKILL', 'EXTEND_SKILL', 'VERSION_SKILL', 'EXPORT_SKILL', 'CREATE_DIGITAL_ASSISTANT', 'CLONE_DIGITAL_ASSISTANT', 'EXTEND_DIGITAL_ASSISTANT', 'VERSION_DIGITAL_ASSISTANT', 'EXPORT_DIGITAL_ASSISTANT', 'CREATE_ODA_PRIVATE_ENDPOINT', 'DELETE_ODA_PRIVATE_ENDPOINT', 'UPDATE_ODA_PRIVATE_ENDPOINT', 'CHANGE_ODA_PRIVATE_ENDPOINT_COMPARTMENT', 'CREATE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY', 'DELETE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY', 'CREATE_ODA_PRIVATE_ENDPOINT_ATTACHMENT', 'DELETE_ODA_PRIVATE_ENDPOINT_ATTACHMENT' |
|
|
(required) The status of current work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'CANCELING', 'CANCELED' |
|
|
(optional) A short message that provides more detail about the current status. For example, if a work request fails, then this may include information about why it failed. |
|
|
(required) The resources that this work request affects. |
|
|
(required) Percentage of the request completed. |
|
|
(required) The date and time that the request was created, as described in RFC 3339, section 14.29. |
|
|
(optional) The date and time that the request was started, as described in RFC 3339, CKQ section 14.29. |
|
|
(optional) The date and time that the object finished, as described in RFC 3339. CKQ |
DBMS_CLOUD_OCI_ODA_WORK_REQUEST_ERROR_T Type
Description of the unexpected error that prevented completion of the request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
time_stamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_error_t (
code varchar2,
message varchar2,
time_stamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A machine-usable code for the error that occurred. Error codes are listed at (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm) |
|
|
(required) A human-readable description of the issue. |
|
|
(required) When the error occurred. A date-time string as described in RFC 3339, section 14.29. |
DBMS_CLOUD_OCI_ODA_WORK_REQUEST_LOG_ENTRY_T Type
A log message from the execution of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
time_stamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_log_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_log_entry_t (
message varchar2,
time_stamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Human-readable log message. |
|
|
(required) When the log message was written. A date-time string as described in RFC 3339, section 14.29. |
DBMS_CLOUD_OCI_ODA_WORK_REQUEST_SUMMARY_T Type
A description of the work request's status.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_oda_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
oda_instance_id varchar2(32767),
resource_id varchar2(32767),
request_action varchar2(32767),
status varchar2(32767),
resources dbms_cloud_oci_oda_work_request_resource_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_oda_work_request_summary_t (
id varchar2,
compartment_id varchar2,
oda_instance_id varchar2,
resource_id varchar2,
request_action varchar2,
status varchar2,
resources dbms_cloud_oci_oda_work_request_resource_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The identifier of the work request. |
|
|
(required) The identifier of the compartment that contains the work request. |
|
|
(required) The identifier of the Digital Assistant instance to which this work request pertains. |
|
|
(required) The identifier of the resource to which this work request pertains. |
|
|
(required) The type of the operation that's associated with the work request. Allowed values are: 'CREATE_ODA_INSTANCE', 'UPGRADE_ODA_INSTANCE', 'DELETE_ODA_INSTANCE', 'PURGE_ODA_INSTANCE', 'RECOVER_ODA_INSTANCE', 'STOP_ODA_INSTANCE', 'START_ODA_INSTANCE', 'CHANGE_ODA_INSTANCE_COMPARTMENT', 'CHANGE_CUST_ENC_KEY', 'DEACT_CUST_ENC_KEY', 'CREATE_ASSOCIATION', 'DELETE_ASSOCIATION', 'UPDATE_ENTITLEMENTS_FOR_CACCT', 'LOOKUP_ODA_INSTANCES_FOR_CACCT', 'CREATE_ODA_INSTANCE_ATTACHMENT', 'UPDATE_ODA_INSTANCE_ATTACHMENT', 'DELETE_ODA_INSTANCE_ATTACHMENT', 'CREATE_IMPORTED_PACKAGE', 'UPDATE_IMPORTED_PACKAGE', 'DELETE_IMPORTED_PACKAGE', 'IMPORT_BOT', 'CREATE_SKILL', 'CLONE_SKILL', 'EXTEND_SKILL', 'VERSION_SKILL', 'EXPORT_SKILL', 'CREATE_DIGITAL_ASSISTANT', 'CLONE_DIGITAL_ASSISTANT', 'EXTEND_DIGITAL_ASSISTANT', 'VERSION_DIGITAL_ASSISTANT', 'EXPORT_DIGITAL_ASSISTANT', 'CREATE_ODA_PRIVATE_ENDPOINT', 'DELETE_ODA_PRIVATE_ENDPOINT', 'UPDATE_ODA_PRIVATE_ENDPOINT', 'CHANGE_ODA_PRIVATE_ENDPOINT_COMPARTMENT', 'CREATE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY', 'DELETE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY', 'CREATE_ODA_PRIVATE_ENDPOINT_ATTACHMENT', 'DELETE_ODA_PRIVATE_ENDPOINT_ATTACHMENT' |
|
|
(required) The status of current work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'CANCELING', 'CANCELED' |
|
|
(required) The resources that this work request affects. |