ODA Functions

Package: DBMS_CLOUD_OCI_ODA_ODA

CHANGE_ODA_INSTANCE_COMPARTMENT Function

Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_oda_instance_compartment (
  oda_instance_id varchar2,
  change_oda_instance_compartment_details dbms_cloud_oci_oda_change_oda_instance_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_change_oda_instance_compartment_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`change_oda_instance_compartment_details`	(required) The compartment to which the Digital Assistant instance should be moved.
`if_match`	(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ODA_INSTANCE Function

Starts an asynchronous job to create a Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

Syntax

FUNCTION create_oda_instance (
  create_oda_instance_details dbms_cloud_oci_oda_create_oda_instance_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_create_oda_instance_response_t;

Parameters

Parameter	Description
`create_oda_instance_details`	(required) Details for the new Digital Assistant instance.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ODA_INSTANCE_ATTACHMENT Function

Starts an asynchronous job to create a Digital Assistant instance attachment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

Syntax

FUNCTION create_oda_instance_attachment (
  oda_instance_id varchar2,
  create_oda_instance_attachment_details dbms_cloud_oci_oda_create_oda_instance_attachment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_create_oda_instance_attachment_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`create_oda_instance_attachment_details`	(required) Details for the new Digital Assistant instance attachment.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ODA_INSTANCE Function

Starts an asynchronous job to delete the specified Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

Syntax

FUNCTION delete_oda_instance (
  oda_instance_id varchar2,
  retention_time number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_delete_oda_instance_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`retention_time`	(optional) Retain the ODA instance being deleted for the given number of days before hard-delete/purge.
`if_match`	(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ODA_INSTANCE_ATTACHMENT Function

Starts an asynchronous job to delete the specified Digital Assistant instance attachment.

Syntax

FUNCTION delete_oda_instance_attachment (
  oda_instance_id varchar2,
  attachment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_delete_oda_instance_attachment_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`attachment_id`	(required) Unique Digital Assistant instance attachment identifier.
`if_match`	(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ODA_INSTANCE Function

Gets the specified Digital Assistant instance.

Syntax

FUNCTION get_oda_instance (
  oda_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_get_oda_instance_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ODA_INSTANCE_ATTACHMENT Function

Gets an ODA instance attachment by identifier

Syntax

FUNCTION get_oda_instance_attachment (
  oda_instance_id varchar2,
  attachment_id varchar2,
  include_owner_metadata number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_get_oda_instance_attachment_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`attachment_id`	(required) Unique Digital Assistant instance attachment identifier.
`include_owner_metadata`	(optional) Whether to send attachment owner info during get/list call.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets information about the work request with the specified ID, including its status. You can use this operation to monitor the status of jobs that you requested to create, delete, and update instances.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The identifier of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ODA_INSTANCE_ATTACHMENTS Function

Returns a list of ODA instance attachments

Syntax

FUNCTION list_oda_instance_attachments (
  oda_instance_id varchar2,
  include_owner_metadata number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_list_oda_instance_attachments_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`include_owner_metadata`	(optional) Whether to send attachment owner info during get/list call.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`
`lifecycle_state`	(optional) List only the ODA instance attachments that are in this lifecycle state. Allowed values are: 'ATTACHING', 'ACTIVE', 'DETACHING', 'INACTIVE', 'FAILED'
`sort_order`	(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`. The default sort order for `TIMECREATED` is descending. Allowed values are: 'TIMECREATED'
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ODA_INSTANCES Function

Returns a page of Digital Assistant instances that belong to the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_oda_instances (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_list_oda_instances_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) List the Digital Assistant instances that belong to this compartment.
`display_name`	(optional) List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: `My new resource`
`lifecycle_state`	(optional) List only the Digital Assistant instances that are in this lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`
`sort_order`	(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`. The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Returns a page of errors for the specified work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The identifier of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`page`	(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`
`limit`	(optional) The maximum number of items to return per page.
`sort_by`	(optional) The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`. The default sort order for both `TIMESTAMP` and `CODE` is ascending. Allowed values are: 'CODE', 'TIMESTAMP'
`sort_order`	(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Returns a page of of log messages for a given work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The identifier of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`page`	(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`
`limit`	(optional) The maximum number of items to return per page.
`sort_by`	(optional) The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`. The default sort order for both `TIMESTAMP` and `MESSAGE` is ascending. Allowed values are: 'MESSAGE', 'TIMESTAMP'
`sort_order`	(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Returns a page of work requests for the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  oda_instance_id varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) List the Digital Assistant instances that belong to this compartment.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`oda_instance_id`	(optional) List only the information for this Digital Assistant instance.
`resource_id`	(optional) List only the information for this resource.
`page`	(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`
`limit`	(optional) The maximum number of items to return per page.
`sort_by`	(optional) The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIME_ACCEPTED`. The default sort order for the time fields is descending. The default order for `DISPLAYNAME` and `STATUS` is ascending.default: TIME_ACCEPTED Allowed values are: 'OPERATION_TYPE', 'STATUS', 'TIME_ACCEPTED', 'TIME_STARTED', 'TIME_FINISHED'
`sort_order`	(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_ODA_INSTANCE Function

Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.

Syntax

FUNCTION start_oda_instance (
  oda_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_start_oda_instance_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`if_match`	(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

STOP_ODA_INSTANCE Function

Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering of requests will be stopped until the instance is started again. Data associated with the instance is not affected.

Syntax

FUNCTION stop_oda_instance (
  oda_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_stop_oda_instance_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`if_match`	(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ODA_INSTANCE Function

Updates the specified Digital Assistant instance with the information in the request body.

Syntax

FUNCTION update_oda_instance (
  oda_instance_id varchar2,
  update_oda_instance_details dbms_cloud_oci_oda_update_oda_instance_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_update_oda_instance_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`update_oda_instance_details`	(required) The information to update.
`if_match`	(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ODA_INSTANCE_ATTACHMENT Function

Updates the ODA instance attachment

Syntax

FUNCTION update_oda_instance_attachment (
  oda_instance_id varchar2,
  attachment_id varchar2,
  update_oda_instance_attachment_details dbms_cloud_oci_oda_update_oda_instance_attachment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_oda_update_oda_instance_attachment_response_t;

Parameters

Parameter	Description
`oda_instance_id`	(required) Unique Digital Assistant instance identifier.
`attachment_id`	(required) Unique Digital Assistant instance attachment identifier.
`update_oda_instance_attachment_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.
`opc_request_id`	(optional) The client request ID for tracing. This value is included in the opc-request-id response header.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://digitalassistant-api.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_ODA_INSTANCE_COMPARTMENT Function 🔗

CREATE_ODA_INSTANCE Function 🔗

CREATE_ODA_INSTANCE_ATTACHMENT Function 🔗

DELETE_ODA_INSTANCE Function 🔗

DELETE_ODA_INSTANCE_ATTACHMENT Function 🔗

GET_ODA_INSTANCE Function 🔗

GET_ODA_INSTANCE_ATTACHMENT Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_ODA_INSTANCE_ATTACHMENTS Function 🔗

LIST_ODA_INSTANCES Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

START_ODA_INSTANCE Function 🔗

STOP_ODA_INSTANCE Function 🔗

UPDATE_ODA_INSTANCE Function 🔗

UPDATE_ODA_INSTANCE_ATTACHMENT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_ODA_INSTANCE_COMPARTMENT Function

CREATE_ODA_INSTANCE Function

CREATE_ODA_INSTANCE_ATTACHMENT Function

DELETE_ODA_INSTANCE Function

DELETE_ODA_INSTANCE_ATTACHMENT Function

GET_ODA_INSTANCE Function

GET_ODA_INSTANCE_ATTACHMENT Function

GET_WORK_REQUEST Function

LIST_ODA_INSTANCE_ATTACHMENTS Function

LIST_ODA_INSTANCES Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

START_ODA_INSTANCE Function

STOP_ODA_INSTANCE Function

UPDATE_ODA_INSTANCE Function

UPDATE_ODA_INSTANCE_ATTACHMENT Function