openapi: 3.2.0 info: description: API to create and maintain Oracle Digital Assistant service instances. title: Digital Assistant Service Instance Management 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: management paths: /odaInstances/{odaInstanceId}/actions/configureDigitalAssistantParameters: post: description: 'This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters. ' operationId: ConfigureDigitalAssistantParameters parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Digital Assistant Parameters have been configured. 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 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: Configure the Digital Assistant Parameters for the Digital Assistant instance tags: - management x-related-resource: '#/definitions/DigitalAssistantParameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureDigitalAssistantParametersDetails' description: The parameter values to use. required: true /odaInstances/{odaInstanceId}/actions/importBot: post: description: Import a Bot archive from Object Storage. operationId: ImportBot parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The import request has been 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: Import Bot tags: - management x-related-resource: '#/definitions/Bot' requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportBotDetails' description: Properties for where in Object Storage to import the Bot archive from. required: true /odaInstances/{odaInstanceId}/authenticationProviders: get: description: 'Returns a page of Authentication Providers that belong to the specified Digital Assistant instance. 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: ListAuthenticationProviders parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/AuthenticationProviderIdQueryParam' - $ref: '#/components/parameters/AuthenticationProviderIdentityProviderQueryParam' - $ref: '#/components/parameters/AuthenticationProviderNameQueryParam' - $ref: '#/components/parameters/LifecycleStateEnumQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AuthenticationProviderSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `AuthenticationProviderSummary` 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/AuthenticationProviderCollection' 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 Authentication Providers tags: - management x-related-resource: '#/definitions/AuthenticationProvider' post: description: 'Creates a new Authentication Provider ' operationId: CreateAuthenticationProvider parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The Authentication Provider was created. headers: Location: description: Fully qualified URL for the newly created resource. 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 content: application/json: schema: $ref: '#/components/schemas/AuthenticationProvider' 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 Authentication Provider tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAuthenticationProviderDetails' description: Property values required to create the new Authentication Provider. required: true /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}: delete: description: Delete the specified Authentication Provider. operationId: DeleteAuthenticationProvider parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/AuthenticationProviderIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Authentication Provider was deleted. 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 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 Authentication Provider tags: - management x-related-resource: '#/definitions/AuthenticationProvider' get: description: Gets the specified Authentication Provider. operationId: GetAuthenticationProvider parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/AuthenticationProviderIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: An `AuthenticationProvider` object. 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/AuthenticationProvider' 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 Authentication Provider tags: - management put: description: Updates the specified Authentication Provider with the information in the request body. operationId: UpdateAuthenticationProvider parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/AuthenticationProviderIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Authentication Provider was updated. 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/AuthenticationProvider' 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 Authentication Provider tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuthenticationProviderDetails' description: Property values to update the Authentication Provider. required: true /odaInstances/{odaInstanceId}/channels: get: description: 'Returns a page of Channels that belong to the specified Digital Assistant instance. 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: ListChannels parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/ChannelIdQueryParam' - $ref: '#/components/parameters/ChannelNameQueryParam' - $ref: '#/components/parameters/ChannelCategoryQueryParam' - $ref: '#/components/parameters/ChannelTypeQueryParam' - $ref: '#/components/parameters/LifecycleStateEnumQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ChannelSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `ChannelSummary` 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/ChannelCollection' 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 Channels tags: - management x-related-resource: '#/definitions/Channel' post: description: 'Creates a new Channel. ' operationId: CreateChannel parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: 'The Channel has been created. Ensure that you take note of the newly generated keys in the response (if any) as they will not be returned again. ' headers: Location: description: Fully qualified URL for the newly created resource. 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 content: application/json: schema: $ref: '#/components/schemas/CreateChannelResult' 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 Channel tags: - management x-related-resource: '#/definitions/Channel' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateChannelDetails' description: Property values for creating the new Channel. required: true /odaInstances/{odaInstanceId}/channels/{channelId}: delete: description: Delete the specified Channel. operationId: DeleteChannel parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/ChannelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Channel was deleted. 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 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 Channel tags: - management x-related-resource: '#/definitions/Channel' get: description: Gets the specified Channel. operationId: GetChannel parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/ChannelIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A `Channel` object. 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/Channel' 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 Channel tags: - management put: description: Updates the specified Channel with the information in the request body. operationId: UpdateChannel parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/ChannelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Channel was updated. 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/Channel' 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 Channel tags: - management x-related-resource: '#/definitions/Channel' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateChannelDetails' description: Property values to update the Channel. required: true /odaInstances/{odaInstanceId}/channels/{channelId}/actions/rotateKeys: post: description: 'This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again. ' operationId: RotateChannelKeys parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/ChannelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The keys were rotated. 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/CreateChannelResult' 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: Rotate generated keys for the Channel. tags: - management x-related-resource: '#/definitions/Channel' /odaInstances/{odaInstanceId}/channels/{channelId}/actions/start: post: description: 'Starts a Channel so that it will begin accepting messages. ' operationId: StartChannel parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/ChannelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The Channel was started. 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/Channel' 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: Start a Channel. tags: - management x-related-resource: '#/definitions/Channel' /odaInstances/{odaInstanceId}/channels/{channelId}/actions/stop: post: description: 'Stops a Channel so that it will no longer accept messages. ' operationId: StopChannel parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/ChannelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The Channel was stopped. 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/Channel' 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: Stop a Channel. tags: - management x-related-resource: '#/definitions/Channel' /odaInstances/{odaInstanceId}/digitalAssistants: get: description: 'Returns a page of Digital Assistants that belong to the specified Digital Assistant instance. 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: ListDigitalAssistants parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdQueryParam' - $ref: '#/components/parameters/BotCategoryQueryParam' - $ref: '#/components/parameters/BotNameQueryParam' - $ref: '#/components/parameters/BotVersionQueryParam' - $ref: '#/components/parameters/BotNamespaceQueryParam' - $ref: '#/components/parameters/BotPlatformVersionQueryParam' - $ref: '#/components/parameters/LifecycleStateEnumQueryParam' - $ref: '#/components/parameters/BotLifecycleDetailsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BotSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `DigitalAssistantSummary` 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/DigitalAssistantCollection' 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 Digital Assistants tags: - management x-related-resource: '#/definitions/DigitalAssistant' post: description: 'Creates a new Digital Assistant. ' operationId: CreateDigitalAssistant parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The Digital Assistant create request has been 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 tags: - management x-related-resource: '#/definitions/DigitalAssistant' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDigitalAssistantDetails' description: Property values for creating the new Digital Assistant. required: true /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}: delete: description: 'Delete the specified Digital Assistant. ' operationId: DeleteDigitalAssistant parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Digital Assistant was deleted. 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 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 tags: - management x-related-resource: '#/definitions/DigitalAssistant' get: description: Gets the specified Digital Assistant. operationId: GetDigitalAssistant parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A `DigitalAssistant` object. 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/DigitalAssistant' 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 tags: - management put: description: Updates the specified Digital Assistant with the information in the request body. operationId: UpdateDigitalAssistant parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Digital Assistant was updated. 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/DigitalAssistant' 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 tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDigitalAssistantDetails' description: Property values to update the Digital Assistant. required: true /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/export: post: description: Exports the specified Digital Assistant as an archive to Object Storage. operationId: ExportDigitalAssistant parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The Digital Assistant export request 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Export a Digital Assistant to Object Storage tags: - management x-related-resource: '#/definitions/Skill' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportDigitalAssistantDetails' description: Where in Object Storage to export the Digital Assistant to. required: true /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/publish: post: description: 'Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified. ' operationId: PublishDigitalAssistant parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Digital Assistant has been published. 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/DigitalAssistant' 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: Publish Digital Assistant tags: - management x-related-resource: '#/definitions/DigitalAssistant' /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters: get: description: 'Returns a page of Parameters that belong to the specified Digital Assistant. 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: ListDigitalAssistantParameters parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/ParameterNameQueryParam' - $ref: '#/components/parameters/LifecycleStateEnumQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ParameterSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `DigitalAssistantParameterSummary` 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/DigitalAssistantParameterCollection' 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 Digital Assistant Parameters tags: - management x-related-resource: '#/definitions/DigitalAssistantParameter' /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}: get: description: Gets the specified Digital Assistant Parameter. operationId: GetDigitalAssistantParameter parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/DigitalAssistantParameterNamePathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A `DigitalAssistantParameter` object. 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/DigitalAssistantParameter' 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 Parameter tags: - management put: description: Updates the specified Digital Assistant Parameter with the information in the request body. operationId: UpdateDigitalAssistantParameter parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/DigitalAssistantIdPathParam' - $ref: '#/components/parameters/DigitalAssistantParameterNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Digital Assistant Parameter was updated. 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/DigitalAssistantParameter' 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 Parameter tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDigitalAssistantParameterDetails' description: Property values to update the Digital Assistant Parameter. required: true /odaInstances/{odaInstanceId}/skills: get: description: 'Returns a page of Skills that belong to the specified Digital Assistant instance. 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: ListSkills parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdQueryParam' - $ref: '#/components/parameters/BotCategoryQueryParam' - $ref: '#/components/parameters/BotNameQueryParam' - $ref: '#/components/parameters/BotVersionQueryParam' - $ref: '#/components/parameters/BotNamespaceQueryParam' - $ref: '#/components/parameters/BotPlatformVersionQueryParam' - $ref: '#/components/parameters/LifecycleStateEnumQueryParam' - $ref: '#/components/parameters/BotLifecycleDetailsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BotSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `SkillSummary` 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/SkillCollection' 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 Skills tags: - management x-related-resource: '#/definitions/Skill' post: description: 'Creates a new Skill from scratch. ' operationId: CreateSkill parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The Skill create request has been accepted. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`. ' 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 Skill tags: - management x-related-resource: '#/definitions/Skill' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSkillDetails' description: Property values for creating the Skill. required: true /odaInstances/{odaInstanceId}/skills/{skillId}: delete: description: 'Delete the specified Skill. ' operationId: DeleteSkill parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Skill was deleted. 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 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 Skill tags: - management x-related-resource: '#/definitions/Skill' get: description: Gets the specified Skill. operationId: GetSkill parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A `Skill` object. 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/Skill' 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 Skill tags: - management put: description: Updates the specified Skill with the information in the request body. operationId: UpdateSkill parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Skill was updated. 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/Skill' 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 Skill tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSkillDetails' description: Property values to update the Skill. required: true /odaInstances/{odaInstanceId}/skills/{skillId}/actions/export: post: description: Exports the specified Skill as an archive to Object Storage. operationId: ExportSkill parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: 'The Skill export request was accepted. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`. ' 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Export a Skill to Object Storage tags: - management x-related-resource: '#/definitions/Skill' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportSkillDetails' description: Where in Object Storage to export the Skill to. required: true /odaInstances/{odaInstanceId}/skills/{skillId}/actions/publish: post: description: 'Publish a draft Skill. Once published it cannot be modified. ' operationId: PublishSkill parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Skill has been published. 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/Skill' 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: Publish Skill tags: - management x-related-resource: '#/definitions/Skill' /odaInstances/{odaInstanceId}/skills/{skillId}/parameters: get: description: 'Returns a page of Skill Parameters that belong to the specified Skill. 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: ListSkillParameters parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/ParameterNameQueryParam' - $ref: '#/components/parameters/LifecycleStateEnumQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ParameterSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `SkillParameterSummary` 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/SkillParameterCollection' 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 Skill Parameters tags: - management x-related-resource: '#/definitions/SkillParameter' post: description: 'Creates a new Skill Parameter. ' operationId: CreateSkillParameter parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The Parameter has been created. headers: Location: description: Fully qualified URL for the newly created resource. 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 content: application/json: schema: $ref: '#/components/schemas/SkillParameter' 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 Skill Parameter tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSkillParameterDetails' description: Property values for creating the new Skill Parameter. required: true /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}: delete: description: 'Delete the specified Skill Parameter. ' operationId: DeleteSkillParameter parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/SkillParameterNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Skill parameter was deleted. 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 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 Skill Parameter tags: - management x-related-resource: '#/definitions/SkillParameter' get: description: Gets the specified Skill Parameter. operationId: GetSkillParameter parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/SkillParameterNamePathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A `SkillParameter` object. 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/SkillParameter' 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 Skill Parameter tags: - management put: description: Updates the specified Skill Parameter with the information in the request body. operationId: UpdateSkillParameter parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/SkillIdPathParam' - $ref: '#/components/parameters/SkillParameterNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Skill Parameter was updated. 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/SkillParameter' 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 Skill Parameter tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSkillParameterDetails' description: Property values to update the Skill Parameter. required: true /odaInstances/{odaInstanceId}/translators: get: description: 'Returns a page of Translators that belong to the specified Digital Assistant instance. 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: ListTranslators parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/TranslatorIdQueryParam' - $ref: '#/components/parameters/TranslatorTypeQueryParam' - $ref: '#/components/parameters/TranslatorNameQueryParam' - $ref: '#/components/parameters/LifecycleStateEnumQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TranslatorSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of `TranslatorSummary` 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/TranslatorCollection' 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 Translators tags: - management x-related-resource: '#/definitions/Translator' post: description: 'Creates a new Translator ' operationId: CreateTranslator parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The Translator has been created. headers: Location: description: Fully qualified URL for the newly created resource. 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 content: application/json: schema: $ref: '#/components/schemas/Translator' 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 Translator tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTranslatorDetails' description: Property values to create the new Translator. required: true /odaInstances/{odaInstanceId}/translators/{translatorId}: delete: description: Delete the specified Translator. operationId: DeleteTranslator parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/TranslatorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Translator was deleted. 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 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 Translator tags: - management x-related-resource: '#/definitions/Translator' get: description: Gets the specified Translator. operationId: GetTranslator parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/TranslatorIdPathParam' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A `Translator` object. 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/Translator' 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 Translator tags: - management put: description: Updates the specified Translator with the information in the request body. operationId: UpdateTranslator parameters: - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam' - $ref: '#/components/parameters/TranslatorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Translator was updated. 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/Translator' 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 Translator tags: - management requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTranslatorDetails' description: Property values to update the Translator. required: true components: parameters: DigitalAssistantIdPathParam: description: Unique Digital Assistant identifier. in: path name: digitalAssistantId required: true schema: type: string maxLength: 255 minLength: 1 AuthenticationProviderIdQueryParam: description: Unique Authentication Provider identifier. in: query name: id required: false schema: type: string maxLength: 255 minLength: 1 ChannelNameQueryParam: description: 'List only the information for Channels with this name. Channels names are unique and may not change. Example: `MyChannel` ' in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DigitalAssistantIdQueryParam: description: Unique Digital Assistant identifier. in: query name: id required: false schema: type: string maxLength: 255 minLength: 1 IfNoneMatchHeader: description: "The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n" in: header name: if-none-match required: false x-default-description: 'null' schema: type: string 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 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 ParameterNameQueryParam: description: List only Parameters with this name. in: query name: name required: false schema: type: string maxLength: 255 minLength: 1 ChannelSortByQueryParam: description: 'Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending, and the default sort order for `name` is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - timeUpdated - name default: timeCreated 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 OdaInstanceIdentifierPathParam: description: Unique Digital Assistant instance identifier. in: path name: odaInstanceId required: true schema: type: string maxLength: 255 minLength: 1 AuthenticationProviderIdPathParam: description: Unique Authentication Provider identifier. in: path name: authenticationProviderId required: true schema: type: string maxLength: 255 minLength: 1 TranslatorNameQueryParam: description: 'List only Translators with this name. Translator names are unique and may not change. Example: `MyTranslator` ' in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 TranslatorTypeQueryParam: description: List only Translators of this type. in: query name: type required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/TranslationService' schema: type: string enum: - GOOGLE - MICROSOFT SkillIdPathParam: description: Unique Skill identifier. in: path name: skillId required: true schema: type: string maxLength: 255 minLength: 1 SkillParameterNamePathParam: description: The name of a Skill Parameter. in: path name: parameterName required: true schema: type: string maxLength: 255 minLength: 1 BotNameQueryParam: description: 'List only Bot resources with this name. Names are unique and may not change. Example: `MySkill` ' in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 AuthenticationProviderSortByQueryParam: description: 'Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - timeUpdated - name - identityProvider 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 BotCategoryQueryParam: description: List only Bot resources with this category. in: query name: category required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 BotSortByQueryParam: description: 'Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - timeUpdated - name default: timeCreated ChannelIdPathParam: description: Unique Channel identifier. in: path name: channelId required: true schema: type: string maxLength: 255 minLength: 1 BotPlatformVersionQueryParam: description: 'List only Bot resources with this platform version. ' in: query name: platformVersion x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 LifecycleStateEnumQueryParam: description: List only the resources that are in this lifecycle state. in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED BotLifecycleDetailsQueryParam: description: 'List only Bot resources with this lifecycle details. ' in: query name: lifecycleDetails x-default-description: 'null' schema: type: string maxLength: 255 minLength: 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 ChannelIdQueryParam: description: Unique Channel identifier. in: query name: id required: false schema: type: string maxLength: 255 minLength: 1 ParameterSortByQueryParam: description: 'Sort on this field. You can specify one sort order only. The default sort field is `name`. The default sort order is ascending. ' in: query name: sortBy schema: type: string enum: - name - displayName - type default: name TranslatorSortByQueryParam: description: 'Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - timeUpdated - name - type default: timeCreated ChannelCategoryQueryParam: description: List only Channels with this category. in: query name: category required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ChannelCategory' schema: type: string enum: - AGENT - APPLICATION - BOT - BOT_AS_AGENT - SYSTEM - EVENT BotNamespaceQueryParam: description: 'List only Bot resources with this namespace. Namespaces may not change. Example: `MyNamespace` ' in: query name: namespace x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 AuthenticationProviderIdentityProviderQueryParam: description: List only Authentication Providers for this Identity Provider. in: query name: identityProvider required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/AuthenticationIdentityProvider' schema: type: string enum: - GENERIC - OAM - GOOGLE - MICROSOFT PaginationLimitQueryParam: description: The maximum number of items to return per page. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 AuthenticationProviderNameQueryParam: description: 'List only the information for Authentication Providers with this name. Authentication Provider names are unique and may not change. Example: `MyProvider` ' in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SkillIdQueryParam: description: Unique Skill identifier. in: query name: id required: false schema: type: string maxLength: 255 minLength: 1 BotVersionQueryParam: description: 'List only Bot resources with this version. Versions are unique and may not change. Example: `1.0` ' in: query name: version x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 TranslatorIdPathParam: description: Unique Translator identifier. in: path name: translatorId required: true schema: type: string maxLength: 255 minLength: 1 TranslatorIdQueryParam: description: Unique Translator identifier. in: query name: id required: false schema: type: string maxLength: 255 minLength: 1 DigitalAssistantParameterNamePathParam: description: The name of a Digital Assistant Parameter. This is unique with the Digital Assistant. in: path name: parameterName required: true schema: type: string maxLength: 255 minLength: 1 ChannelTypeQueryParam: description: List only Channels of this type. in: query name: type required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ChannelType' schema: type: string enum: - ANDROID - APPEVENT - APPLICATION - CORTANA - FACEBOOK - IOS - MSTEAMS - OSS - OSVC - SERVICECLOUD - SLACK - TEST - TWILIO - WEB - WEBHOOK schemas: SkillParameterSummary: description: Metadata for a Skill Parameter property. properties: description: description: A description of the Parameter. maxLength: 4000 minLength: 1 type: string displayName: description: The display name for the Parameter. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Parameter's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The Parameter name. This must be unique within the parent resource. maxLength: 255 minLength: 1 type: string type: description: The value type. enum: - STRING - INTEGER - FLOAT - BOOLEAN - SECURE type: string x-obmcs-top-level-enum: '#/definitions/ParameterType' value: description: The current value. The value will be interpreted based on the `type`. type: string required: - name - displayName - type - lifecycleState type: object CreateChannelDetails: description: Properties that are required to create a Channel. discriminator: propertyName: type 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: A short description of the Channel. maxLength: 400 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 name: description: 'The Channel''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 255 minLength: 1 type: string sessionExpiryDurationInMilliseconds: description: The number of milliseconds before a session expires. format: int64 maximum: 86400000 minimum: 1 type: integer type: description: The Channel type. enum: - ANDROID - APPEVENT - APPLICATION - CORTANA - FACEBOOK - IOS - MSTEAMS - OSS - OSVC - SERVICECLOUD - SLACK - TEST - TWILIO - WEB - WEBHOOK type: string x-obmcs-top-level-enum: '#/definitions/ChannelType' required: - name - type type: object DigitalAssistantParameter: allOf: - $ref: '#/components/schemas/Parameter' description: Metadata for a Digital Assistant Parameter. type: object CreateAuthenticationProviderDetails: description: Properties required to create a new Authentication Provider. properties: authorizationEndpointUrl: description: The IDPs URL for the page that users authenticate with by entering the user name and password. maxLength: 400 minLength: 1 type: string clientId: description: "The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. \nWith Microsoft identity platform, use the application ID.\n" maxLength: 255 minLength: 1 type: string clientSecret: description: "The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider \nRegistration. With Microsoft identity platform, use the application secret.\n" format: password maxLength: 400 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 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 grantType: description: The grant type for the Authentication Provider. enum: - CLIENT_CREDENTIALS - AUTHORIZATION_CODE type: string x-obmcs-top-level-enum: '#/definitions/AuthenticationGrantType' identityProvider: description: Which type of Identity Provider (IDP) you are using. enum: - GENERIC - OAM - GOOGLE - MICROSOFT type: string x-obmcs-top-level-enum: '#/definitions/AuthenticationIdentityProvider' isVisible: default: true description: Whether this Authentication Provider is visible in the ODA UI. type: boolean name: description: A name to identify the Authentication Provider. maxLength: 255 minLength: 1 type: string redirectUrl: description: The OAuth Redirect URL. maxLength: 400 minLength: 1 type: string refreshTokenRetentionPeriodInDays: description: The number of days to keep the refresh token in the Digital Assistant cache. maximum: 400 minimum: 1 type: integer revokeTokenEndpointUrl: description: "If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then \nyou need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens \ncomponent to revoke the user's tokens for this service.\n" maxLength: 400 minLength: 1 type: string scopes: description: "A space-separated list of the scopes that must be included when Digital Assistant requests an access token from \nthe provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, \ninclude the scope that’s necessary to get the refresh token (typically offline_access).\n" maxLength: 400 minLength: 1 type: string shortAuthorizationCodeRequestUrl: description: 'A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. ' maxLength: 400 minLength: 1 type: string subjectClaim: description: The access-token profile claim to use to identify the user. maxLength: 400 minLength: 1 type: string tokenEndpointUrl: description: The IDPs URL for requesting access tokens. maxLength: 400 minLength: 1 type: string required: - grantType - identityProvider - name - tokenEndpointUrl - clientId - clientSecret - scopes type: object TranslatorSummary: description: Summary of the Translator. 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 id: description: Unique immutable identifier that was assigned when the Translator was created. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Translator's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The descriptive name for this Translator. type: string 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 type: description: The Translation Service to use for this Translator. enum: - GOOGLE - MICROSOFT type: string x-obmcs-top-level-enum: '#/definitions/TranslationService' required: - id - type - name - lifecycleState - timeCreated - timeUpdated type: object DigitalAssistantCollection: description: A collection of Digital Assistant summaries. properties: items: description: The Digital Assistant summaries. items: $ref: '#/components/schemas/DigitalAssistantSummary' type: array required: - items type: object UpdateAuthenticationProviderDetails: description: Properties to update an Authentication Provider. properties: authorizationEndpointUrl: description: The IDPs URL for the page that users authenticate with by entering the user name and password. maxLength: 400 minLength: 1 type: string clientId: description: "The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. \nWith Microsoft identity platform, use the application ID.\n" maxLength: 255 minLength: 1 type: string clientSecret: description: "The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider \nRegistration. With Microsoft identity platform, use the application secret.\n" format: password maxLength: 400 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 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 redirectUrl: description: The OAuth Redirect URL. maxLength: 400 minLength: 1 type: string refreshTokenRetentionPeriodInDays: description: The number of days to keep the refresh token in the Digital Assistant cache. maximum: 400 minimum: 1 type: integer revokeTokenEndpointUrl: description: "If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then \nyou need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens \ncomponent to revoke the user's tokens for this service.\n" maxLength: 400 minLength: 1 type: string scopes: description: "A space-separated list of the scopes that must be included when Digital Assistant requests an access token from \nthe provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, \ninclude the scope that’s necessary to get the refresh token (typically offline_access).\n" maxLength: 400 minLength: 1 type: string shortAuthorizationCodeRequestUrl: description: 'A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. ' maxLength: 400 minLength: 1 type: string subjectClaim: description: The access-token profile claim to use to identify the user. maxLength: 400 minLength: 1 type: string tokenEndpointUrl: description: The IDPs URL for requesting access tokens. maxLength: 400 minLength: 1 type: string type: object AuthenticationProvider: description: Settings for the Authentication Provider. properties: authorizationEndpointUrl: description: The IDPs URL for the page that users authenticate with by entering the user name and password. maxLength: 400 minLength: 1 type: string clientId: description: "The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. \nWith Microsoft identity platform, use the application ID.\n" 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 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 grantType: description: The grant type for the Authentication Provider. enum: - CLIENT_CREDENTIALS - AUTHORIZATION_CODE type: string x-obmcs-top-level-enum: '#/definitions/AuthenticationGrantType' id: description: Unique immutable identifier that was assigned when the Authentication Provider was created. maxLength: 255 minLength: 1 type: string identityProvider: description: Which type of Identity Provider (IDP) you are using. enum: - GENERIC - OAM - GOOGLE - MICROSOFT type: string x-obmcs-top-level-enum: '#/definitions/AuthenticationIdentityProvider' isVisible: default: true description: Whether this Authentication Provider is visible in the ODA UI. type: boolean lifecycleState: description: The Authentication Provider's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: A name to identify the Authentication Provider. maxLength: 255 minLength: 1 type: string redirectUrl: description: The OAuth Redirect URL. maxLength: 400 minLength: 1 type: string refreshTokenRetentionPeriodInDays: description: The number of days to keep the refresh token in the Digital Assistant cache. maximum: 400 minimum: 1 type: integer revokeTokenEndpointUrl: description: "If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then \nyou need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens \ncomponent to revoke the user's tokens for this service.\n" maxLength: 400 minLength: 1 type: string scopes: description: "A space-separated list of the scopes that must be included when Digital Assistant requests an access token from \nthe provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, \ninclude the scope that’s necessary to get the refresh token (typically offline_access).\n" maxLength: 400 minLength: 1 type: string shortAuthorizationCodeRequestUrl: description: 'A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones. ' maxLength: 400 minLength: 1 type: string subjectClaim: description: The access-token profile claim to use to identify the user. maxLength: 400 minLength: 1 type: string 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 tokenEndpointUrl: description: The IDPs URL for requesting access tokens. maxLength: 400 minLength: 1 type: string required: - id - grantType - identityProvider - name - tokenEndpointUrl - clientId - scopes - isVisible - lifecycleState - timeCreated - timeUpdated type: object StorageLocation: description: Properties that point to a specific object in Object Storage. properties: bucketName: description: The name of the bucket. type: string compartmentId: description: The unique identifier for the compartment. type: string namespaceName: description: The Object Storage namespace. type: string objectName: description: The name of the object. maxLength: 1024 minLength: 1 type: string regionId: description: The region id. type: string required: - regionId - compartmentId - namespaceName - bucketName - objectName CreateSkillDetails: description: Properties that are required to create a Skill. discriminator: propertyName: kind properties: category: description: The resource's category. This is used to group resource's together. maxLength: 100 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: A short description of the resource. 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 kind: description: How to create the Skill. enum: - NEW - CLONE - VERSION - EXTEND type: string x-obmcs-top-level-enum: '#/definitions/CreateBotKind' multilingualMode: description: The multilingual mode for the resource. enum: - NATIVE - TRANSLATION type: string x-obmcs-top-level-enum: '#/definitions/BotMultilingualMode' platformVersion: description: The ODA Platform Version for this resource. maxLength: 55 minLength: 1 type: string primaryLanguageTag: description: The primary language for the resource. maxLength: 255 minLength: 1 type: string required: - kind type: object ExportDigitalAssistantDetails: allOf: - $ref: '#/components/schemas/ExportBotDetails' description: Properties that specify where in Object Storage to export the Digital Assistant to. type: object DigitalAssistantParameterValue: description: Properties for configuring a Parameter in a Digital Assistant instance. properties: name: description: The Parameter name. This must be unique within the parent resource. maxLength: 255 minLength: 1 type: string type: description: The value type. enum: - STRING - INTEGER - FLOAT - BOOLEAN - SECURE type: string x-obmcs-top-level-enum: '#/definitions/ParameterType' value: description: The current value. The value will be interpreted based on the `type`. type: string required: - name - type - value type: object Translator: description: The properties for a Translator. properties: baseUrl: description: The base URL for invoking the Translation Service. 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 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 Translator was created. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Translator's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The descriptive name for this Translator. type: string properties: additionalProperties: type: string description: 'Properties used when invoking the translation service. Each property is a simple key-value pair. ' 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 type: description: The Translation Service to use for this Translator. enum: - GOOGLE - MICROSOFT type: string x-obmcs-top-level-enum: '#/definitions/TranslationService' required: - id - type - name - baseUrl - lifecycleState - timeCreated - timeUpdated type: object CreateSkillParameterDetails: description: Properties that are required to create a Skill Parameter. properties: description: description: A description of the Parameter. maxLength: 4000 minLength: 1 type: string displayName: description: The display name for the Parameter. maxLength: 255 minLength: 1 type: string name: description: The Parameter name. This must be unique within the parent resource. maxLength: 255 minLength: 1 type: string type: description: The value type. enum: - STRING - INTEGER - FLOAT - BOOLEAN - SECURE type: string x-obmcs-top-level-enum: '#/definitions/ParameterType' value: description: The current value. The value will be interpreted based on the `type`. type: string required: - name - displayName - type - value type: object Channel: description: Properties of a Channel. discriminator: propertyName: type properties: category: description: The category of the Channel. enum: - AGENT - APPLICATION - BOT - BOT_AS_AGENT - SYSTEM - EVENT type: string x-obmcs-top-level-enum: '#/definitions/ChannelCategory' 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: A short description of the Channel. maxLength: 400 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 Channel was created. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Channel's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: 'The Channel''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 255 minLength: 1 type: string sessionExpiryDurationInMilliseconds: description: The number of milliseconds before a session expires. format: int64 maximum: 86400000 minimum: 1 type: integer 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 type: description: The Channel type. enum: - ANDROID - APPEVENT - APPLICATION - CORTANA - FACEBOOK - IOS - MSTEAMS - OSS - OSVC - SERVICECLOUD - SLACK - TEST - TWILIO - WEB - WEBHOOK type: string x-obmcs-top-level-enum: '#/definitions/ChannelType' required: - id - name - category - type - lifecycleState - timeCreated - timeUpdated type: object ImportBotDetails: description: Properties to import a Bot resource from Object Storage. properties: source: $ref: '#/components/schemas/StorageLocation' required: - source type: object Bot: description: Metadata for a Bot resource. properties: baseId: description: The unique identifier for the base reource (when this resource extends another). maxLength: 255 minLength: 1 type: string category: description: The resource's category. This is used to group resource's together. maxLength: 100 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: A short description of the resource. maxLength: 255 minLength: 1 type: string displayName: description: 'The resource''s display name. ' 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 resource was created. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: The resource's publish state. enum: - PUBLISHED - DRAFT type: string x-obmcs-top-level-enum: '#/definitions/BotPublishState' lifecycleState: description: The resource's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' multilingualMode: description: The multilingual mode for the resource. enum: - NATIVE - TRANSLATION type: string x-obmcs-top-level-enum: '#/definitions/BotMultilingualMode' name: description: 'The reource''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 100 minLength: 1 type: string namespace: description: The resource's namespace. maxLength: 100 minLength: 1 type: string nativeLanguageTags: description: A list of native languages supported by this resource. items: type: string minItems: 1 type: array platformVersion: description: The ODA Platform Version for this resource. maxLength: 55 minLength: 1 type: string primaryLanguageTag: description: The primary language for the resource. maxLength: 255 minLength: 1 type: string 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 version: default: '1.0' description: 'The resource''s version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. ' maxLength: 100 minLength: 1 type: string required: - id - name - version - displayName - lifecycleState - lifecycleDetails - platformVersion - timeCreated - timeUpdated type: object DigitalAssistantParameterSummary: description: Metadata for a Digital Assistant Parameter property. properties: description: description: A description of the Parameter. maxLength: 4000 minLength: 1 type: string displayName: description: The display name for the Parameter. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Parameter's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The Parameter name. This must be unique within the parent resource. maxLength: 255 minLength: 1 type: string type: description: The value type. enum: - STRING - INTEGER - FLOAT - BOOLEAN - SECURE type: string x-obmcs-top-level-enum: '#/definitions/ParameterType' value: description: The current value. The value will be interpreted based on the `type`. type: string required: - name - displayName - type - lifecycleState SkillParameterCollection: description: A collection of Skill Parameter summaries. properties: items: description: The Skill Parameter summaries. items: $ref: '#/components/schemas/SkillParameterSummary' type: array required: - items type: object TranslatorCollection: description: A collection of Translator summaries. properties: items: description: The Translator summaries. items: $ref: '#/components/schemas/TranslatorSummary' type: array required: - items type: object DigitalAssistantParameterCollection: description: A collection of Digital Assistant Parameter summaries. properties: items: description: The Digital Assistant Parameter summaries. items: $ref: '#/components/schemas/DigitalAssistantParameterSummary' type: array required: - items type: object UpdateDigitalAssistantDetails: description: Properties to update a Digital Assistant. properties: category: description: The resource's category. This is used to group resource's together. maxLength: 100 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: A short description of the resource. 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 UpdateSkillDetails: description: Properties to update a Skill. properties: category: description: The resource's category. This is used to group resource's together. maxLength: 100 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: A short description of the resource. 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 DigitalAssistant: allOf: - $ref: '#/components/schemas/Bot' description: Digital Assistant metadata. type: object UpdateDigitalAssistantParameterDetails: description: Properties to update a Digital Assistant Parameter. properties: value: description: The current value. The value will be interpreted based on the `type`. type: string required: - value type: object ConfigureDigitalAssistantParametersDetails: description: Properties for configuring the Digital Assistant Parameters in a Digital Assistant instance. properties: parameters: description: The values to use to configure the Digital Assistant Parameters. items: $ref: '#/components/schemas/DigitalAssistantParameterValue' type: array required: - parameters type: object CreateChannelResult: description: Properties of a Channel. discriminator: propertyName: type properties: category: description: The category of the Channel. enum: - AGENT - APPLICATION - BOT - BOT_AS_AGENT - SYSTEM - EVENT type: string x-obmcs-top-level-enum: '#/definitions/ChannelCategory' 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: A short description of the Channel. maxLength: 400 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 Channel was created. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Channel's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: 'The Channel''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 255 minLength: 1 type: string sessionExpiryDurationInMilliseconds: description: The number of milliseconds before a session expires. format: int64 maximum: 86400000 minimum: 1 type: integer 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 type: description: The Channel type. enum: - ANDROID - APPEVENT - APPLICATION - CORTANA - FACEBOOK - IOS - MSTEAMS - OSS - OSVC - SERVICECLOUD - SLACK - TEST - TWILIO - WEB - WEBHOOK type: string x-obmcs-top-level-enum: '#/definitions/ChannelType' required: - id - name - category - type - lifecycleState - timeCreated - timeUpdated type: object CreateDigitalAssistantDetails: description: Properties that are required to create a Digital Assistant. discriminator: propertyName: kind properties: category: description: The resource's category. This is used to group resource's together. maxLength: 100 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: A short description of the resource. 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 kind: description: How to create the Digital Assistant. enum: - NEW - CLONE - VERSION - EXTEND type: string x-obmcs-top-level-enum: '#/definitions/CreateBotKind' multilingualMode: description: The multilingual mode for the resource. enum: - NATIVE - TRANSLATION type: string x-obmcs-top-level-enum: '#/definitions/BotMultilingualMode' platformVersion: description: The ODA Platform Version for this resource. maxLength: 55 minLength: 1 type: string primaryLanguageTag: description: The primary language for the resource. maxLength: 255 minLength: 1 type: string required: - kind type: object ExportBotDetails: description: Properties to export a Bot to Object Storage. properties: target: $ref: '#/components/schemas/StorageLocation' required: - target type: object ChannelSummary: description: Summary of the Channel. properties: category: description: The category of the Channel. enum: - AGENT - APPLICATION - BOT - BOT_AS_AGENT - SYSTEM - EVENT type: string x-obmcs-top-level-enum: '#/definitions/ChannelCategory' 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: A short description of the Channel. maxLength: 400 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 Channel was created. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Channel's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: 'The Channel''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 255 minLength: 1 type: string 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 type: description: The Channel type. enum: - ANDROID - APPEVENT - APPLICATION - CORTANA - FACEBOOK - IOS - MSTEAMS - OSS - OSVC - SERVICECLOUD - SLACK - TEST - TWILIO - WEB - WEBHOOK type: string x-obmcs-top-level-enum: '#/definitions/ChannelType' required: - id - name - category - type - lifecycleState - timeCreated - timeUpdated type: object UpdateSkillParameterDetails: description: Properties to update a Skill Parameter. properties: description: description: A description of the Parameter. maxLength: 4000 minLength: 1 type: string displayName: description: The display name for the Parameter. maxLength: 255 minLength: 1 type: string value: description: The current value. The value will be interpreted based on the `type`. type: string type: object UpdateChannelDetails: description: Properties to update a Channel. discriminator: propertyName: type 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: A short description of the Channel. maxLength: 400 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 name: description: 'The Channel''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 255 minLength: 1 type: string sessionExpiryDurationInMilliseconds: description: The number of milliseconds before a session expires. format: int64 maximum: 86400000 minimum: 1 type: integer type: description: The Channel type. enum: - ANDROID - APPEVENT - APPLICATION - CORTANA - FACEBOOK - IOS - MSTEAMS - OSS - OSVC - SERVICECLOUD - SLACK - TEST - TWILIO - WEB - WEBHOOK type: string x-obmcs-top-level-enum: '#/definitions/ChannelType' required: - type type: object DigitalAssistantSummary: description: Summary of a Digital Assistant. properties: category: description: The resource's category. This is used to group resource's together. maxLength: 100 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 displayName: description: 'The resource''s display name. ' 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 resource was created. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: The resource's publish state. enum: - PUBLISHED - DRAFT type: string x-obmcs-top-level-enum: '#/definitions/BotPublishState' lifecycleState: description: The resource's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: 'The reource''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 100 minLength: 1 type: string namespace: description: The resource's namespace. maxLength: 100 minLength: 1 type: string platformVersion: description: The ODA Platform Version for this resource. maxLength: 55 minLength: 1 type: string 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 version: default: '1.0' description: 'The resource''s version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. ' maxLength: 100 minLength: 1 type: string required: - id - name - version - displayName - namespace - category - lifecycleState - lifecycleDetails - platformVersion - timeCreated - timeUpdated type: object ExportSkillDetails: allOf: - $ref: '#/components/schemas/ExportBotDetails' description: Properties that specify where in Object Storage to export the Skill to. type: object AuthenticationProviderSummary: description: Summary of the Authentication Provider. 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 grantType: description: The grant type for the Authentication Provider. enum: - CLIENT_CREDENTIALS - AUTHORIZATION_CODE type: string x-obmcs-top-level-enum: '#/definitions/AuthenticationGrantType' id: description: Unique immutable identifier that was assigned when the Authentication Provider was created. maxLength: 255 minLength: 1 type: string identityProvider: description: Which type of Identity Provider (IDP) you are using. enum: - GENERIC - OAM - GOOGLE - MICROSOFT type: string x-obmcs-top-level-enum: '#/definitions/AuthenticationIdentityProvider' lifecycleState: description: The Authentication Provider's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: A name to identify the Authentication Provider. maxLength: 255 minLength: 1 type: string 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 required: - id - grantType - identityProvider - name - lifecycleState - timeCreated - timeUpdated type: object ChannelCollection: description: A collection of Channel summaries. properties: items: description: The Channel summaries. items: $ref: '#/components/schemas/ChannelSummary' type: array required: - items type: object Parameter: description: Metadata for a Parameter. properties: description: description: A description of the Parameter. maxLength: 4000 minLength: 1 type: string displayName: description: The display name for the Parameter. maxLength: 255 minLength: 1 type: string lifecycleState: description: The Parameter's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The Parameter name. This must be unique within the parent resource. maxLength: 255 minLength: 1 type: string type: description: The value type. enum: - STRING - INTEGER - FLOAT - BOOLEAN - SECURE type: string x-obmcs-top-level-enum: '#/definitions/ParameterType' value: description: The current value. The value will be interpreted based on the `type`. type: string required: - name - displayName - type - value - lifecycleState type: object Skill: allOf: - $ref: '#/components/schemas/Bot' description: Skill metadata. 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 SkillSummary: description: Summary of a Skill. properties: category: description: The resource's category. This is used to group resource's together. maxLength: 100 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 displayName: description: 'The resource''s display name. ' 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 resource was created. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: The resource's publish state. enum: - PUBLISHED - DRAFT type: string x-obmcs-top-level-enum: '#/definitions/BotPublishState' lifecycleState: description: The resource's current state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: 'The reource''s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. ' maxLength: 100 minLength: 1 type: string namespace: description: The resource's namespace. maxLength: 100 minLength: 1 type: string platformVersion: description: The ODA Platform Version for this resource. maxLength: 55 minLength: 1 type: string 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 version: default: '1.0' description: 'The resource''s version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number. ' maxLength: 100 minLength: 1 type: string required: - id - name - version - displayName - namespace - category - lifecycleState - lifecycleDetails - platformVersion - timeCreated - timeUpdated type: object AuthenticationProviderCollection: description: A collection of Authentication Provider summaries. properties: items: description: The Authentication Provider summaries. items: $ref: '#/components/schemas/AuthenticationProviderSummary' type: array required: - items type: object SkillCollection: description: A collection of Skill summaries. properties: items: description: The Skill summaries. items: $ref: '#/components/schemas/SkillSummary' type: array required: - items type: object SkillParameter: allOf: - $ref: '#/components/schemas/Parameter' description: Metadata for a Skill Parameter. type: object CreateTranslatorDetails: description: Properties that are required to create a Translator. properties: authToken: description: The authentication token to use when invoking the Translation Service format: password maxLength: 400 minLength: 1 type: string baseUrl: description: The base URL for invoking the Translation Service. 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 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 properties: additionalProperties: type: string description: 'Properties used when invoking the translation service. Each property is a simple key-value pair. ' type: object type: description: The Translation Service to use for this Translator. enum: - GOOGLE - MICROSOFT type: string x-obmcs-top-level-enum: '#/definitions/TranslationService' required: - type - baseUrl - authToken type: object UpdateTranslatorDetails: description: Properties to update a Translator. properties: authToken: description: The authentication token to use when invoking the Translation Service format: password maxLength: 400 minLength: 1 type: string baseUrl: description: The base URL for invoking the Translation Service. 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 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 properties: additionalProperties: type: string description: 'Properties used when invoking the translation service. Each property is a simple key-value pair. ' type: object type: object 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