openapi: 3.2.0
info:
  description: 'Use the Service Catalog API to manage solutions in Oracle Cloud Infrastructure Service Catalog.

    For more information, see [Overview of Service Catalog](/iaas/Content/service-catalog/overview_of_service_catalog.htm).

    '
  title: Service Catalog API
  version: '20210527'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/7331af53a6aec7acddb0f95d1824085c07535cff7d30f5d256174b4e14523d47.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Service Catalog 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/7331af53a6aec7acddb0f95d1824085c07535cff7d30f5d256174b4e14523d47.yaml
    what: the harvested document for Service Catalog API
servers:
- url: http://localhost:24000/20210527
- url: https://localhost:24000/20210527
tags:
- name: serviceCatalog
paths:
  /applications:
    get:
      description: 'Lists all the applications in a service catalog or a tenancy.

        If no parameter is specified, all catalogs from all compartments in

        the tenancy will be scanned for any type of content.

        '
      operationId: ListApplications
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ServiceCatalogIdQueryParam'
      - $ref: '#/components/parameters/EntityTypeFilterQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/DisplayNameFilterQueryParam'
      - $ref: '#/components/parameters/EntityIdQueryParam'
      - $ref: '#/components/parameters/PublisherIdQueryParam'
      - $ref: '#/components/parameters/PackageTypeFilterQueryParam'
      - $ref: '#/components/parameters/PricingFilterQueryParam'
      - $ref: '#/components/parameters/FeaturedFilterQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: The operation to list all the applications in a service catalog succeeded.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/ApplicationCollection'
        '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/DefaultError'
      summary: Lists the applications in a catalog or a tenancy.
      tags:
      - serviceCatalog
      x-example: 'GET /20210527/applications?compartmentId=<var>&lt;compartmentId&gt;</var>

        Host: servicecatalog.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ApplicationSummary'
  /privateApplicationPackages:
    get:
      description: Lists the packages in the specified private application.
      operationId: ListPrivateApplicationPackages
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationIdRequiredQueryParam'
      - $ref: '#/components/parameters/PrivateApplicationPackageIdQueryParam'
      - $ref: '#/components/parameters/PackageTypeQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PrivateApplicationPackageSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/DisplayNameFilterQueryParam'
      responses:
        '200':
          description: List of all packages of a given private application.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/PrivateApplicationPackageCollection'
        '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/DefaultError'
      summary: Lists the packages in a private application.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplicationPackage'
  /privateApplicationPackages/{privateApplicationPackageId}:
    get:
      description: Gets the details of a specific package within a given private application.
      operationId: GetPrivateApplicationPackage
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationPackageIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The requested private application package version.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/PrivateApplicationPackage'
        '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/DefaultError'
      summary: Gets the details of a specified private application package.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplicationPackage'
  /privateApplicationPackages/{privateApplicationPackageId}/actions/downloadConfig:
    get:
      description: Downloads the configuration that was used to create the private application package.
      operationId: GetPrivateApplicationPackageActionDownloadConfig
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationPackageIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: 'Configuration payload as a binary stream. This can represent a zip file or some other binary format,

            that was used to create this package.

            '
          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/zip:
              schema:
                format: binary
                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/DefaultError'
      summary: Downloads the configuration of a private application package.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplicationPackage'
  /privateApplications:
    get:
      description: Lists all the private applications in a given compartment.
      operationId: ListPrivateApplications
      parameters:
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/PrivateApplicationIdQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PrivateApplicationSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/DisplayNameFilterQueryParam'
      responses:
        '200':
          description: List of all private applications.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/PrivateApplicationCollection'
        '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/DefaultError'
      summary: List all private applications.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplication'
    post:
      description: Creates a private application along with a single package to be hosted.
      operationId: CreatePrivateApplication
      parameters:
      - $ref: '#/components/parameters/OpcRetryTokenHeaderParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '202':
          description: The operation to create a private application succeeded.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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 asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateApplication'
        '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/DefaultError'
      summary: Creates a private application.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplication'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePrivateApplicationDetails'
        description: Private application creation details.
        required: true
  /privateApplications/{privateApplicationId}:
    delete:
      description: Deletes an existing private application.
      operationId: DeletePrivateApplication
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '202':
          description: The request to delete a private application 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 asynchronous 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/DefaultError'
      summary: Deletes a private application.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplication'
    get:
      description: Gets the details of the specified private application.
      operationId: GetPrivateApplication
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The details of the requested private application.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/PrivateApplication'
        '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/DefaultError'
      summary: Gets a private application.
      tags:
      - serviceCatalog
      x-example: 'GET /20210527/privateApplications/<var>&lt;privateApplicationId&gt;</var>

        Host: osc.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/PrivateApplication'
    put:
      description: Updates the details of an existing private application.
      operationId: UpdatePrivateApplication
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      responses:
        '202':
          description: The request to update a private application accepted.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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 asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateApplication'
        '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/DefaultError'
      summary: Updates an existing private application.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplication'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePrivateApplicationDetails'
        description: The details for updating the private application.
        required: true
  /privateApplications/{privateApplicationId}/actions/changeCompartment:
    post:
      description: Moves the specified private application from one compartment to another.
      operationId: ChangePrivateApplicationCompartment
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      responses:
        '202':
          description: The request to change the compartment of a private application 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 asynchronous 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/DefaultError'
      summary: Changes the compartment of the private application.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplication'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePrivateApplicationCompartmentDetails'
        description: The details of the request to change the compartment of a given private application.
        required: true
  /privateApplications/{privateApplicationId}/actions/downloadLogo:
    get:
      description: Downloads the binary payload of the logo image of the private application.
      operationId: GetPrivateApplicationActionDownloadLogo
      parameters:
      - $ref: '#/components/parameters/PrivateApplicationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: 'Image payload as a binary stream. Can be one of the common image types png, jpeg, bmp, gif or tiff.

            '
          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:
            image/bmp:
              schema:
                format: binary
                type: string
            image/gif:
              schema:
                format: binary
                type: string
            image/jpeg:
              schema:
                format: binary
                type: string
            image/png:
              schema:
                format: binary
                type: string
            image/tiff:
              schema:
                format: binary
                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/DefaultError'
      summary: Downloads the logo image of the private application.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/PrivateApplication'
  /serviceCatalogAssociations:
    get:
      description: Lists all the resource associations for a specific service catalog.
      operationId: ListServiceCatalogAssociations
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogAssociationIdQueryParam'
      - $ref: '#/components/parameters/ServiceCatalogIdQueryParam'
      - $ref: '#/components/parameters/EntityIdQueryParam'
      - $ref: '#/components/parameters/EntityTypeFilterQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ServiceCatalogAssociationSortByQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The operation to list all resource associated with specified service catalog succeeded.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/ServiceCatalogAssociationCollection'
        '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/DefaultError'
      summary: Lists resource associations.
      tags:
      - serviceCatalog
      x-example: 'GET /20210527/serviceCatalogs/<var>&lt;serviceCatalogId&gt;</var>/associations

        Host: servicecatalog.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ServiceCatalogAssociation'
    post:
      description: Creates an association between service catalog and a resource.
      operationId: CreateServiceCatalogAssociation
      parameters:
      - $ref: '#/components/parameters/OpcRetryTokenHeaderParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The operation to create an association between resource and service catalog succeeded.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/ServiceCatalogAssociation'
        '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/DefaultError'
      summary: Creates a service catalog association.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/ServiceCatalogAssociation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateServiceCatalogAssociationDetails'
        description: The details for creating the association between resource and service catalog.
        required: true
  /serviceCatalogAssociations/{serviceCatalogAssociationId}:
    delete:
      description: Removes an association between service catalog and a resource.
      operationId: DeleteServiceCatalogAssociation
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogAssociationIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '204':
          description: The specified service catalog assocition was deleted successfully.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

                '
              schema:
                type: string
        '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/DefaultError'
      summary: Removes an association between service catalog and a resource.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/ServiceCatalogAssociation'
    get:
      description: Gets detailed information about specific service catalog association.
      operationId: GetServiceCatalogAssociation
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogAssociationIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The get operation for service catalog association succeeded.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/ServiceCatalogAssociation'
        '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/DefaultError'
      summary: Gets the details of a service catalog association.
      tags:
      - serviceCatalog
      x-example: 'GET /20210527/serviceCatalogs/<var>&lt;serviceCatalogId&gt;</var>/associations/<var>&lt;associationId&gt;</var>

        Host: servicecatalog.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ServiceCatalogAssociation'
  /serviceCatalogs:
    get:
      description: Lists all the service catalogs in the given compartment.
      operationId: ListServiceCatalogs
      parameters:
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/ServiceCatalogIdQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/ServiceCatalogSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/DisplayNameFilterQueryParam'
      responses:
        '200':
          description: List of all service catalogs.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/ServiceCatalogCollection'
        '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/DefaultError'
      summary: Retrieves all the service catalogs in the given compartment.
      tags:
      - serviceCatalog
      x-example: 'GET /20210527/serviceCatalogs

        Host: servicecatalog.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ServiceCatalog'
    post:
      description: Creates a brand new service catalog in a given compartment.
      operationId: CreateServiceCatalog
      parameters:
      - $ref: '#/components/parameters/OpcRetryTokenHeaderParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The operation to create a service catalog succeeded.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/ServiceCatalog'
        '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/DefaultError'
      summary: Creates a service catalog in the compartment.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/ServiceCatalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateServiceCatalogDetails'
        description: The details for creating a service catalog.
        required: true
  /serviceCatalogs/{serviceCatalogId}:
    delete:
      description: Deletes the specified service catalog from the compartment.
      operationId: DeleteServiceCatalog
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '204':
          description: The operation to delete the service catalog succeeded.
          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'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Deletes an existing service catalog.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/ServiceCatalog'
    get:
      description: Gets detailed information about the service catalog including name, compartmentId
      operationId: GetServiceCatalog
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The get operation for service catalog succeeded.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/ServiceCatalog'
        '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/DefaultError'
      summary: Get the details of the service catalog.
      tags:
      - serviceCatalog
      x-example: 'GET /20210527/serviceCatalogs/<var>&lt;serviceCatalogId&gt;</var>

        Host: servicecatalog.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ServiceCatalog'
    put:
      description: Updates the details of a previously created service catalog.
      operationId: UpdateServiceCatalog
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      responses:
        '200':
          description: The update operation for the service catalog succeeded.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/ServiceCatalog'
        '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/DefaultError'
      summary: Updates the details of the service catalog.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/ServiceCatalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServiceCatalogDetails'
        description: Details to update for a service catalog.
        required: true
  /serviceCatalogs/{serviceCatalogId}/actions/bulkReplaceAssociations:
    put:
      description: Replace all associations of a given service catalog in one bulk transaction.
      operationId: BulkReplaceServiceCatalogAssociations
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: Bulk replace operation succeeded.
          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/DefaultError'
      summary: Replace associations in bulk.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/ServiceCatalogAssociation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkReplaceServiceCatalogAssociationsDetails'
        description: Details of the service catalog update operation.
        required: true
  /serviceCatalogs/{serviceCatalogId}/actions/changeCompartment:
    post:
      description: Moves the specified service catalog from one compartment to another.
      operationId: ChangeServiceCatalogCompartment
      parameters:
      - $ref: '#/components/parameters/ServiceCatalogIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      responses:
        '204':
          description: Changing the compartment for the specified service catalog succeeded.
          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'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Changes the compartment of the service catalog.
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/ServiceCatalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeServiceCatalogCompartmentDetails'
        description: The details of the request to change the compartment of a given service catalog.
        required: true
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestStatusQueryParam'
      - $ref: '#/components/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      responses:
        '200':
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/WorkRequestSummaryCollection'
        '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/DefaultError'
      summary: List Work Requests
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    get:
      description: Gets the status of the work request with the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        '200':
          description: The detail of the work request.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        '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/DefaultError'
      summary: GET Work Request Status
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Return a (paginated) list of errors for a given work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: List of work request errors.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/WorkRequestErrorCollection'
        '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/DefaultError'
      summary: Lists work request errors
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Return a (paginated) list of logs for a given work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: List of work request logs.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/WorkRequestLogEntryCollection'
        '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/DefaultError'
      summary: Lists work request logs
      tags:
      - serviceCatalog
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  parameters:
    PricingFilterQueryParam:
      description: 'Name of the pricing type. If multiple pricing types are provided, then any resource with

        one or more matching pricing models will be returned.

        '
      in: query
      name: pricing
      required: false
      x-default-description: []
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - FREE
          - BYOL
          - PAYGO
          type: string
          x-obmcs-top-level-enum: '#/definitions/PricingTypeEnum'
    ServiceCatalogAssociationIdQueryParam:
      description: The unique identifier for the service catalog association.
      in: query
      name: serviceCatalogAssociationId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ServiceCatalogIdPathParam:
      description: The unique identifier for the service catalog.
      in: path
      name: serviceCatalogId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationTokenQueryParam:
      description: The value of the `opc-next-page` response header from the previous "List" call.
      in: query
      name: page
      required: false
      schema:
        type: string
        maxLength: 511
        minLength: 1
    ServiceCatalogSortByQueryParam:
      description: Default is `TIMECREATED`
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - TIMECREATED
        default: TIMECREATED
    ResourceIdentifierQueryParam:
      description: The ID of the resource affected by the work request
      in: query
      name: resourceId
      x-default-description: 'null'
      schema:
        type: string
    ServiceCatalogAssociationIdPathParam:
      description: The unique identifier of the service catalog association.
      in: path
      name: serviceCatalogAssociationId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PrivateApplicationPackageIdQueryParam:
      description: The unique identifier for the private application package.
      in: query
      name: privateApplicationPackageId
      required: false
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The unique identifier for the compartment.
      in: query
      name: compartmentId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    WorkRequestStatusQueryParam:
      description: A filter to return only resources their lifecycleState matches the given OperationStatus.
      in: query
      name: status
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OperationStatus'
      schema:
        type: string
        enum:
        - ACCEPTED
        - FAILED
        - SUCCEEDED
    PrivateApplicationIdPathParam:
      description: The unique identifier for the private application.
      in: path
      name: privateApplicationId
      required: true
      schema:
        type: string
    OpcRetryTokenHeaderParam:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without

        risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before

        then due to conflicting operations (for example, if a resource has been deleted and purged from the system,

        then a retry of the original creation request might be rejected).

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.

        '
      in: query
      name: limit
      required: false
      schema:
        type: integer
        default: 30
        maximum: 1023
        minimum: 1
    IfMatchHeaderParam:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to

        the value of the etag from a previous GET or POST response for that resource.  The resource will be updated or

        deleted only if the etag you provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    PrivateApplicationIdRequiredQueryParam:
      description: The unique identifier for the private application.
      in: query
      name: privateApplicationId
      required: true
      schema:
        type: string
    PublisherIdQueryParam:
      description: Limit results to just this publisher.
      in: query
      name: publisherId
      required: false
      x-default-description: []
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    CompartmentIdRequiredQueryParam:
      description: The unique identifier for the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    WorkRequestIdPathParam:
      description: The ID of the asynchronous request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    PrivateApplicationPackageIdPathParam:
      description: The unique identifier for the private application package.
      in: path
      name: privateApplicationPackageId
      required: true
      schema:
        type: string
    WorkRequestIdQueryParam:
      description: The ID of the asynchronous work request.
      in: query
      name: workRequestId
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to apply, either `ASC` or `DESC`. Default is `ASC`.
      in: query
      name: sortOrder
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    ServiceCatalogAssociationSortByQueryParam:
      description: Default is `TIMECREATED`
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - TIMECREATED
        default: TIMECREATED
    FeaturedFilterQueryParam:
      description: 'Indicates whether to show only featured resources. If this is set to `false` or is omitted, then all resources will be returned.

        '
      in: query
      name: isFeatured
      required: false
      schema:
        type: boolean
        default: false
    EntityIdQueryParam:
      description: The unique identifier of the entity associated with service catalog.
      in: query
      name: entityId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OpcRequestIdHeaderParam:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,

        please provide the request ID.

        '
      in: header
      name: opc-request-id
      required: false
      schema:
        type: string
    PackageTypeQueryParam:
      description: 'Name of the package type. If multiple package types are provided, then any resource with

        one or more matching package types will be returned.

        '
      in: query
      name: packageType
      required: false
      x-default-description: []
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
    PrivateApplicationSortByQueryParam:
      description: 'The field to use to sort listed results. You can only specify one field to sort by.

        Default is `TIMECREATED`.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - TIMECREATED
        - LIFECYCLESTATE
        default: TIMECREATED
    PackageTypeFilterQueryParam:
      description: 'Name of the package type. If multiple package types are provided, then any resource with

        one or more matching package types will be returned.

        '
      in: query
      name: packageType
      required: false
      x-default-description: []
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
    PrivateApplicationPackageSortByQueryParam:
      description: 'The field to use to sort listed results. You can only specify one field to sort by.

        `TIMECREATED` displays results in descending order by default. You can change your

        preference by specifying a different sort order.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - TIMECREATED
        - VERSION
        default: TIMECREATED
    WorkRequestSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeAccepted
        default: timeAccepted
    DisplayNameFilterQueryParam:
      description: Exact match name filter.
      in: query
      name: displayName
      required: false
      schema:
        type: string
    PrivateApplicationIdQueryParam:
      description: The unique identifier for the private application.
      in: query
      name: privateApplicationId
      required: false
      schema:
        type: string
    ServiceCatalogIdQueryParam:
      description: The unique identifier for the service catalog.
      in: query
      name: serviceCatalogId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    EntityTypeFilterQueryParam:
      description: The type of the application in the service catalog.
      in: query
      name: entityType
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
  schemas:
    PublisherSummary:
      description: Summary details about the publisher of the resource.
      properties:
        displayName:
          description: The name of the publisher.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The unique identifier for the publisher.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - displayName
      type: object
      x-example: "{\n  \"id\": \"53312546\",\n  \"displayName\": \"Riverbed Technology\"\n}\n"
    BulkReplaceServiceCatalogAssociationsDetails:
      description: The model to replace service catalog associations in bulk.
      properties:
        items:
          description: Collection of CreateServiceCatalogAssociationDetails for bulk operation.
          items:
            $ref: '#/components/schemas/CreateServiceCatalogAssociationDetails'
          type: array
      required:
      - items
      type: object
    UpdateServiceCatalogDetails:
      description: The model for the parameters needed to update a service catalog.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: A display name of the service catalog.
          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. Exists for cross-compatibility only.

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

            '
          type: object
      required:
      - displayName
      type: object
    ServiceCatalogAssociationCollection:
      description: Collection of service catalog associations.
      properties:
        items:
          description: Collection of service catalog and the resources associated with it.
          items:
            $ref: '#/components/schemas/ServiceCatalogAssociationSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestSummaryCollection:
      description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestSummary objects.
          items:
            $ref: '#/components/schemas/WorkRequestSummary'
          type: array
      required:
      - items
      type: object
    ApplicationSummary:
      description: The model for summary of an application in service catalog.
      properties:
        displayName:
          description: The name that service catalog should use to display this application.
          maxLength: 255
          minLength: 1
          type: string
        entityId:
          description: Identifier of the application from a service catalog.
          maxLength: 255
          minLength: 1
          type: string
        entityType:
          description: The type of an application in the service catalog.
          maxLength: 255
          minLength: 1
          type: string
        isFeatured:
          description: Indicates whether the application is featured.
          type: boolean
        logo:
          $ref: '#/components/schemas/UploadData'
        packageType:
          description: The type of the packages withing the application.
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
        pricingType:
          description: Summary of the pricing types available across all packages in the application.
          enum:
          - FREE
          - BYOL
          - PAYGO
          type: string
          x-obmcs-top-level-enum: '#/definitions/PricingTypeEnum'
        publisher:
          $ref: '#/components/schemas/PublisherSummary'
        shortDescription:
          description: A short description of the application.
          maxLength: 511
          minLength: 0
          type: string
      required:
      - entityId
      - displayName
      - entityType
      type: object
      x-example: "{\n  \"entityId\": \"ocid1.privateapplication.oc1.iad.123..<unique_ID>\",\n  \"entityType\": \"privateapplication\",\n  \"displayName\": \"My Private Application\",\n  \"shortDescription\": \"This is my private application\",\n  \"pricingType\": FREE,\n  \"packageType\": IMAGE\n}\n"
    PrivateApplicationSummary:
      description: 'Brief data about an application or a solution, which lives inside the tenancy and may be included into service catalogs.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the private application resides.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: The name of the private application.
          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. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the private application.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The lifecycle state of the private application.
          type: string
          x-obmcs-enumref: '#/definitions/PrivateApplication/lifecycleState'
        logo:
          $ref: '#/components/schemas/UploadData'
        packageType:
          description: Type of the packages, which are hosted by the private application.
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
        shortDescription:
          description: A short description of the private application.
          maxLength: 511
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

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

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the private application was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-05-27T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - displayName
      - packageType
      - compartmentId
      - lifecycleState
      - timeCreated
      type: object
      x-example: "{\n  \"id\": \"ocid1.privateapplication.oc1.iad.123..<unique_ID>\",\n  \"displayName\": \"Software Load Balancer\",\n  \"packageType\": \"STACK\",\n  \"shortDescription\": \"Free Software Load Balancer by ACME\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"compartmentId\": \"ocid1.compartment.oc1.aaabcd..<unique_ID>\",\n  \"timeCreated\": \"2021-05-27T01:43:23.789Z\"\n}\n"
    ChangePrivateApplicationCompartmentDetails:
      description: All the parameters required to make the move.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want to move the private application.

            '
          maxLength: 255
          minLength: 1
          type: string
    ApplicationCollection:
      description: Collection of applications in a given service catalog or a tenancy.
      properties:
        items:
          description: Collection of service catalog applications.
          items:
            $ref: '#/components/schemas/ApplicationSummary'
          type: array
      required:
      - items
      type: object
    PrivateApplicationPackageSummary:
      description: The model for a summary of a private application package.
      properties:
        displayName:
          description: The display name of the specified package.
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the private application package.

            '
          type: string
        packageType:
          description: The type of the package.
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
        privateApplicationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the private application where the package is hosted.

            '
          type: string
        timeCreated:
          description: 'The date and time the private application package was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-05-27T21:10:29.600Z`

            '
          format: date-time
          type: string
        version:
          description: The version of the specified package.
          type: string
      required:
      - id
      - privateApplicationId
      - version
      - packageType
      - timeCreated
      type: object
      x-example: "{\n  \"id\": \"ocid1.iad.privateapplicationpackage.00123..<unique_ID>\",\n  \"privateApplicationId\": \"ocid1.iad.privateapplication.00456..<unique_ID>\",\n  \"version\": \"1.4.231\",\n  \"packageType\": \"STACK\",\n  \"timeCreated\": \"2020-05-27T01:23:45.678Z\"\n}\n"
    PrivateApplicationPackageCollection:
      description: Collection of Private Application Package summary objects.
      properties:
        items:
          description: Collection of items.
          items:
            $ref: '#/components/schemas/PrivateApplicationPackageSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestResource:
      description: A resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which this resource is affected by the work tracked in the work request.

            A resource being created, updated, or deleted will remain in the IN_PROGRESS state until

            work is complete for that resource at which point it will transition to CREATED, UPDATED,

            or DELETED, respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityId:
          description: The identifier of the resource the work request affects.
          type: string
        entityType:
          description: The resource type the work request affects.
          type: string
        entityUri:
          description: The URI path that the user can do a GET on to access the resource metadata
          type: string
      required:
      - actionType
      - entityType
      - entityId
    ServiceCatalogAssociation:
      description: The detailed model for service catalog association.
      properties:
        entityId:
          description: Identifier of the entity being associated with service catalog.
          maxLength: 255
          minLength: 1
          type: string
        entityType:
          description: The type of the entity that is associated with the service catalog.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: Identifier of the association.
          maxLength: 255
          minLength: 1
          type: string
        serviceCatalogId:
          description: Identifier of the service catalog.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: Timestamp of when the resource was associated with service catalog.
          format: date-time
          type: string
      required:
      - id
      - serviceCatalogId
      - entityId
      - timeCreated
      type: object
      x-example: "{\n  \"id\": \"ocid1.catalogassociation.oc1.iad.123..<unique_ID>\",\n  \"serviceCatalogId\": \"ocid1.servicecatalog.oc1.iad.456..<unique_ID>\",\n  \"entityId\": \"ocid1.privateapplication.oc1.iad.789..<unique_ID>\",\n  \"entityType\": \"privateapplication\",\n  \"timeCreated\": \"2021-05-27T17:39:19.186Z\"\n}\n"
    CreateServiceCatalogAssociationDetails:
      description: The model to create a single association between a service catalog and a resource.
      properties:
        entityId:
          description: Identifier of the entity being associated with service catalog.
          maxLength: 255
          minLength: 1
          type: string
        entityType:
          description: The type of the entity that is associated with the service catalog.
          maxLength: 255
          minLength: 1
          type: string
        serviceCatalogId:
          description: Identifier of the service catalog.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - serviceCatalogId
      - entityId
      type: object
      x-example: "{\n  \"serviceCatalogId\": \"ocid1.servicecatalog.oc1.iad.456..<unique_ID>\",\n  \"entityId\": \"ocid1.privateapplication.oc1.iad.789..<unique_ID>\",\n  \"entityType\": \"privateapplication\"\n}\n"
    PrivateApplicationCollection:
      description: Collection of private applications.
      properties:
        items:
          description: Collection of items.
          items:
            $ref: '#/components/schemas/PrivateApplicationSummary'
          type: array
      required:
      - items
      type: object
    ServiceCatalogSummary:
      description: The model for a summary of an Oracle Cloud Infrastructure service catalog.
      properties:
        compartmentId:
          description: The Compartment id where the service catalog exists.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: The name of the service catalog.
          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. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The unique identifier for the Service catalog.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The lifecycle state of the service catalog.
          type: string
          x-obmcs-enumref: '#/definitions/ServiceCatalog/lifecycleState'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

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

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time this service catalog was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - displayName
      - compartmentId
      - lifecycleState
      - timeCreated
      type: object
      x-example: "{\n  \"id\": \"ocid1.servicecatalog.oc1.iad.123..<unique_ID>\",\n  \"displayName\": \"Service Catalog 1\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"compartmentId\": \"ocid1.compartment.oc1.aaabcd..<unique_ID>\",\n  \"timeCreated\": \"2021-05-27T17:39:19.186Z\"\n}\n"
    ServiceCatalogAssociationSummary:
      description: The model for a summary of a service catalog association.
      properties:
        entityId:
          description: The unique identifier of the resource being associated to service catalog.
          maxLength: 255
          minLength: 1
          type: string
        entityType:
          description: The type of the entity that is associated with the service catalog.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The unique identifier of the service catalog association.
          maxLength: 255
          minLength: 1
          type: string
        serviceCatalogId:
          description: The unique identifier of the service catalog.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: Timestamp of when the resource was associated with service catalog.
          format: date-time
          type: string
      required:
      - id
      - serviceCatalogId
      - entityId
      - timeCreated
      type: object
      x-example: "{\n  \"id\": \"ocid1.catalogassociation.oc1.iad.123..<unique_ID>\",\n  \"serviceCatalogId\": \"ocid1.servicecatalog.oc1.iad.456..<unique_ID>\",\n  \"entityId\": \"ocid1.privateapplication.oc1.iad.789..<unique_ID>\",\n  \"entityType\": \"privateapplication\",\n  \"timeCreated\": \"2021-05-27T17:39:19.186Z\"\n}\n"
    PrivateApplicationPackage:
      description: A base object for all types of private application packages.
      discriminator:
        propertyName: packageType
      properties:
        displayName:
          description: The display name of the package.
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the private application package.

            '
          type: string
        packageType:
          description: The specified package's type.
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
        privateApplicationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the private application where the package is hosted.

            '
          type: string
        timeCreated:
          description: 'The date and time the private application package was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-05-27T21:10:29.600Z`

            '
          format: date-time
          type: string
        version:
          description: The package version.
          type: string
      required:
      - id
      - privateApplicationId
      - version
      - packageType
      - timeCreated
      x-example: "{\n  \"id\": \"ocid1.iad.privateapplicationpackage.00123..<unique_ID>\",\n  \"privateApplicationId\": \"ocid1.iad.privateapplication.00456..<unique_ID>\",\n  \"version\": \"1.4.231\",\n  \"packageType\": \"STACK\",\n  \"timeCreated\": \"2020-05-27T01:23:45.678Z\"\n}\n"
    WorkRequest:
      description: A description of workrequest status
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: Type of the work request
          enum:
          - CREATE_PRIVATE_APPLICATION
          - UPDATE_PRIVATE_APPLICATION
          - DELETE_PRIVATE_APPLICATION
          - MOVE_PRIVATE_APPLICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: Status of current work request.
          enum:
          - ACCEPTED
          - FAILED
          - SUCCEEDED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    CreatePrivateApplicationDetails:
      description: The model for the parameters needed to create a private application.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the private application.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: The name of the private application.
          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. Exists for cross-compatibility only.

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

            '
          type: object
        logoFileBase64Encoded:
          description: 'Base64-encoded logo to use as the private application icon.

            Template icon file requirements: PNG format, 50 KB maximum, 130 x 130 pixels.

            '
          type: string
        longDescription:
          description: A long description of the private application.
          maxLength: 4095
          minLength: 0
          type: string
        packageDetails:
          $ref: '#/components/schemas/CreatePrivateApplicationPackage'
        shortDescription:
          description: A short description of the private application.
          maxLength: 511
          minLength: 1
          type: string
      required:
      - compartmentId
      - displayName
      - shortDescription
      - packageDetails
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1.aaabcd..<unique_ID>\",\n  \"displayName\": \"Software Load Balancer\",\n  \"shortDescription\": \"Free Software Load Balancer by ACME\",\n  \"longDescription\": \"Software load balancer by ACME will provide you with a reliable round-robin ...\",\n  \"packageDetails\": {\n    \"version\": \"1.0.0\",\n    \"type\": \"STACK\"\n  }\n}\n"
    WorkRequestErrorCollection:
      description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestError objects.
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
    CreateServiceCatalogDetails:
      description: The model for parameter needed to create service catalog.
      properties:
        compartmentId:
          description: The unique identifier for the compartment where the service catalog will be created.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: The display name of the service catalog.
          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. Exists for cross-compatibility only.

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

            '
          type: object
      required:
      - displayName
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1.aaabcd..<unique_ID>\",\n  \"displayName\": \"Service Catalog 2\"\n}\n"
    UploadData:
      description: The model for uploaded binary data, like logos and images.
      properties:
        contentUrl:
          description: The content URL of the uploaded data.
          maxLength: 2047
          minLength: 1
          type: string
        displayName:
          description: The name used to refer to the uploaded data.
          maxLength: 255
          minLength: 1
          type: string
        mimeType:
          description: The MIME type of the uploaded data.
          maxLength: 255
          minLength: 1
          type: string
      type: object
      x-example: "{\n  \"displayName\": \"ACME Logo\",\n  \"contentUrl\": \"https://service-catalog.marketplace.us-ashburn-1.oci.oraclecloud.com/ |\n      privateApplications/ocid1.privateapplication.oc1.iad.123..<unique_ID>/actions/downloadLogo\",\n  \"mimeType\": \"image/jpeg\"\n}\n"
    ErrorEntity:
      description: The model for the error entity.
      properties:
        code:
          description: A short error code that defines the error.
          maxLength: 255
          minLength: 0
          type: string
        message:
          description: A human-readable error string.
          maxLength: 1023
          minLength: 0
          type: string
      required:
      - code
      - message
      type: object
    ChangeServiceCatalogCompartmentDetails:
      description: The model for the parameters needed move a service catalog from one compartment to another.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want to move the service catalog.
          maxLength: 255
          minLength: 1
          type: string
    WorkRequestSummary:
      description: A summary of the status of a work request.
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: Type of the work request
          enum:
          - CREATE_PRIVATE_APPLICATION
          - UPDATE_PRIVATE_APPLICATION
          - DELETE_PRIVATE_APPLICATION
          - MOVE_PRIVATE_APPLICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: Status of current work request.
          enum:
          - ACCEPTED
          - FAILED
          - SUCCEEDED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

            '
          type: string
        message:
          description: A human readable description of the issue encountered.
          type: string
        timestamp:
          description: The time the error occured. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    ServiceCatalog:
      description: The model for an Oracle Cloud Infrastructure Service Catalog.
      properties:
        compartmentId:
          description: The Compartment id where the service catalog exists
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: The name of the service catalog.
          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. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The unique identifier for the Service catalog.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The lifecycle state of the service catalog.
          enum:
          - ACTIVE
          - DELETED
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

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

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the service catalog was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-05-26T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the service catalog was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-12-10T05:10:29.721Z`

            '
          format: date-time
          type: string
      required:
      - id
      - displayName
      - compartmentId
      - lifecycleState
      - timeCreated
      type: object
      x-example: "{\n  \"id\": \"ocid1.servicecatalog.oc1.iad.123..<unique_ID>\",\n  \"displayName\": \"Service Catalog 1\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"compartmentId\": \"ocid1.compartment.oc1.aaabcd..<unique_ID>\",\n  \"timeCreated\": \"2021-05-27T17:39:19.186Z\"\n}\n"
    UpdatePrivateApplicationDetails:
      description: The model for the parameters needed to update a private application.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: The name of the private application.
          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. Exists for cross-compatibility only.

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

            '
          type: object
        logoFileBase64Encoded:
          description: 'Base64-encoded logo to use as the private application icon.

            Template icon file requirements: PNG format, 50 KB maximum, 130 x 130 pixels.

            '
          type: string
        longDescription:
          description: A long description of the private application.
          maxLength: 4095
          minLength: 0
          type: string
        shortDescription:
          description: A short description of the private application.
          maxLength: 511
          minLength: 1
          type: string
      type: object
      x-example: "{\n  \"displayName\": \"Software Load Balancer (800 Mbps)\",\n  \"shortDescription\": \"Software Load Balancer (800 Mbps) by ACME\",\n  \"longDescription\": \"Software load balancer by ACME will provide you with a reliable traffic partition ...\"\n}\n"
    WorkRequestLogEntry:
      description: A log message from the execution of a work request.
      properties:
        message:
          description: Human-readable log message.
          type: string
        timestamp:
          description: The time the log message was written. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - message
      - timestamp
    CreatePrivateApplicationPackage:
      description: A base object for creating a private application package.
      discriminator:
        propertyName: packageType
      properties:
        packageType:
          description: The package's type.
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
        version:
          description: The package version.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - packageType
      - version
      type: object
    ServiceCatalogCollection:
      description: Collection of Service Catalog Summaries.
      properties:
        items:
          description: Collection of catalog summaries.
          items:
            $ref: '#/components/schemas/ServiceCatalogSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestLogEntryCollection:
      description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestLogEntries.
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
    PrivateApplication:
      description: 'Full details of an application or a solution, which lives inside the tenancy and may be included into service catalogs.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the private application resides.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

            '
          type: object
        displayName:
          description: The name of the private application.
          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. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The unique identifier for the private application in Marketplace.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The lifecycle state of the private application.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          type: string
        logo:
          $ref: '#/components/schemas/UploadData'
        longDescription:
          description: A long description of the private application.
          maxLength: 4095
          minLength: 0
          type: string
        packageType:
          description: Type of packages within this private application.
          enum:
          - STACK
          - IMAGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/PackageTypeEnum'
        shortDescription:
          description: A short description of the private application.
          maxLength: 511
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

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

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the private application was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-05-26T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the private application was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.


            Example: `2021-12-10T05:10:29.721Z`

            '
          format: date-time
          type: string
      required:
      - id
      - displayName
      - packageType
      - compartmentId
      - lifecycleState
      - timeCreated
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1.aaabcd..<unique_ID>\",\n  \"id\": \"ocid1.privateapplication.oc1.iad.123..<unique_ID>\",\n  \"displayName\": \"Software Load Balancer\",\n  \"longDescription\": \"Software load balancer by ACME will provide you with a reliable round-robin ...\",\n  \"packageType\": \"STACK\",\n  \"shortDescription\": \"Free Software Load Balancer by ACME\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"timeCreated\": \"2021-05-26T21:10:29.600Z\",\n  \"timeUpdated\": \"2021-12-10T05:10:29.721Z\"\n}\n"
  responses:
    '400':
      description: Bad Request
      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/ErrorEntity'
    DefaultError:
      description: An error has occurred.
      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/ErrorEntity'
    '404':
      description: Not Found
      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/ErrorEntity'
    '412':
      description: Precondition Failed
      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/ErrorEntity'
    '429':
      description: Too Many Requests
      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/ErrorEntity'
    '401':
      description: Not Authenticated
      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/ErrorEntity'
    '409':
      description: Conflict
      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/ErrorEntity'
    '500':
      description: Internal Server 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/ErrorEntity'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

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

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        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. Exists for cross-compatibility only.

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

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

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

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true