openapi: 3.2.0 info: description: API to create and maintain Oracle Digital Assistant service instances. title: Digital Assistant Service Instance Oda API version: '20190506' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/531121eb7dd0c8b1b4e7a3fffd325b5661fa61d805d6ebcfadb6ba7b0aa8d43b.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Digital Assistant Service Instance API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/531121eb7dd0c8b1b4e7a3fffd325b5661fa61d805d6ebcfadb6ba7b0aa8d43b.yaml what: the harvested document for Digital Assistant Service Instance API servers: - url: /20190506 tags: - name: oda paths: /odaInstances: get: description: '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. ' operationId: ListOdaInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `OdaInstanceSummary` objects. headers: opc-next-page: description: 'When you are paging through a list, if this header appears in the response, then there might be additional items still to get. Include this value as the `page` query parameter for the subsequent GET request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'The total number of results that match the query. ' schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/OdaInstanceSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Compartment's Digital Assistant Instances tags: - oda post: description: '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}`. ' operationId: CreateOdaInstance parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/SplatGeneratedResourceId' responses: 201: description: 'The request to create a Digital Assistant instance was accepted. The response includes metadata that describes the new instance, such as it''s `id`, but the instance won''t be ready for use until the `lifecycleState` is `ACTIVE`. Until the instance is `ACTIVE`, the metadata for the instance might not be complete. ' headers: Location: description: Fully qualified URL for the newly created instance. schema: type: string etag: description: For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OdaInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create Digital Assistant Instance tags: - oda requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOdaInstanceDetails' description: Details for the new Digital Assistant instance. required: true /odaInstances/{odaInstanceId}: delete: description: '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}`.' operationId: DeleteOdaInstance parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RetentionTimeQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SplatGeneratedResourceId' responses: 202: description: The request to delete the Digital Assistant instance was accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete Digital Assistant Instance tags: - oda x-related-resource: '#/definitions/OdaInstance' get: description: Gets the specified Digital Assistant instance. operationId: GetOdaInstance parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Information about the specified Digital Assistant instance was retrieved. headers: etag: description: For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OdaInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Digital Assistant Instance tags: - oda put: description: Updates the specified Digital Assistant instance with the information in the request body. operationId: UpdateOdaInstance parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SplatGeneratedResourceId' responses: 200: description: Successful update. The updated information was returned. headers: etag: description: For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OdaInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update Digital Assistant Instance tags: - oda requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOdaInstanceDetails' description: The information to update. required: true /odaInstances/{odaInstanceId}/actions/changeCompartment: post: description: 'Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeOdaInstanceCompartment parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The ODA instance has been moved to the target compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves an Digital Assistant instance into a different compartment. tags: - oda x-related-resource: '#/definitions/OdaInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeOdaInstanceCompartmentDetails' description: The compartment to which the Digital Assistant instance should be moved. required: true /odaInstances/{odaInstanceId}/actions/start: post: description: 'Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again. ' operationId: StartOdaInstance parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: A request has been submitted to start the Digital Assistant instance. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Starts an inactive Digital Assistant instance. tags: - oda x-related-resource: '#/definitions/OdaInstance' /odaInstances/{odaInstanceId}/actions/stop: post: description: '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. ' operationId: StopOdaInstance parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'A request has been submitted to stop the Digital Assistant instance. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Stops an active Digital Assistant instance. tags: - oda x-related-resource: '#/definitions/OdaInstance' /odaInstances/{odaInstanceId}/attachments: get: description: 'Returns a list of ODA instance attachments ' operationId: ListOdaInstanceAttachments parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/IncludeOdaInstanceAttachmentOwnerMetadataQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OdaInstanceAttachmentLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OdaInstanceAttachmentSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of OdaInstanceAttachmentSummary objects. headers: opc-next-page: description: 'When you are paging through a list, if this header appears in the response, then there might be additional items still to get. Include this value as the `page` query parameter for the subsequent GET request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'The total number of results that match the query. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/OdaInstanceAttachmentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all attachments to an ODA instance tags: - oda x-related-resource: '#/definitions/OdaInstanceAttachmentCollection' post: description: '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}`. ' operationId: CreateOdaInstanceAttachment parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request to create a Digital Assistant instance attachment was accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create Digital Assistant Instance Attachment tags: - oda x-related-resource: '#/definitions/OdaInstanceAttachment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOdaInstanceAttachmentDetails' description: Details for the new Digital Assistant instance attachment. required: true /odaInstances/{odaInstanceId}/attachments/{attachmentId}: delete: description: Starts an asynchronous job to delete the specified Digital Assistant instance attachment. operationId: DeleteOdaInstanceAttachment parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/OdaInstanceAttachmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to delete a Digital Assistant instance attachment was accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Digital Assistant instance attachment tags: - oda x-related-resource: '#/definitions/OdaInstanceAttachment' get: description: Gets an ODA instance attachment by identifier operationId: GetOdaInstanceAttachment parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/OdaInstanceAttachmentIdentifierPathParam' - $ref: '#/components/parameters/IncludeOdaInstanceAttachmentOwnerMetadataQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the ODA instance attachment with the given id headers: etag: description: For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OdaInstanceAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get ODA instance attachment information tags: - oda put: description: Updates the ODA instance attachment operationId: UpdateOdaInstanceAttachment parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/OdaInstanceAttachmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to update the ODA instance attachment was accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the ODA instance attachment identified by the ID tags: - oda x-related-resource: '#/definitions/OdaInstanceAttachment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOdaInstanceAttachmentDetails' description: The information to be updated. required: true /workRequests: get: description: '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. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OdaInstanceQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The page was retrieved. headers: opc-next-page: description: 'When you are paging through a list, if this header appears in the response, then there might be additional items still to get. Include this value as the `page` query parameter for the subsequent GET request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'The total number of results that match the query. ' schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Compartment's Work Requests tags: - oda x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: '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. ' operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Work request information retrieved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: 'A non-negative integer representing the number of seconds the client should wait before polling this endpoint again. ' schema: type: integer minimum: 0 content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Work Request tags: - oda x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: '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. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The page was retrieved successfully. headers: opc-next-page: description: 'When you are paging through a list, if this header appears in the response, then there might be additional items still to get. Include this value as the `page` query parameter for the subsequent GET request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'The total number of results that match the query. ' schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestError' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Request Errors tags: - oda x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: '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. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The page was retrieved successfully. headers: opc-next-page: description: 'When you are paging through a list, if this header appears in the response, then there might be additional items still to get. Include this value as the `page` query parameter for the subsequent GET request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'The total number of results that match the query. ' schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Request Log Messages tags: - oda x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: OdaInstanceSummary: description: Summary of the Digital Assistant instance. properties: attachmentTypes: description: A list of attachment types for this instance (if any). items: type: string maxItems: 128 minItems: 0 type: array compartmentId: description: Identifier of the compartment that the instance belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the Digital Assistant instance. maxLength: 400 minLength: 1 type: string displayName: description: User-defined name for the Digital Assistant instance. You can change this value. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier of the Digital Assistant instance. maxLength: 255 minLength: 1 type: string identityDomain: description: 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. type: string importedPackageNames: description: A list of package names imported into this instance (if any). items: type: string maxItems: 128 minItems: 0 type: array isRoleBasedAccess: default: false description: 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) type: boolean lifecycleState: description: The current state of the instance. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string lifecycleSubState: description: The current sub-state of the Digital Assistant instance. enum: - CREATING - STARTING - STOPPING - CHANGING_COMPARTMENT - ACTIVATING_CUSTOMER_ENCRYPTION_KEY - UPDATING_CUSTOMER_ENCRYPTION_KEY - DEACTIVATING_CUSTOMER_ENCRYPTION_KEY - DELETING - DELETE_PENDING - RECOVERING - UPDATING - PURGING - QUEUED type: string shapeName: description: Shape or size of the instance. enum: - DEVELOPMENT - PRODUCTION type: string stateMessage: description: 'A message describing the current state in more detail. For example, actionable information about an instance that''s in the `FAILED` state. ' type: string timeCreated: description: When the Digital Assistant instance was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string timeUpdated: description: When the Digital Assistant instance was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string required: - id - compartmentId - lifecycleState type: object CreateOdaInstanceDetails: description: Properties that are required to create a Digital Assistant instance. properties: compartmentId: description: Identifier of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the Digital Assistant instance. maxLength: 400 minLength: 1 type: string displayName: description: User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object identityDomain: description: 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. type: string isRoleBasedAccess: default: false description: 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) type: boolean shapeName: description: Shape or size of the instance. enum: - DEVELOPMENT - PRODUCTION type: string required: - compartmentId - shapeName type: object OdaInstanceAttachmentSummary: description: Description of an ODA instance attachment. properties: attachToId: description: 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. type: string attachmentMetadata: description: Attachment-specific metadata, defined by the target service. type: string attachmentType: description: The type of attachment defined as an enum. enum: - FUSION - MAX type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object id: description: Unique immutable identifier that was assigned when the ODA instance attachment was created. type: string instanceId: description: The OCID of the ODA instance to which the attachment applies. type: string lifecycleState: description: The current state of the attachment. type: string x-obmcs-enumref: '#/definitions/OdaInstanceAttachment/lifecycleState' owner: $ref: '#/components/schemas/OdaInstanceOwner' restrictedOperations: description: List of operation names that are restricted while this ODA instance is attached. items: type: string type: array timeCreated: description: The time the attachment was created. An RFC3339 formatted datetime string format: date-time type: string timeLastUpdate: description: The time the attachment was last modified. An RFC3339 formatted datetime string format: date-time type: string required: - id - instanceId - attachToId - attachmentType - lifecycleState type: object OdaInstance: description: Description of `OdaServiceInstance` object. properties: attachmentIds: description: A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. items: type: string maxItems: 128 minItems: 0 type: array attachmentTypes: description: A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments. items: type: string maxItems: 128 minItems: 0 type: array compartmentId: description: Identifier of the compartment that the instance belongs to. maxLength: 255 minLength: 1 type: string connectorUrl: description: URL for the connector's endpoint. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the Digital Assistant instance. maxLength: 400 minLength: 1 type: string displayName: description: 'User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object id: description: Unique immutable identifier that was assigned when the instance was created. maxLength: 255 minLength: 1 type: string identityAppConsoleUrl: description: 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. type: string identityAppGuid: description: 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. type: string identityDomain: description: 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. type: string importedPackageIds: description: A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages. items: type: string maxItems: 128 minItems: 0 type: array importedPackageNames: description: A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages. items: type: string maxItems: 128 minItems: 0 type: array isRoleBasedAccess: default: false description: 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) type: boolean lifecycleState: description: The current state of the Digital Assistant instance. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string lifecycleSubState: description: The current sub-state of the Digital Assistant instance. enum: - CREATING - STARTING - STOPPING - CHANGING_COMPARTMENT - ACTIVATING_CUSTOMER_ENCRYPTION_KEY - UPDATING_CUSTOMER_ENCRYPTION_KEY - DEACTIVATING_CUSTOMER_ENCRYPTION_KEY - DELETING - DELETE_PENDING - RECOVERING - UPDATING - PURGING - QUEUED type: string restrictedOperations: description: A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. items: $ref: '#/components/schemas/RestrictedOperation' maxItems: 128 minItems: 0 type: array shapeName: description: Shape or size of the instance. enum: - DEVELOPMENT - PRODUCTION type: string stateMessage: description: 'A message that describes the current state in more detail. For example, actionable information about an instance that''s in the `FAILED` state. ' type: string timeCreated: description: When the Digital Assistant instance was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string timeUpdated: description: When the Digital Assistance instance was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string webAppUrl: description: URL for the Digital Assistant web application that's associated with the instance. type: string required: - id - compartmentId - shapeName type: object OdaInstanceAttachment: description: Description of an ODA instance attachment. properties: attachToId: description: 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. type: string attachmentMetadata: description: Attachment-specific metadata, defined by the target service. type: string attachmentType: description: The type of attachment defined as an enum. enum: - FUSION - MAX type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object id: description: Unique immutable identifier that was assigned when the ODA instance attachment was created. type: string instanceId: description: The OCID of the ODA instance to which the attachment applies. type: string lifecycleState: description: The current state of the attachment. enum: - ATTACHING - ACTIVE - DETACHING - INACTIVE - FAILED type: string owner: $ref: '#/components/schemas/OdaInstanceOwner' restrictedOperations: description: List of operation names that are restricted while this ODA instance is attached. items: type: string type: array timeCreated: description: The time the attachment was created. An RFC3339 formatted datetime string format: date-time type: string timeLastUpdate: description: The time the attachment was last modified. An RFC3339 formatted datetime string format: date-time type: string required: - id - attachToId - instanceId - attachmentType - lifecycleState type: object UpdateOdaInstanceAttachmentDetails: description: ODA attachment details to be updated. properties: attachmentMetadata: description: Attachment specific metadata. Defined by the target service. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object owner: $ref: '#/components/schemas/OdaInstanceAttachmentOwner' restrictedOperations: description: List of operations that are restricted while this instance is attached. items: type: string type: array required: - attachmentMetadata - restrictedOperations - owner type: object CreateOdaInstanceAttachmentDetails: description: Properties required to create an ODA instance attachment. properties: attachToId: description: The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this ODA instance is being attached. type: string attachmentMetadata: description: Attachment specific metadata. Defined by the target service. type: string attachmentType: description: The type of target instance which this ODA instance is being attached. enum: - FUSION - MAX type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object owner: $ref: '#/components/schemas/OdaInstanceAttachmentOwner' restrictedOperations: description: List of operations that are restricted while this instance is attached. items: type: string type: array required: - attachToId - attachmentType - owner ChangeOdaInstanceCompartmentDetails: description: Properties required to move a Digital Assistant instance from one compartment to another. properties: compartmentId: description: Identifier of the compartment into which the Digital Assistant instance should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId WorkRequestResource: description: A resource created or operated on by a work request. properties: resourceAction: description: The action to take against the resource. enum: - CREATE - 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 type: string resourceId: description: The identifier of the resource that is the subject of the request. maxLength: 255 minLength: 1 type: string resourceType: description: The resource type that the work request affects. maxLength: 99 minLength: 1 type: string resourceUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string status: description: 'The current state of the work request. The `SUCCEEDED`, `FAILED`, AND `CANCELED` states correspond to the action being performed. ' enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - FAILED - CANCELING - CANCELED type: string statusMessage: description: '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. ' type: string required: - resourceAction - resourceType - resourceId - status RestrictedOperation: description: Summary of a restricted operation for a Digital Assistant instance. properties: operationName: description: Name of the restricted operation. maxLength: 255 minLength: 1 type: string restrictingService: description: Name of the service restricting the operation. maxLength: 255 minLength: 1 type: string required: - operationName - restrictingService type: object ErrorBody: description: Error Information. properties: code: description: A short error code that defines the error, which is useful for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message WorkRequestSummary: description: A description of the work request's status. properties: compartmentId: description: The identifier of the compartment that contains the work request. maxLength: 255 minLength: 1 type: string id: description: The identifier of the work request. maxLength: 255 minLength: 1 type: string odaInstanceId: description: The identifier of the Digital Assistant instance to which this work request pertains. maxLength: 255 minLength: 1 type: string requestAction: description: The type of the operation that's associated with the work request. enum: - 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 type: string resources: description: The resources that this work request affects. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of current work request. enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - FAILED - CANCELING - CANCELED type: string required: - requestAction - status - id - compartmentId - odaInstanceId - resources WorkRequestError: description: Description of the unexpected error that prevented completion of the request. properties: code: description: '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) ' type: string message: description: A human-readable description of the issue. type: string timeStamp: description: When the error occurred. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string required: - code - message - timeStamp OdaInstanceAttachmentCollection: description: Results of a Oda instance attachment search. Contains OdaInstanceAttachment items. properties: items: description: List of Oda instance attachments. items: $ref: '#/components/schemas/OdaInstanceAttachmentSummary' type: array required: - items type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timeStamp: description: When the log message was written. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string required: - message - timeStamp OdaInstanceAttachmentOwner: description: Details about an attachment owner properties: ownerServiceName: description: Name of the owner service principal type: string ownerServiceTenancy: description: Tenancy OCID of the owner service principal type: string required: - ownerServiceName - ownerServiceTenancy type: object OdaInstanceOwner: description: Details about an ODA instance owner properties: ownerServiceName: description: Name of the owner service principal type: string ownerServiceTenancy: description: Tenancy OCID of the owner service principal type: string required: - ownerServiceName - ownerServiceTenancy type: object UpdateOdaInstanceDetails: description: The Digital Assistant instance information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the Digital Assistant instance. maxLength: 400 minLength: 1 type: string displayName: description: User-friendly name for the Digital Assistant instance. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object type: object WorkRequest: description: The description of work request, including its status. properties: compartmentId: description: The identifier of the compartment that contains the work request. maxLength: 255 minLength: 1 type: string id: description: The identifier of the work request. maxLength: 255 minLength: 1 type: string odaInstanceId: description: The identifier of the Digital Assistant instance to which this work request pertains. maxLength: 255 minLength: 1 type: string percentComplete: description: Percentage of the request completed. format: float type: number requestAction: description: The type of the operation that's associated with the work request. enum: - 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 type: string resources: description: The resources that this work request affects. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of current work request. enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - FAILED - CANCELING - CANCELED type: string statusMessage: description: '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. ' type: string timeAccepted: description: 'The date and time that the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time that the object finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). CKQ ' format: date-time type: string timeStarted: description: 'The date and time that the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), CKQ section 14.29. ' format: date-time type: string required: - requestAction - status - id - compartmentId - odaInstanceId - resources - percentComplete - timeAccepted parameters: OdaInstanceAttachmentIdentifierPathParam: description: Unique Digital Assistant instance attachment identifier. in: path name: attachmentId required: true schema: type: string SortByQueryParam: description: '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. ' in: query name: sortBy schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED PaginationTokenQueryParam: description: '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==` ' in: query name: page x-default-description: 'null' schema: type: string maxLength: 1024 minLength: 1 OdaInstanceAttachmentLifecycleStateQueryParam: description: List only the ODA instance attachments that are in this lifecycle state. in: query name: lifecycleState x-default-description: 'null' schema: type: string enum: - ATTACHING - ACTIVE - DETACHING - INACTIVE - FAILED SplatGeneratedResourceId: description: 'resourceId generated by Splat ' in: header name: oci-splat-generated-ocids required: false x-default-description: 'null' schema: type: string OdaInstanceIdentifierPathParam: description: Unique Digital Assistant instance identifier. in: path name: odaInstanceId required: true schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: List the Digital Assistant instances that belong to this compartment. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: '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. ' in: header name: if-match required: false schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return per page. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 WorkRequestLogSortByQueryParam: description: '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. ' in: query name: sortBy schema: type: string enum: - MESSAGE - TIMESTAMP default: TIMESTAMP LifecycleStateQueryParam: description: List only the Digital Assistant instances that are in this lifecycle state. in: query name: lifecycleState x-default-description: 'null' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED WorkRequestIdPathParam: description: The identifier of the asynchronous work request. in: path name: workRequestId required: true schema: type: string OdaInstanceQueryParam: description: List only the information for this Digital Assistant instance. in: query name: odaInstanceId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SortOrderQueryParam: description: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). in: query name: sortOrder x-default-description: 'Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. ' schema: type: string enum: - ASC - DESC OdaInstanceAttachmentSortByQueryParam: description: '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. ' in: query name: sortBy schema: type: string enum: - TIMECREATED default: TIMECREATED IncludeOdaInstanceAttachmentOwnerMetadataQueryParam: description: Whether to send attachment owner info during get/list call. in: query name: includeOwnerMetadata required: false schema: type: boolean default: false RetentionTimeQueryParam: description: Retain the ODA instance being deleted for the given number of days before hard-delete/purge. in: query name: retentionTime required: false x-default-description: 'null' schema: type: integer maximum: 365 minimum: -1 RetryTokenHeader: description: '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. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: '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` ' in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: '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 ' in: query name: sortBy schema: type: string enum: - OPERATION_TYPE - STATUS - TIME_ACCEPTED - TIME_STARTED - TIME_FINISHED default: TIME_ACCEPTED RequestIdHeader: description: The client request ID for tracing. This value is included in the opc-request-id response header. in: header name: opc-request-id x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestErrorSortByQueryParam: description: '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. ' in: query name: sortBy schema: type: string enum: - CODE - TIMESTAMP default: TIMESTAMP responses: default: description: Unknown error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorBody' x-anchors: x-headers: Location: description: Fully qualified URL for the newly created resource. type: string etag: description: For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. type: string opc-next-page: description: 'When you are paging through a list, if this header appears in the response, then there might be additional items still to get. Include this value as the `page` query parameter for the subsequent GET request. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: 'The total number of results that match the query. ' type: integer opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the operation. ' type: string x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. The value must be a string, an integer, or a boolean types. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` ' type: object timeCreated: description: When the resource was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string timeUpdated: description: When the resource was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. format: date-time type: string x-obmcs-client-retries-enabled: true x-oracle-package: oracle.cloud.bots.cp