openapi: 3.2.0
info:
  description: API to create and maintain Oracle Digital Assistant service instances.
  title: Digital Assistant Service Instance Odapackage 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: odapackage
paths:
  /odaInstances/{odaInstanceId}/importedPackages:
    get:
      description: 'Returns a list of summaries for imported packages in the instance.

        '
      operationId: ListImportedPackages
      parameters:
      - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of `ImportedPackageSummary` 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
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ImportedPackageSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List packages that have been imported into the given instance.
      tags:
      - odapackage
    post:
      description: 'Starts an asynchronous job to import a package into a Digital Assistant instance.


        To monitor the status of the job, take the `opc-work-request-id` response

        header value and use it to call `GET /workRequests/{workRequestId}`.

        '
      operationId: CreateImportedPackage
      parameters:
      - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to import a package into a Digital Assistant instance was accepted. The response

            includes metadata that describes the imported package, but

            the package won''t be ready for use until the asynchronous ''import skills'' job completes.

            Until the job completes, the metadata for the imported package might not be complete.

            '
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status

                of the operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportedPackage'
        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 Package into Digital Assistant Instance
      tags:
      - odapackage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImportedPackageDetails'
        description: Parameter values required to import the package.
        required: true
  /odaInstances/{odaInstanceId}/importedPackages/{packageId}:
    delete:
      description: 'Starts an asynchronous job to delete a package from a Digital Assistant instance.


        To monitor the status of the job, take the `opc-work-request-id` response

        header value and use it to call `GET /workRequests/{workRequestId}`.

        '
      operationId: DeleteImportedPackage
      parameters:
      - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/PackageIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to delete a package from a Digital Assistant instance was accepted. The response

            includes metadata that describes the imported package, but

            the package won''t be ready for use until the asynchronous ''import skills'' job completes.

            Until the job completes, the metadata for the instance might not be complete.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status

                of the operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete Package from Digital Assistant Instance
      tags:
      - odapackage
      x-related-resource: '#/definitions/ImportedPackage'
    get:
      description: 'Returns a list of summaries for imported packages in the instance.

        '
      operationId: GetImportedPackage
      parameters:
      - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/PackageIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: An `ImportedPackage` 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/ImportedPackage'
        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 details for a package that has been imported into the given instance.
      tags:
      - odapackage
    put:
      description: 'Starts an asynchronous job to update a package within a Digital Assistant instance.


        To monitor the status of the job, take the `opc-work-request-id` response

        header value and use it to call `GET /workRequests/{workRequestId}`.

        '
      operationId: UpdateImportedPackage
      parameters:
      - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/PackageIdentifierPathParam'
      - $ref: '#/components/parameters/IsReplaceSkillsQueryParmm'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to update a package within a Digital Assistant instance was accepted. The response

            includes metadata that describes the imported package, but

            the package won''t be ready for use until the asynchronous ''update skills'' job completes.

            Until the job completes, the metadata for the instance might not be complete.

            '
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status

                of the operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportedPackage'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update Package that has been imported into a Digital Assistant Instance
      tags:
      - odapackage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateImportedPackageDetails'
        description: Parameter values required to import the package, with updated values.
        required: true
  /odaInstances/{odaInstanceId}/packages/{packageId}:
    get:
      description: 'Returns details about a package, and how to import it.

        '
      operationId: GetPackage
      parameters:
      - $ref: '#/components/parameters/OdaInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/PackageIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A `Package` object.
          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/Package'
        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 details for a given package
      tags:
      - odapackage
  /packages:
    get:
      description: 'Returns a page of summaries for packages that are available for import. The optional odaInstanceId query

        parameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId

        query parameter is not provided, the returned list will

        include packages available within the region indicated by the request URL. The optional resourceType query

        param may be specified to filter packages that contain the indicated resource type. If no resourceType query

        param is given, packages containing all resource types will be returned. The optional name query parameter can

        be used to limit the list to packages whose name matches the given name. The optional displayName query

        parameter can be used to limit the list to packages whose displayName matches the given name. The optional

        isLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version

        of any given package. If not specified, all versions of any otherwise matching package will be returned.


        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: ListPackages
      parameters:
      - $ref: '#/components/parameters/OdaInstanceQueryParam'
      - $ref: '#/components/parameters/ResourceTypeQueryParam'
      - $ref: '#/components/parameters/PackageCompartmentIdQueryParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/IsLatestVersionOnlyQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of `PackageSummary` objects.
          headers:
            opc-next-page:
              description: 'When you are paging through a list, if this header appears in the response,

                then there might be additional items still to get. Include this value as the

                `page` query parameter for the subsequent GET request.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-total-items:
              description: 'The total number of results that match the query.

                '
              schema:
                type: integer
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PackageSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List packages available for import
      tags:
      - odapackage
components:
  parameters:
    IsReplaceSkillsQueryParmm:
      description: Should old skills be replaced by new skills if packageId differs from already imported package?
      in: query
      name: isReplaceSkills
      schema:
        type: boolean
        default: false
    NameQueryParam:
      description: 'List only the information for the package with this name. Package names are unique to a publisher and may not change.


        Example: `My Package`

        '
      in: query
      name: name
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    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
    SortByQueryParam:
      description: 'Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.


        The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
        default: TIMECREATED
    PackageCompartmentIdQueryParam:
      description: List the packages that belong to this compartment.
      in: query
      name: compartmentId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PackageIdentifierPathParam:
      description: Unique Digital Assistant package identifier.
      in: path
      name: packageId
      required: true
      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
    IfMatchHeader:
      description: 'For optimistic concurrency control in a PUT or DELETE call for

        a Digital Assistant instance, set the `if-match` query parameter

        to the value of the `ETAG` header from a previous GET or POST

        response for that instance. The service updates or deletes the

        instance only if the etag that you provide matches the instance''s

        current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return per page.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    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
    OdaInstanceQueryParam:
      description: List only the information for this Digital Assistant instance.
      in: query
      name: odaInstanceId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    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
    IsLatestVersionOnlyQueryParam:
      description: Should we return only the latest version of a package (instead of all versions)?
      in: query
      name: isLatestVersionOnly
      schema:
        type: boolean
        default: false
    DisplayNameQueryParam:
      description: 'List only the information for the Digital Assistant instance with this user-friendly name. These names don''t have to be unique and may change.


        Example: `My new resource`

        '
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    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
    ResourceTypeQueryParam:
      description: Resource type identifier. Used to limit query results to the items which are applicable to the given type.
      in: query
      name: resourceType
      schema:
        type: string
        default: oracle_da_skills
        maxLength: 255
        minLength: 1
  schemas:
    CreateImportedPackageDetails:
      description: Payload for creating an imported package
      properties:
        currentPackageId:
          description: ID of the package to import.
          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
        parameterValues:
          additionalProperties:
            type: string
          description: A list of parameter values to use when importing the given package. Must match those defined in the import contract.
          type: object
      required:
      - currentPackageId
      type: object
    PackageSummary:
      description: Summary of `Package` object.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. The value must be a string, an integer, or a boolean types.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: Description of the package.
          maxLength: 512
          minLength: 1
          type: string
        displayName:
          description: Display name for the package (displayed in UI and user-facing applications).
          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 Package was registered.
          maxLength: 255
          minLength: 1
          type: string
        name:
          description: Name of package.
          maxLength: 255
          minLength: 1
          type: string
        publisherId:
          description: 'ID of the publisher providing the package.

            '
          maxLength: 255
          minLength: 1
          type: string
        publisherMetadata:
          description: A map of metadata key/value pairs that further describes the publisher and the platform in which the package might be used.
          items:
            $ref: '#/components/schemas/MetadataProperty'
          maxItems: 1000
          minItems: 0
          type: array
        resourceTypes:
          description: A list of resource types describing the content of the package.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        resourceTypesMetadata:
          description: A map of resource type to metadata key/value map that further describes the content for the resource types in this package.. Keys are resource type names, values are a map of name/value pairs per resource type.
          items:
            $ref: '#/components/schemas/ResourceTypeMetadata'
          maxItems: 100
          minItems: 1
          type: array
        timePublished:
          description: When the package was last published. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
          format: date-time
          type: string
        version:
          description: Version of the package.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - publisherId
      - name
      - displayName
      - version
      - timePublished
      - description
      - resourceTypes
      - resourceTypesMetadata
      - publisherMetadata
      type: object
    ImportedPackage:
      description: An imported/instantiated package within an instance.
      properties:
        currentPackageId:
          description: ID of the package.
          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
        displayName:
          description: Display name of the package (can change across versions).
          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
        name:
          description: Stable name of the package (the same across versions).
          maxLength: 255
          minLength: 1
          type: string
        odaInstanceId:
          description: ID of the host instance.
          maxLength: 255
          minLength: 1
          type: string
        parameterValues:
          additionalProperties:
            type: string
          description: A list of parameter values used to import the package.
          type: object
        status:
          description: Status of the imported package.
          enum:
          - READY
          - OPERATION_PENDING
          - FAILED
          type: string
        statusMessage:
          description: Short message explaining the status of this imported package.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: When the imported package 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 imported package 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:
          description: version of the package.
          maxLength: 50
          minLength: 1
          type: string
      required:
      - odaInstanceId
      - currentPackageId
      - name
      - displayName
      - version
      - status
      - timeCreated
      - timeUpdated
      - statusMessage
      - parameterValues
      type: object
    DefaultParameterValues:
      description: Default values for parameters required to import a package
      properties:
        resourceTypesDefaultParameterValues:
          description: A list of resource type specific default parameter values, one set for each resource type listed in the package definition.
          items:
            $ref: '#/components/schemas/ResourceTypeDefaultParameterValues'
          maxItems: 100
          minItems: 1
          type: array
      type: object
    ImportedPackageSummary:
      description: A summary of an imported/instantiated package within an instance.
      properties:
        currentPackageId:
          description: ID of the package.
          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
        displayName:
          description: Display name of the package (can change across versions).
          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
        name:
          description: Stable name of the package (the same across versions).
          maxLength: 255
          minLength: 1
          type: string
        odaInstanceId:
          description: ID of the host instance.
          maxLength: 255
          minLength: 1
          type: string
        status:
          description: Status of the imported package.
          type: string
          x-obmcs-enumref: '#/definitions/ImportedPackage/status'
        timeCreated:
          description: When the imported package 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 imported package 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:
          description: version of the package.
          maxLength: 50
          minLength: 1
          type: string
      required:
      - odaInstanceId
      - currentPackageId
      - name
      - displayName
      - version
      - status
      - timeCreated
      - timeUpdated
      type: object
    ResourceTypeMetadata:
      description: Describes resources of a given type within a package.
      properties:
        properties:
          description: Any properties needed to describe the content and its usage for this resource type, and within the containing package.
          items:
            $ref: '#/components/schemas/MetadataProperty'
          maxItems: 1000
          minItems: 0
          type: array
        resourceType:
          description: The type of the resource described by this metadata object.
          type: string
      type: object
    Package:
      description: Details of `Package` object.
      properties:
        defaultParameterValues:
          $ref: '#/components/schemas/DefaultParameterValues'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. The value must be a string, an integer, or a boolean types.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: Description of the package.
          maxLength: 512
          minLength: 1
          type: string
        displayName:
          description: Display name for the package (displayed in UI and user-facing applications).
          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 Package was registered.
          maxLength: 255
          minLength: 1
          type: string
        importContract:
          $ref: '#/components/schemas/ImportContract'
        name:
          description: Name of package.
          maxLength: 255
          minLength: 1
          type: string
        publisherId:
          description: 'ID of the publisher providing the package.

            '
          maxLength: 255
          minLength: 1
          type: string
        publisherMetadata:
          description: A map of metadata key/value pairs that further describes the publisher and the platform in which the package might be used.
          items:
            $ref: '#/components/schemas/MetadataProperty'
          maxItems: 1000
          minItems: 0
          type: array
        resourceTypes:
          description: A list of resource types describing the content of the package.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        resourceTypesMetadata:
          description: A map of resource type to metadata key/value map that further describes the content for the resource types in this package.. Keys are resource type names, values are a map of name/value pairs per resource type.
          items:
            $ref: '#/components/schemas/ResourceTypeMetadata'
          maxItems: 100
          minItems: 1
          type: array
        timePublished:
          description: When the package was last published. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
          format: date-time
          type: string
        timeUploaded:
          description: When the package was uploaded. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
          format: date-time
          type: string
        version:
          description: Version of the package.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - publisherId
      - name
      - displayName
      - version
      - timePublished
      - timeUploaded
      - description
      - resourceTypes
      - resourceTypesMetadata
      - publisherMetadata
      - importContract
      - defaultParameterValues
      type: object
    ParameterDefinition:
      description: A parameter to a resource.
      properties:
        defaultValue:
          description: Default value for the parameter.
          maxLength: 2048
          minLength: 1
          type: string
        description:
          description: Description of the parameter.
          maxLength: 512
          minLength: 1
          type: string
        direction:
          description: Is this parameter an input parameter, output parameter, or both?
          enum:
          - INPUT
          - OUTPUT
          type: string
        isRequired:
          description: Is this parameter required. Ignored for parameters with direction = OUTPUT.
          type: boolean
        isSensitive:
          description: Is the data for this parameter sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.)
          type: boolean
        maxLength:
          default: 255
          description: Used for character string types such as STRING to constrain the length of the value
          type: integer
        minLength:
          default: 0
          description: Used for character string types such as STRING to constrain the length of the value
          type: integer
        name:
          description: The name of the parameter
          maxLength: 255
          minLength: 1
          type: string
        pattern:
          description: Regular expression used to validate the value of a string type such as STRING
          maxLength: 400
          type: string
        resourceTypeMetadata:
          description: Any configuration needed to help the resource type process this parameter (e.g. link to manifest, etc.).
          type: object
        type:
          description: Enumerated parameter type.
          enum:
          - STRING
          - URI
          - URL
          - NUMBER
          - BOOLEAN
          - PARAMETERIZED_STRING
          type: string
        uiPlacementHint:
          description: A forward-slash-delimited 'path' in an imaginary hierarchy, at which this parameter's UI widgets should be placed
          maxLength: 2048
          type: string
      required:
      - name
      - type
      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
    UpdateImportedPackageDetails:
      description: Payload for updating an imported package
      properties:
        currentPackageId:
          description: ID of the new package (i.e. version) to import, replacing the old imported package. Leave null if no new package resources are required. The name of the new package must must match the name of the already-imported package.
          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
        parameterValues:
          additionalProperties:
            type: string
          description: A list of the updated parameter values to apply to this imported package.
          type: object
      required:
      - currentPackageId
      - parameterValues
      type: object
    ResourceTypeImportContract:
      description: The contract guiding the import experience for the consumer and behavior of the resource provider for a single resourceType.
      properties:
        parameters:
          description: A list of definitions for parameters that are required to import this package into a target instance.
          items:
            $ref: '#/components/schemas/ParameterDefinition'
          maxItems: 1000
          minItems: 0
          type: array
        resourceType:
          description: The type of resource to which this resourceType-specific contract applies
          type: string
      required:
      - resourceType
      - parameters
      type: object
    ResourceTypeDefaultParameterValues:
      description: Default values needed to import a resource type for a package.
      properties:
        parameterValues:
          additionalProperties:
            type: string
          description: A list of parameter values used to import the package.
          type: object
        resourceType:
          description: The type of resource to which these resourceType-specific parameter values apply
          type: string
      required:
      - resourceType
      - parameterValues
      type: object
    ImportContract:
      description: The contract guiding the import experience for the consumer and behavior of the resource providers for all resource types in a package.
      properties:
        importContract:
          description: A list of resource type specific import contracts, one for each resource type listed in the package definition.
          items:
            $ref: '#/components/schemas/ResourceTypeImportContract'
          maxItems: 100
          minItems: 1
          type: array
      type: object
    MetadataProperty:
      description: Property to describe and object.
      properties:
        name:
          description: Name of property.
          maxLength: 255
          minLength: 1
          type: string
        value:
          description: Value for the property.
          maxLength: 2048
          minLength: 1
          type: string
      required:
      - name
      - value
      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