openapi: 3.2.0 info: description: Use the Marketplace Publisher API to manage the publishing of applications in Oracle Cloud Infrastructure Marketplace. title: MarketplacePublisherService Marketplace Publisher API version: '20241201' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/3938126592d6bf89c6de487836ec86a01dbd5f60169ceaef9960866094130d3a.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the MarketplacePublisherService 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/3938126592d6bf89c6de487836ec86a01dbd5f60169ceaef9960866094130d3a.yaml what: the harvested document for MarketplacePublisherService API servers: - url: http://127.0.0.1/20241201 - url: https://127.0.0.1/20241201 tags: - name: MarketplacePublisher paths: /artifacts: get: description: 'Lists the artifacts in your compartment. You must specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListArtifacts parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ArtifactLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ArtifactStatusQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ArtifactSummary objects. 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/ArtifactCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListArtifacts tags: - MarketplacePublisher x-example: 'GET /20241201/artifacts?compartmentId=ocid1.compartment.oc1..aaaaaaaamexampleuniqueID Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ArtifactCollection' post: description: 'Creates a new artifact in your compartment. You must specify your compartment ID in the request object. You must also specify a *name* for the artifact(although it can be an empty string). It does not have to be unique, and you can change it anytime with [Update](#/en/marketplace-publisher/20241201/artifacts/UpdateArtifact).. You must also specify a *artifactType* for the artifact. Allowed values are CONTAINER_IMAGE and HELM_CHART You must also provide the container or helm chart registry details for the corresponding images. Oracle container registry details (Registry/Concepts/registryoverview.htm). After you send your request, the new object''s `status` will temporarily be IN_PROGRESS and `lifecycleState` will be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE and the status has changed to ‘AVAILABLE’ for the new Artifact. ' operationId: CreateArtifact parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Artifact will be created. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CreateArtifact tags: - MarketplacePublisher x-example: "POST /20241201/artifacts\nHost: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaamexampleuniqueID\",\n \"displayName\": \"OAS_MP_CONTAINER_ARTIFACT\",\n \"artifactType\": \"CONTAINER_IMAGE\",\n \"containerImage\": {\n \"sourceRegistryUrl\": \"iad.ocir.io/oas_image:v1\"\n }\n}\n" x-related-resource: '#/definitions/Artifact' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateArtifactDetails' description: Request object for creating a new artifact. required: true /artifacts/{artifactId}: delete: description: Deletes the specified artifact. operationId: DeleteArtifact parameters: - $ref: '#/components/parameters/ArtifactIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Artifact will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteArtifact tags: - MarketplacePublisher x-example: 'DELETE /20241201/artifacts/<artifactId> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Artifact' get: description: Gets the specified artifact's information. operationId: GetArtifact parameters: - $ref: '#/components/parameters/ArtifactIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Artifact with the given id 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/Artifact' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetArtifact tags: - MarketplacePublisher x-example: 'GET /20241201/artifacts/ocid1.artifact.123 Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the specified artifact identified by the id. operationId: UpdateArtifact parameters: - $ref: '#/components/parameters/ArtifactIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Artifact will be updated. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateArtifact tags: - MarketplacePublisher x-example: "PUT /20241201/artifacts\nHost: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaamexampleuniqueID\",\n \"displayName\": \"OAS_MP_CONTAINER_ARTIFACT\",\n \"artifactType\": \"CONTAINER_IMAGE\",\n \"containerImage\": {\n \"sourceRegistryUrl\": \"iad.ocir.io/oas_image:v1\"\n }\n}\n" x-related-resource: '#/definitions/Artifact' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateArtifactDetails' description: Request object for updating an artifact. required: true /artifacts/{artifactId}/actions/changeCompartment: post: description: Moves the specified artifact to the specified compartment within the same tenancy. operationId: ChangeArtifactCompartment parameters: - $ref: '#/components/parameters/ArtifactIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '204': description: Moves an artifact into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string '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' summary: ChangeArtifactCompartment tags: - MarketplacePublisher x-related-resource: '#/definitions/Artifact' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeArtifactCompartmentDetails' description: Request to change the compartment of a given artifact. required: true /artifacts/{artifactId}/actions/validateAndPublish: post: description: Validate and publish artifact. operationId: ValidateAndPublishArtifact parameters: - $ref: '#/components/parameters/ArtifactIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Validate and publish artifact. tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Artifact' /availableServices: get: description: 'List all published service listing revisions ' operationId: ListAvailableServices parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of listing Summary objects. 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/AvailableServiceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List published service listing tags: - MarketplacePublisher x-example: 'GET /20241201/availableServices?compartmentId=ocid1.compartment.oc1..aaaaaaaamexampleuniqueID Host: identity.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AvailableServiceCollection' /categories: get: description: 'Lists the categories in your compartment. You must specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListCategories parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByProductCodeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: A page of category objects. 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/CategoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListCategories tags: - MarketplacePublisher x-example: 'GET /20241201/categories?compartmentId=ocid1.compartment.oc1..aaaaaaaamexampleuniqueID Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CategoryCollection' /categories/{categoryCode}: get: description: Gets the specified category's information. operationId: GetCategory parameters: - $ref: '#/components/parameters/CategoryCodePathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Category details with the given id 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/Category' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetCategory tags: - MarketplacePublisher x-example: 'GET /20241201/categories/<categoryCode> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Category' /customerInstanceReportRecords: get: description: 'List customer instance report records ' operationId: ListCustomerInstanceReportRecords parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/InstanceReportDateRangeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: Retrieves the report records 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/CustomerInstanceReportRecordCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List customer instance report records tags: - MarketplacePublisher x-related-resource: '#/definitions/CustomerInstanceReportRecordCollection' /disbursementReportRecords: get: description: 'List disbursement report records ' operationId: ListDisbursementReportRecords parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisbursementReportDateRangeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: Retrieves the report records 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/DisbursementReportRecordCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List disbursement report records tags: - MarketplacePublisher x-related-resource: '#/definitions/DisbursementReportRecordCollection' /leads: get: description: 'Lists the leads in your compartment that belong to a listing. You must specify your listing''s OCID as the value for the listing ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListLeads parameters: - $ref: '#/components/parameters/ListingIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParameter' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParameter' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Leads will be displayed. 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/LeadCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List leads of a listing tags: - MarketplacePublisher x-example: 'GET /20241106/leads?compartmentId=ocid1.compartment.oc1..aaaaaaaamexampleuniqueID&listingId=ocid1.listing.oc1..aaaaaaaamexampleuniqueID Host: identity.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /leads/{leadId}: get: description: 'Gets the details for a lead. ' operationId: GetLead parameters: - $ref: '#/components/parameters/LeadIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The lead was retrieved. 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/Lead' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the details for a specific lead tags: - MarketplacePublisher x-example: 'GET /20241106/leads/<leadId> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' /listingRevisionAttachments: get: description: 'Gets the list of attachments for a listing revision in a compartment ' operationId: ListListingRevisionAttachments parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ListingRevisionAttachmentLifecycleStateQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevisionAttachmentCollection' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListListingRevisionAttachments. tags: - MarketplacePublisher x-example: 'GET /20241201/listingRevisions/<listingRevisionId>/listingAttachments Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevisionAttachmentCollection' post: description: 'Creates a new listing revision attachment. ' operationId: CreateListingRevisionAttachment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The listing revision attachment will be created. 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/ListingRevisionAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CreateListingRevisionAttachment. tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionAttachment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListingRevisionAttachmentDetails' description: Details for the new Listing Revision Attachment. required: true /listingRevisionAttachments/{listingRevisionAttachmentId}: delete: description: Deletes a listing revision attachment by the identifier operationId: DeleteListingRevisionAttachment parameters: - $ref: '#/components/parameters/ListingRevisionAttachmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The attachment will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteListingRevisionAttachment tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionAttachment' get: description: 'Get the details of the specified listing revision attachment. ' operationId: GetListingRevisionAttachment parameters: - $ref: '#/components/parameters/ListingRevisionAttachmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevisionAttachment' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetListingRevisionAttachment. tags: - MarketplacePublisher x-example: 'GET /20241201/listingRevisions/<listingRevisionId>/listingAttachments/<attachmentId> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevisionAttachment' put: description: Updates the Listing Revision Attachment operationId: UpdateListingRevisionAttachment parameters: - $ref: '#/components/parameters/ListingRevisionAttachmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Accepted the request. The attachment will be updated. 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/ListingRevisionAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateListingRevisionAttachment tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionAttachment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListingRevisionAttachmentDetails' description: The attachment to be updated. required: true /listingRevisionAttachments/{listingRevisionAttachmentId}/content: get: description: 'Get the attachment content by identifier. ' operationId: GetListingRevisionAttachmentContent parameters: - $ref: '#/components/parameters/ListingRevisionAttachmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the attachment content with the given id. 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: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the binary data of listing revision attachment. tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionAttachment' put: description: Update a file to listing revision attachment operationId: UpdateListingRevisionAttachmentContent parameters: - $ref: '#/components/parameters/ListingRevisionAttachmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Accepted the request. The attachment will be updated. 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/ListingRevisionAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update listing revision attachment content tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionAttachment' requestBody: content: multipart/form-data: schema: format: binary type: string description: The attachment to upload. required: true /listingRevisionNotes: get: description: 'Gets the list of notes for a listing revision. ' operationId: ListListingRevisionNotes parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ListingRevisionIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevisionNoteCollection' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the list of notes for a listing revision. tags: - MarketplacePublisher x-example: 'GET /20241201/listingRevisionNotes/ Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevisionNoteCollection' post: description: 'Creates a new Listing Revision Note. ' operationId: CreateListingRevisionNote parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Note will be created. 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/ListingRevisionNote' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CreateListingRevisionNote tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionNote' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListingRevisionNoteDetails' description: Details for the new Listing Revision Note. required: true /listingRevisionNotes/{listingRevisionNoteId}: delete: description: Deletes a listing revision note by the identifier. operationId: DeleteListingRevisionNote parameters: - $ref: '#/components/parameters/ListingRevisionNoteIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Note will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteListingRevisionNote tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionNote' get: description: Get note details by the identifier operationId: GetListingRevisionNote parameters: - $ref: '#/components/parameters/ListingRevisionNoteIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevisionNote' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetListingRevisionNote tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionNote' put: description: Updates the Listing Revision Note tag data operationId: UpdateListingRevisionNote parameters: - $ref: '#/components/parameters/ListingRevisionNoteIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Listing revision note was successfully updated 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/ListingRevisionNote' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateListingRevisionNote tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionNote' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListingRevisionNoteDetails' description: The listing revision information to be updated. required: true /listingRevisionPackages: get: description: 'Gets the list of packages for a listing revision. ' operationId: ListListingRevisionPackages parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ListingRevisionIdentifierQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PackageLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevisionPackageCollection' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListListingRevisionPackages. tags: - MarketplacePublisher x-example: 'GET /20241201/listingRevisions/<listingRevisionId>/packages Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevisionPackageCollection' post: description: 'Creates a new Listing Revision Package. ' operationId: CreateListingRevisionPackage parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Package will be created. 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/ListingRevisionPackage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CreateListingRevisionPackage tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionPackage' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListingRevisionPackageDetails' description: Details for the new Listing Revision Package. required: true /listingRevisionPackages/{listingRevisionPackageId}: delete: description: Deletes a listing revision package by the identifier operationId: DeleteListingRevisionPackage parameters: - $ref: '#/components/parameters/ListingRevisionPackageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Package will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteListingRevisionPackage tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionPackage' get: description: 'Get the details of the specified version of a package. ' operationId: GetListingRevisionPackage parameters: - $ref: '#/components/parameters/ListingRevisionPackageIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevisionPackage' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the details of a specific package version. tags: - MarketplacePublisher x-example: 'GET /20241201/listingRevisions/<revisionId>/packages/<packageVersion> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevisionPackage' put: description: Updates the Listing Revision Package. operationId: UpdateListingRevisionPackage parameters: - $ref: '#/components/parameters/ListingRevisionPackageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Accepted the request. The Package will be updated. 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/ListingRevisionPackage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateListingRevisionPackage tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevisionPackage' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListingRevisionPackageDetails' description: The information to be updated. required: true /listingRevisionPackages/{listingRevisionPackageId}/actions/markAsDefault: post: description: Mark the Listing Revision Package identified by the id and package version as default operationId: MarkListingRevisionPackageAsDefault parameters: - $ref: '#/components/parameters/ListingRevisionPackageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Listing revision package will be marked as default 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: MarkListingRevisionPackageAsDefault tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevisionPackage' /listingRevisionPackages/{listingRevisionPackageId}/actions/publish: post: description: Updates the Listing Revision Package to publish status operationId: PublishListingRevisionPackage parameters: - $ref: '#/components/parameters/ListingRevisionPackageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: PublishListingRevisionPackage. tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevisionPackage' /listingRevisionPackages/{listingRevisionPackageId}/actions/unPublish: post: description: Updates the Listing Revision Package to Unpublish status operationId: UnPublishListingRevisionPackage parameters: - $ref: '#/components/parameters/ListingRevisionPackageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UnPublishListingRevisionPackage tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevisionPackage' /listingRevisions: get: description: 'Lists the list of listing revisions for a specific listing ID, compartment ID or listing revision status. You can specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListListingRevisions parameters: - $ref: '#/components/parameters/ListingIdentifierQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ListingRevisionLifecycleStateQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ListingRevisionStatusQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevisionCollection' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the list of listing revisions for a listing. tags: - MarketplacePublisher x-example: 'GET /20241201/listingRevisions; Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevisionCollection' post: description: 'Creates a new Listing Revision. ' operationId: CreateListingRevision parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Listing Revision will be created. 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/ListingRevision' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Listing Revision tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevision' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListingRevisionDetails' description: Details for the new Listing Revision. required: true /listingRevisions/{listingRevisionId}: delete: description: Deletes a listing by the identifier operationId: DeleteListingRevision parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Listing Revision will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteListingRevision tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevision' get: description: 'Gets the details for a listing revision. ' operationId: GetListingRevision parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The operation 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/ListingRevision' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetListingRevision. tags: - MarketplacePublisher x-example: 'GET /20241201/listings/<listingId> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevision' put: description: Updates the Listing Revision operationId: UpdateListingRevision parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Listing revision will be updated. 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/ListingRevision' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateListingRevision tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevision' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListingRevisionDetails' description: The listing revision information to be updated. required: true /listingRevisions/{listingRevisionId}/actions/cascadingDelete: post: description: Cascade delete listing revision and its subresources. operationId: CascadingDeleteListingRevision parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cascade delete listing revision and its subresources. tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevision' /listingRevisions/{listingRevisionId}/actions/changeToNewStatus: post: description: Updates the Listing Revision to New status operationId: ChangeListingRevisionToNewStatus parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Listing revision will be moved to New Status. 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/ListingRevision' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ChangeListingRevisionToNewStatus tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevision' /listingRevisions/{listingRevisionId}/actions/clone: post: description: Clone the published/withdrawn Listing Revision identified by the identifier. operationId: CloneListingRevision parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CloneListingRevision. tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevision' /listingRevisions/{listingRevisionId}/actions/publish: post: description: Publish the Listing revision identified by Identifier. operationId: PublishListingRevision parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: PublishListingRevision. tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevision' /listingRevisions/{listingRevisionId}/actions/publishAsPrivate: post: description: Updates the Listing Revision to PublishAsPrivate operationId: PublishListingRevisionAsPrivate parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: PublishListingRevisionAsPrivate. tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevision' requestBody: content: application/json: schema: $ref: '#/components/schemas/PublishListingRevisionAsPrivateDetails' description: The listing revision publish as private information to be updated. required: true /listingRevisions/{listingRevisionId}/actions/submitForReview: post: description: Update the Listing Revision identified by the id for review operationId: SubmitListingRevisionForReview parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Accepted the request. The Listing will be sent to the istrator for review. 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/ListingRevision' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: SubmitListingRevisionForReview tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevision' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitListingRevisionForReviewDetails' description: The listing revision review information to be updated. required: true /listingRevisions/{listingRevisionId}/actions/withdraw: post: description: Update the Listing Revision identified by the id as Withdraw/UnPublished. operationId: WithdrawListingRevision parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: WithdrawListingRevision tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ListingRevision' /listingRevisions/{listingRevisionId}/icon/content: get: description: 'Gets the content for a listing revision icon. ' operationId: GetListingRevisionIconContent parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the icon content with the given listing revision id. 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: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the binary data of listing revision icon. tags: - MarketplacePublisher x-example: 'GET /20241201/listings/<listingId> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingRevision' put: description: Updates the Listing Revision operationId: UpdateListingRevisionIconContent parameters: - $ref: '#/components/parameters/ListingRevisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Listing revision will be updated. 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/ListingRevision' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateListingRevisionIconContent tags: - MarketplacePublisher x-related-resource: '#/definitions/ListingRevision' requestBody: content: multipart/form-data: schema: format: binary type: string description: The listing revision icon to be updated. required: true /listings: get: description: 'Lists the listings in your compartment. You must specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListListings parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ListingLifecycleStateQueryParam' - $ref: '#/components/parameters/ListingTypeQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of listing Summary objects. 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/ListingCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListListings tags: - MarketplacePublisher x-example: 'GET /20241201/listings?compartmentId=ocid1.compartment.oc1..aaaaaaaamexampleuniqueID Host: identity.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ListingCollection' post: description: 'Creates a new listing in your compartment. You must specify your compartment ID in the request object. You must also specify a *name* for the listing and cannot be updated later. You must also specify a *packageType* for the listing. Allowed values are CONTAINER_IMAGE and HELM_CHART After you send your request, the new object''s `lifecycleState` will be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE. ' operationId: CreateListing parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Listing will be created. 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/Listing' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CreateListing tags: - MarketplacePublisher x-example: "POST /20241201/listings\nHost: identity.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"Id\": \"ocid1.listing.123\",\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaamexampleuniqueID\",\n \"name\": \"OAS_MP_HELM_LISTING\",\n \"listingType\": \"OCI_APPLICATION\",\n \"packageType\": \"HELM_CHART\"\n}\n" x-related-resource: '#/definitions/Listing' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateListingDetails' description: Details for the new Listing. required: true /listings/{listingId}: delete: description: Deletes a listing by the identifier operationId: DeleteListing parameters: - $ref: '#/components/parameters/ListingIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Listing will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteListing tags: - MarketplacePublisher x-example: 'DELETE /20241201/listings/<listingId> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Listing' get: description: 'Gets the details for a listing. ' operationId: GetListing parameters: - $ref: '#/components/parameters/ListingIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: The listing was retrieved. 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/Listing' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetListing tags: - MarketplacePublisher x-example: 'GET /20181001/listings/<listingId> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Listing' put: description: Updates the specified Listing identified by the id. operationId: UpdateListing parameters: - $ref: '#/components/parameters/ListingIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Listing will be updated. 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/Listing' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateListing tags: - MarketplacePublisher x-example: 'PUT /20241201/listings Host: identity.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Listing' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateListingDetails' description: The information to be updated. required: true /listings/{listingId}/actions/cascadingDelete: post: description: Cascade delete the listing and its subresources. operationId: CascadingDeleteListing parameters: - $ref: '#/components/parameters/ListingIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CascadingDeleteListing tags: - MarketplacePublisher x-example: 'DELETE /20241201/listings/<listingId>/actions/cascadingDelete Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Listing' /listings/{listingId}/actions/changeCompartment: post: description: Moves a listing from one compartment to another operationId: ChangeListingCompartment parameters: - $ref: '#/components/parameters/ListingIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '204': description: Moves a listing into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string '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' summary: ChangeListingCompartmentDetails tags: - MarketplacePublisher x-related-resource: '#/definitions/Listing' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeListingCompartmentDetails' description: Request to change the compartment of a given listing. required: true /markets: get: description: 'Lists the markets in your compartment. You must specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListMarkets parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/ListingIdQueryParam' responses: 200: description: A page of market objects. 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/MarketCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListMarkets tags: - MarketplacePublisher x-example: 'GET /20241201/markets Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/MarketCollection' /markets/{marketCode}: get: description: Gets the specified market's information. operationId: GetMarket parameters: - $ref: '#/components/parameters/MarketCodePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Market details with the given code 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/Market' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetMarket tags: - MarketplacePublisher x-example: 'GET /20241201/markets/<marketCode> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Market' /products: get: description: 'Lists the products in your compartment. You must specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListProducts parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/ProductGroupQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: A page of product objects. 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/ProductCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListProducts tags: - MarketplacePublisher x-example: 'GET /20241201/products Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ProductCollection' /products/{productCode}: get: description: Gets a Product by code identifier operationId: GetProduct parameters: - $ref: '#/components/parameters/ProductCodePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Product details with the given code 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/Product' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Product tags: - MarketplacePublisher x-example: 'GET /20241201/products/<productCode> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Product' /publishers: get: description: Returns a list of publishers. operationId: ListPublishers parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: A page of publisher objects. 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/PublisherCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all publishers tags: - MarketplacePublisher x-related-resource: '#/definitions/PublisherCollection' /publishers/{publisherId}: get: description: Gets a Publisher by identifier operationId: GetPublisher parameters: - $ref: '#/components/parameters/PublisherIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Publisher details with the given id 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/Publisher' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Publisher tags: - MarketplacePublisher x-related-resource: '#/definitions/Publisher' /supportDocs: get: description: 'Lists the supportDocs in your compartment. You must specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListSupportDocs parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SupportDocGroupQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: A page of supportDoc objects. 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/SupportDocCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List support docs tags: - MarketplacePublisher x-example: 'GET /20241201/supportDocs Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SupportDocCollection' /supportDocs/{supportDocCode}: get: description: Gets a SupportDoc by code identifier operationId: GetSupportDoc parameters: - $ref: '#/components/parameters/SupportDocCodePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the supportDoc details with the given code 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/SupportDoc' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get details of a specific support doc tags: - MarketplacePublisher x-example: 'GET /20241201/supportDocs/<supportDocCode> Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SupportDoc' /supportDocs/{supportDocCode}/content: get: description: Gets a Support Doc content by supportDocCode operationId: GetSupportDocContent parameters: - $ref: '#/components/parameters/SupportDocCodePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Support Doc content with the given code 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: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Support Doc content tags: - MarketplacePublisher x-related-resource: '#/definitions/SupportDoc' /supportedCurrencies: get: description: 'Lists the currencies supported by the Marketplace Publisher Service. You must specify your compartment''s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm). ' operationId: ListSupportedCurrencies parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of currencies supported by Marketplace Publisher Service. 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/SupportedCurrencyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the currencies supported by the Marketplace tags: - MarketplacePublisher x-example: 'GET /20241201/supportedCurrencies Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SupportedCurrencyCollection' /supportedShapes: get: description: 'Lists the shapes available to select from. ' operationId: ListSupportedShapes parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: A page of shape objects. 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/SupportedShapeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListSupportedShapes tags: - MarketplacePublisher x-example: 'GET /20241201/shapes Host: marketplacepublisher.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SupportedShapeCollection' /termVersions: get: description: Returns a list of the publisher term versions. operationId: ListTermVersions parameters: - $ref: '#/components/parameters/TermIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of term version objects. 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/TermVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all the publisher term versions tags: - MarketplacePublisher x-related-resource: '#/definitions/TermVersionCollection' post: description: Creates a new Term Version. operationId: CreateTermVersion parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OptionalDisplayNameHeader' - $ref: '#/components/parameters/TermIdHeader' responses: 200: description: Accepted the request. The Term version will be created. 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/TermVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Term Version tags: - MarketplacePublisher x-related-resource: '#/definitions/TermVersion' requestBody: content: multipart/form-data: schema: format: binary type: string description: The term version file to upload. required: true /termVersions/{termVersionId}: delete: description: Deletes a Term by the identifier operationId: DeleteTermVersion parameters: - $ref: '#/components/parameters/TermVersionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Term will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteTermVersion tags: - MarketplacePublisher x-related-resource: '#/definitions/TermVersion' get: description: Gets a Term Version by the identifier operationId: GetTermVersion parameters: - $ref: '#/components/parameters/TermVersionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Term with the given id 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/TermVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetTermVersion tags: - MarketplacePublisher put: description: Updates the Term Version operationId: UpdateTermVersion parameters: - $ref: '#/components/parameters/TermVersionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Term Version will be updated. 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/TermVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateTermVersion tags: - MarketplacePublisher x-related-resource: '#/definitions/TermVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTermVersionDetails' description: Term Version details to be updated. required: true /termVersions/{termVersionId}/actions/Activate: post: description: Mark the Term Version identified by the id as active operationId: ActivateTermVersion parameters: - $ref: '#/components/parameters/TermVersionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Term Version will be updated. 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/TermVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ActivateTermVersion tags: - MarketplacePublisher x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/TermVersion' /termVersions/{termVersionId}/content: get: description: Gets a Term Version content by the identifier. operationId: GetTermVersionContent parameters: - $ref: '#/components/parameters/TermVersionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the icon content with the given listing revision id. 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: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the binary data of term version. tags: - MarketplacePublisher x-related-resource: '#/definitions/TermVersion' put: description: Updates the Term Version attachment operationId: UpdateTermVersionContent parameters: - $ref: '#/components/parameters/TermVersionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OptionalDisplayNameHeader' responses: 200: description: Accepted the request. The Term Version will be updated. 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/TermVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateTermVersionContent tags: - MarketplacePublisher x-related-resource: '#/definitions/TermVersion' requestBody: content: multipart/form-data: schema: format: binary type: string description: The term attachment to upload. required: true /terms: get: description: Returns a list of the publisher terms. operationId: ListTerms parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: A page of term objects. 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/TermCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all the publisher terms tags: - MarketplacePublisher x-related-resource: '#/definitions/TermCollection' post: description: 'Creates a new Term. ' operationId: CreateTerm parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Terms will be created. 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/Term' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Term tags: - MarketplacePublisher x-related-resource: '#/definitions/Term' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTermDetails' description: Details for the new Term. required: true /terms/{termId}: delete: description: Deletes a Term by the identifier operationId: DeleteTerm parameters: - $ref: '#/components/parameters/TermIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Term will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Term tags: - MarketplacePublisher x-related-resource: '#/definitions/Term' get: description: Gets a Term by identifier operationId: GetTerm parameters: - $ref: '#/components/parameters/TermIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Term with the given id 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/Term' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a Term by identifier tags: - MarketplacePublisher put: description: Updates the Term operationId: UpdateTerm parameters: - $ref: '#/components/parameters/TermIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Term will be updated. 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/Term' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Term identified by the id tags: - MarketplacePublisher x-related-resource: '#/definitions/Term' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTermDetails' description: The information to be updated. required: true /terms/{termId}/actions/changeCompartment: post: description: Moves a term from one compartment to another operationId: ChangeTermCompartment parameters: - $ref: '#/components/parameters/TermIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: '204': description: Moves a term into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string '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' summary: ChangeTermCompartmentDetails tags: - MarketplacePublisher x-related-resource: '#/definitions/Term' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTermCompartmentDetails' description: Request to change the compartment of a given term. 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/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work request summaries. 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work requests tags: - MarketplacePublisher x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancels the work request with the given ID. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be cancelled. 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' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel work request tags: - MarketplacePublisher x-related-resource: '#/definitions/WorkRequest' get: description: Gets details of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get work request status tags: - MarketplacePublisher x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a (paginated) list of errors for the work request with the given ID. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request errors tags: - MarketplacePublisher x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a (paginated) list of logs for the work request with the given ID. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request logs tags: - MarketplacePublisher x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: ChangeTermCompartmentDetails: description: Contains details indicating which compartment the term should move to properties: compartmentId: description: The id of the compartment which the term should be moved. maxLength: 255 minLength: 1 type: string DisbursementReportRecordCollection: description: Disbursement report properties: items: description: List of disbursement report records. items: $ref: '#/components/schemas/DisbursementReportRecord' type: array required: - items type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. maxLength: 100 minLength: 1 type: string message: description: A human-readable error string. maxLength: 255 minLength: 1 type: string required: - code - message TermSummary: description: The model for the term summary. properties: author: description: Who authored the term. Publisher terms will be defaulted to as 'PARTNER'. type: string x-obmcs-enumref: '#/definitions/Term/author' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 id: description: Unique OCID identifier for the term. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the term version. type: string x-obmcs-enumref: '#/definitions/Term/lifecycleState' name: description: The name for the term. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - name - author - lifecycleState - timeCreated - timeUpdated type: object x-example: "{\n \"id\" : \"ocid1.term.oc1.phx.abuw4ljrlsfiqw6vzzxb43vyypt4pkodawglp3wqxjqofakrwvou52gb6s5a\",\n \"name\" : \"Publisher Terms\",\n \"lifeCycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-09-14T23:27:56.676Z\"\n}\n" Artifact: description: Base model object for the artifacts. discriminator: propertyName: artifactType properties: artifactType: description: Artifact type for the artifact. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK type: string x-obmcs-top-level-enum: '#/definitions/ArtifactTypeEnum' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the artifact. 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: Unique OCID identifier for the artifact. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the Artifact. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string publisherId: description: The unique identifier for the publisher. maxLength: 255 minLength: 1 type: string status: description: The current status for the Artifact. enum: - IN_PROGRESS - AVAILABLE - UNAVAILABLE type: string statusNotes: description: Status notes for the Artifact. maxLength: 500 minLength: 0 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the artifact was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the artifact was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - publisherId - displayName - artifactType - status - lifecycleState - timeCreated - timeUpdated type: object SubmitListingRevisionForReviewDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher review listing revision. properties: areInternalTenancyLaunchAllowed: description: Identifies whether publisher allows internal tenancy launches for the listing revision. type: boolean noteDetails: description: Notes provided for the listing revision. maxLength: 8000 minLength: 0 type: string shouldAutoPublishOnApproval: description: Identifies whether publisher intends to publish the listing automatically upon approval. type: boolean type: object ListingRevisionNote: description: The model for the listing revision notes. properties: compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 id: description: The OCID of the listing revision note. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the listing revision note. enum: - ACTIVE - DELETED type: string listingRevisionId: description: The unique identifier of the listing revision that the specified note belongs to. maxLength: 255 minLength: 1 type: string noteDetails: description: Notes provided for the listing revision. maxLength: 8000 minLength: 1 type: string noteSource: description: type of the note. enum: - PUBLISHER - ADMINISTRATOR type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the listing revision note was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the listing revision note was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string required: - id - listingRevisionId - compartmentId - noteSource - noteDetails - timeCreated - timeUpdated 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 ListingRevision: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher listing revision. discriminator: propertyName: listingType properties: compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string contentLanguage: $ref: '#/components/schemas/LanguageItem' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the listing revision. maxLength: 255 minLength: 1 type: string extendedMetadata: additionalProperties: type: string description: 'Additional metadata key/value pairs for the listing revision summary. ' maxLength: 255 maxProperties: 25 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 headline: description: Single line introduction for the listing revision. maxLength: 255 minLength: 1 type: string icon: $ref: '#/components/schemas/ListingRevisionIconAttachment' id: description: Unique OCID identifier for the listing revision in Marketplace Publisher. maxLength: 255 minLength: 1 type: string keywords: description: Keywords associated with the listing revision. maxLength: 500 minLength: 0 type: string lifecycleState: description: The current state of the listing revision. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string listingId: description: The unique identifier for the listing this revision belongs to. maxLength: 255 minLength: 1 type: string listingType: description: The listing's type. Populated from the listing. enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ListingType' longDescription: description: A long description for the listing revision. maxLength: 4000 minLength: 0 type: string packageType: description: The listing's package type. Populated from the listing. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK - NONE type: string x-obmcs-top-level-enum: '#/definitions/PackageType' revisionNumber: description: The revision number for the listing revision. This is an internal attribute maxLength: 255 minLength: 0 type: string shortDescription: description: A short description for the listing revision. maxLength: 320 minLength: 0 type: string status: description: The current status for the Listing revision. enum: - NEW - PENDING_REVIEW - REVIEW_IN_PROGRESS - REJECTED - APPROVED - PUBLISH_IN_PROGRESS - PUBLISH_FAILED - PUBLISHED - PUBLISH_AS_PRIVATE_FAILED - PUBLISHED_AS_PRIVATE - PUBLISH_AS_PRIVATE_IN_PROGRESS - UNPUBLISH_IN_PROGRESS - UNPUBLISHED type: string statusNotes: description: Status notes for the listing revision. maxLength: 500 minLength: 0 type: string supportContacts: description: Contact information to use to get support from the publisher for the listing revision. items: $ref: '#/components/schemas/SupportContact' type: array supportLinks: description: Links to support resources for the listing revision. items: $ref: '#/components/schemas/NamedLink' type: array supportedlanguages: description: Languages supported by the publisher for the listing revision. items: $ref: '#/components/schemas/LanguageItem' type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tagline: description: The tagline of the listing revision. maxLength: 200 minLength: 0 type: string timeCreated: description: The time the listing revision was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the listing revision was updated. An RFC3339 formatted datetime string. format: date-time type: string usageInformation: description: Usage information for the listing revision. maxLength: 4000 minLength: 0 type: string required: - id - listingId - displayName - status - headline - lifecycleState - timeCreated - timeUpdated - listingType type: object x-example: "{\n \"id\" : \"OCID\",\n \"displayName\" : \"RackWare RMM 6.5 for OCI\",\n \"version\" : \"6.5.0\",\n \"tagline\" : \"RackWare RMM provides an image mobility and disaster recovery solution\",\n \"keywords\" : \"Migration, Disaster Recovery, Bare Metal\",\n \"shortDescription\" : \"RMM provides complete cloud management. Cloud Migration, Image Mobility, Disaster Recovery, Backup, intelligent provisioning, autoscaling, and cloud governance that harnesses the benefits of cloud technology, while taking advantage of existing IT capabilities and investments.\",\n \"usageInformation\" : \"<p>Open TCP ports 22 ingress/egress to RMM from Source hosts</p>\\n\\n<p>Open TCP port 22 ingress/egress from RMM to target OCI networks</p>\\n\\n<p>Open TCP port 443 ingress to RMM from where you will access the GUI</p>\\n\\n<p>Login through firefox or chrome browser to https://<ip of rmm></p>\\n\\n<p>Click on the obtain license button</p>\\n\\n<p>Follow licensing email information once received to complete product registration and obtain additional login information</p>\\n\\n<p>After product has been licensed please see: Rackware RMM Getting Started for Oracle Marketplace</p>\\n\\n<p><a href=\\\"http://www.rackwareinc.com/rackware-rmm-getting-started-for-oracle-marketplace\\\"><strong>rackware-rmm-getting-started-for-oracle-marketplace</strong></a></p>\",\n \"longDescription\" : \"<p>RMM provides a Disaster Recovery solution that builds on its image mobility and elasticity features to bring economic DR to enterprises. The building blocks of RackWare’s DR solution include onboarding, cloud bursting and the policy framework to automate necessary functions. Captured images from production instances bare metal or virtualized) are cloned and pushed out to a local or remote DR site. Changes in production images are periodically synchronized with the remote images, keeping the original host Image and the DR image in sync. In the event of an outage at the origin site, the up to date image at the DR site can assume operations through RackWare’s fail-over mechanism.</p>\",\n \"timeUpdated\" : \"2019-02-04T00:00:00.000Z\",\n \"releaseNotes\" : \"<ul>\\n\\t<li><strong>Whitelist/blacklist drives</strong> – flexible support for networked storage and the ability to mark networked drives as whitelist or blacklist and selectively include them for migration to the cloud</li>\\n\\t<li><strong>Backup wizard</strong> – includes policy configuration on top of a disaster recovery policy. </li>\\n\\t<li><strong>Single file restore</strong></li>\\n\\t<li><strong>Openstack Auto provisioning</strong></li>\\n\\t<li><strong>Data Guard</strong> – disaster recovery (DR) policy integration with Oracle Data Guard</li>\\n</ul>\\n\\n<p> </p>\\n\",\n \"categories\" : [ \"Migration\" ],\n \"publisher\" : {\n \"id\" : \"7376171\",\n \"name\" : \"Rackware, Inc.\",\n \"description\" : \"Data Migration, Cloud Automation and Disaster Recovery\",\n \"yearFounded\" : 2008,\n \"websiteUrl\" : \"http://www.rackwareinc.com/\",\n \"contactEmail\" : \"info@rackwareinc.com\",\n \"contactPhone\" : \"408.430.5821\",\n \"hqAddress\" : \"Fremont, CA, United States\",\n \"logo\" : null,\n \"links\" : [ {\n \"rel\" : \"CANONICAL\",\n \"href\" : \"https://ocm-apis-cloud.oracle.com/appstore/marketplace/v2/publishers/7376171\"\n } ]\n },\n \"languages\" : [ {\n \"name\" : \"English\",\n \"code\" : \"en_US\"\n } ],\n \"screenshots\" : [ {\n \"name\" : \"rmmlite-landing_page\",\n \"description\" : \"\",\n \"contentUrl\" : \"https://cloudmarketplace.oracle.com/marketplace/content?contentId=51607333\",\n \"mimeType\" : \"application/octet-stream\",\n \"fileExtension\" : \"png\"\n } ],\n \"videos\" : [ {\n \"name\" : \"RackWare RMM for Oracle Bare Metal Cloud\",\n \"url\" : \"https://youtu.be/9lBn3R_btI0\"\n } ],\n \"supportContacts\" : [ {\n \"name\" : \"Tech Support\",\n \"phone\" : null,\n \"email\" : \"support@rackwareinc.com\",\n \"subject\" : null\n }, {\n \"name\" : \"Tech Support\",\n \"phone\" : \"1 844 797 8776\",\n \"email\" : null,\n \"subject\" : null\n } ],\n \"supportLinks\" : [ {\n \"name\" : \"RackWare Support\",\n \"url\" : \"http://www.rackwareinc.com/support/\"\n } ],\n\"icon\" : {\n \"name\" : \"\",\n \"contentUrl\" : \"https://cloudmarketplace.oracle.com/marketplace/content?contentId=51603914\",\n \"mimeType\" : \"image/jpeg\",\n \"fileExtension\" : \"jpg\"\n},\n\"banner\" : null,\n\"regions\" : [ {\n \"name\" : \"us-phoenix-1\",\n},\n{\n \"name\" : \"us-ashburn-1\",\n}],\n\"packageType\" : \"IMAGE\",\n\"defaultPackageVersion\" : \"6.5.0\",\n\"links\" : [ ]\n\"listingType\": \"COMMUNITY\",\n\"supportedOperatingSystems\": [ {\n \"name\" : \"Linux\"\n}]\n}\n" PrivateOfferAccountDetails: description: Private Offer account details. properties: meter: description: Meter name maxLength: 255 minLength: 1 type: string sku: description: SKU name maxLength: 255 minLength: 1 type: string type: object CategoryCollection: description: Results of a category search. Contains the category items. properties: items: description: List of category summary. items: $ref: '#/components/schemas/CategorySummary' type: array required: - items type: object TermVersionSummary: description: The model for the term version summary. properties: compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the term version. 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: Unique OCID identifier for the term version. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the Term version. type: string x-obmcs-enumref: '#/definitions/TermVersion/lifecycleState' status: description: The current status for the term version. type: string x-obmcs-enumref: '#/definitions/TermVersion/status' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the term version was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the time version was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - status - lifecycleState - timeCreated - timeUpdated type: object x-example: "{\n \"id\" : \"ocid1.term.oc1.phx.abuw4ljrlsfiqw6vzzxb43vyypt4pkodawglp3wqxjqofakrwvou52gb6s5a\",\n \"name\" : \"Publisher Terms\",\n \"status\" : \"AVAILABLE\",\n \"lifeCycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-09-14T23:27:56.676Z\"\n}\n" UploadData: description: The model for upload data for images and icons. properties: contentUrl: description: The content URL of the upload data. maxLength: 255 minLength: 1 type: string mimeType: description: The MIME type of the upload data. maxLength: 100 minLength: 1 type: string name: description: The name used to refer to the upload data. maxLength: 255 minLength: 1 type: string type: object x-example: "{\n \"name\" : \"\",\n \"contentUrl\" : \"https://cloudmarketplace.oracle.com/marketplace/content?contentId=51603914\",\n \"mimeType\" : \"image/jpeg\"\n}\n" Lead: description: Details of Lead properties: additionalInfo: $ref: '#/components/schemas/AdditionalInfo' compartmentId: description: The OCID for the compartment. maxLength: 255 minLength: 1 type: string id: description: Unique OCID identifier for the lead. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state for the listing. enum: - ACTIVE - DELETED type: string listingId: description: The OCID for the listing. maxLength: 255 minLength: 1 type: string listingName: description: The Name for the listing. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the listing was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string required: - id - listingId - listingName - compartmentId - lifecycleState type: object ListingSummary: description: The model for a summary of the publisher listing. properties: compartmentId: description: The unique identifier of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 id: description: The unique OCID of the listing. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the Listing. type: string x-obmcs-enumref: '#/definitions/Listing/lifecycleState' listingType: description: The listing type of the Listing. enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ListingType' name: description: The name of the listing. maxLength: 200 minLength: 1 type: string packageType: description: The package type for the listing. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK - NONE type: string x-obmcs-top-level-enum: '#/definitions/PackageType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the listing was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the listing was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - listingType - name - lifecycleState - packageType - timeCreated - timeUpdated type: object x-example: "[\n {\n \"id\" : \"ocid1.listing.123\",\n \"compartmentId\": \"ocid1.tenancy.oc1..123a\",\n \"name\" : \"OAS_MP_CONTAINER_LISTING\",\n \"listingType\": \"OCI_APPLICATION\",\n \"packageType\": \"CONTAINER\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\" : \"2023-03-27T00:00:00.000Z\",\n \"timeUpdated\" : \"2023-03-27T00:00:00.000Z\"\n },\n {\n \"id\" : \"ocid1.listing.456\",\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaamexampleuniqueID\",\n \"name\" : \"OAS_MP_HELMCHART_LISTING\",\n \"listingType\": \"OCI_APPLICATION\",\n \"packageType\": \"HELM_CHART\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\" : \"2023-03-27T00:00:00.000Z\",\n \"timeUpdated\" : \"2023-03-27T00:00:00.000Z\"\n }\n]\n" ShapeMemoryOptions: description: Options for the the shape memory properties: maxInGBs: description: Maximum Memory configuration in GBs format: float type: number minInGBs: description: Minimum Memory configuration in GBs format: float type: number required: - minInGBs - maxInGBs type: object 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. maxLength: 255 minLength: 1 type: string operationType: description: Type of the work request enum: - PUBLISH_LISTING_REVISION_PACKAGE - UNPUBLISH_LISTING_REVISION_PACKAGE - PUBLISH_LISTING_REVISION - PUBLISH_LISTING_REVISION_AS_PRIVATE - WITHDRAW_LISTING_REVISION - CLONE_LISTING_REVISION - CASCADING_DELETE_LISTING - CASCADING_DELETE_LISTING_REVISION - MARK_AS_DEFAULT_LISTING_REVISION_PACKAGE - CHANGE_LISTING_COMPARTMENT - CREATE_ARTIFACT - VALIDATE_AND_PUBLISH_ARTIFACT - CHANGE_ARTIFACT_COMPARTMENT - CHANGE_TERM_COMPARTMENT - DELETE_ARTIFACT - UPDATE_ARTIFACT 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 - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED 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 LeadSummary: description: A placeholder for list of leads properties: additionalInfo: $ref: '#/components/schemas/AdditionalInfo' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 id: description: Unique OCID identifier for the listing. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state for the listing. type: string x-obmcs-enumref: '#/definitions/Lead/lifecycleState' listingId: description: The unique identifier for the listing. maxLength: 255 minLength: 1 type: string listingName: description: The name of the listing. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the listing was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string type: object ChangeListingCompartmentDetails: description: Contains details indicating which compartment the listing should move to. properties: compartmentId: description: The id of the compartment which the listing should be moved. maxLength: 255 minLength: 1 type: string ListingRevisionPackageSummary: description: The model for a summary of a package. properties: areSecurityUpgradesProvided: description: Identifies whether security upgrades will be provided for this package. type: boolean compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 listing revision package. 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 ID of the listing revision package. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Package. type: string x-obmcs-enumref: '#/definitions/ListingRevisionPackage/lifecycleState' listingRevisionId: description: The ID of the listing revision. maxLength: 255 minLength: 1 type: string packageType: description: The specified package's type. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK - NONE type: string x-obmcs-top-level-enum: '#/definitions/PackageType' packageVersion: description: The version of the specified package. maxLength: 200 minLength: 0 type: string status: description: The current status of the package. type: string x-obmcs-enumref: '#/definitions/ListingRevisionPackage/status' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the publication package was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the publication package was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string required: - id - listingRevisionId - compartmentId - displayName - packageVersion - packageType - areSecurityUpgradesProvided - lifecycleState - status - timeCreated - timeUpdated type: object x-example: "[\n {\n \"listingRevisionId\" : \"listing revision OCID\",\n \"displayName\" : \"Weblogic Orchestration\",\n \"packageVersion\" : \"WLS 12.2.1.3.19041601\",\n \"packageType\" : \"ORCHESTRATION\",\n \"artifactId\" : \"artifact OCID\",\n \"timeCreated\" : \"2019-05-02T00:00:00.000Z\",\n \"timeUpdated\" : \"2019-05-02T00:00:00.000Z\"\n },\n {\n \"listingRevisionId\" : \"listing revision OCID\",\n \"displayName\" : \"Weblogic Orchestration latest\",\n \"packageVersion\" : \"WLS 10.3.6.0.19041601(11.1.1.7)\",\n \"packageType\" : \"ORCHESTRATION\",\n \"artifactId\" : \"artifact OCID\",\n \"timeCreated\" : \"2019-05-02T00:00:00.000Z\",\n \"timeUpdated\" : \"2019-05-02T00:00:00.000Z\"\n }\n]\n" AdditionalFilter: description: Additional filters for the product properties: code: description: Filter code maxLength: 255 type: string isMandatory: description: Is the product code mandatory or not type: boolean isMultiSelect: description: Is multiselect available for product code or not type: boolean name: description: Filter name maxLength: 255 type: string properties: description: Additional filters attached to custom filter items: $ref: '#/components/schemas/FilterProperty' maxItems: 10 type: array usageInstructions: description: Usage instructions for the properties type: string type: object MarketCollection: description: Results of a market search. Contains the market items. properties: items: description: List of market summary. items: $ref: '#/components/schemas/MarketSummary' type: array required: - items type: object CategorySummary: description: The model for the category summary. properties: code: description: The code of the category. maxLength: 200 minLength: 1 type: string lifecycleState: description: The current state of the category. type: string x-obmcs-enumref: '#/definitions/Category/lifecycleState' name: description: The name of the category. maxLength: 200 minLength: 1 type: string productCode: description: The product that the category belongs. maxLength: 200 minLength: 1 type: string timeCreated: description: 'The date and time the category was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the category was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - code - productCode - lifecycleState - timeCreated - timeUpdated type: object x-example: "{\n \"Id\": \"ocid1.category.123\",\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaamexampleuniqueID\",\n \"name\": \"Networking\",\n \"productCode\": \"NETWORKING\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\" : \"2023-03-25T00:00:00.000Z\",\n \"timeUpdated\" : \"2023-03-25T00:00:00.000Z\"\n}\n" PublisherCollection: description: Results of a publisher search. Contains Publisher items. properties: items: description: List of publisher summary. items: $ref: '#/components/schemas/PublisherSummary' type: array required: - items type: object Publisher: allOf: - $ref: '#/components/schemas/PublisherSummary' - properties: notificationEmail: description: The private email address of the publisher product team. maxLength: 254 minLength: 0 type: string opnMembership: $ref: '#/components/schemas/OpnMembership' privateOfferAccountDetails: $ref: '#/components/schemas/PrivateOfferAccountDetails' publisherStatus: description: publisher status. enum: - NEW - APPROVED - SUSPENDED - REMOVED - REJECTED - CONTACTED type: string required: - publisherStatus type: object description: The model for a publisher details. CreateTermDetails: description: Details to create Marketplace Publisher term. properties: compartmentId: description: The OCID of the publisher's compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 name: description: The name of the term. maxLength: 200 minLength: 1 type: string required: - compartmentId - name type: object x-example: "{\n \"compartmentId\": \"ocid1.term.123\",\n \"name\": \"PUBLISHER_MP_TERM\"\n}\n" CustomerInstanceReportRecordCollection: description: Customer instance report properties: items: description: List of customer instance report records. items: $ref: '#/components/schemas/CustomerInstanceReportRecord' type: array required: - items type: object MarketSummary: description: The model for the market metadata. properties: billToCountries: description: bill to countries for the market. items: maxLength: 255 minLength: 1 type: string type: array categoryCode: description: The category code for the market. maxLength: 255 minLength: 1 type: string code: description: The code of the product. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the market. type: string x-obmcs-enumref: '#/definitions/Market/lifecycleState' name: description: The name of the product. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the market was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the market was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - code - categoryCode - billToCountries - lifecycleState - timeCreated - timeUpdated type: object x-example: "{\n \"name\" : \"US Commercial\",\n \"code\" : \"US\",\n \"categoryCode\" : \"Commercial\",\n \"billToCountries\": [\n \"United States\"\n ],\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2023-03-27T00:00:00.000Z\",\n \"timeUpdated\" : \"2023-03-27T00:00:00.000Z\"\n}\n" ListingRevisionAttachment: description: A attachment for the listing revision. User can provide an external URL/upload a file discriminator: propertyName: attachmentType properties: attachmentType: description: 'Possible values for the publisher listing revision attachments. The attachment type informs the type of attachment for the listing revision. ' enum: - RELATED_DOCUMENT - SCREENSHOT - VIDEO - REVIEW_SUPPORT_DOCUMENT - CUSTOMER_SUCCESS - SUPPORTED_SERVICES type: string compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: Description of the listing revision attachment. maxLength: 2000 minLength: 1 type: string displayName: description: Name of the listing revision attachment. 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: Unique OCID identifier for the listing revision attachment. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the attachment. enum: - ACTIVE - INACTIVE - DELETED type: string listingRevisionId: description: The unique identifier of the listing revision that the specified attachment belongs to. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the attachment was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the attachment was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - listingRevisionId - displayName - attachmentType - lifecycleState - timeCreated - timeUpdated type: object x-example: "{\n \"listingId\" : \"listing OCID\",\n \"listingRevisionId\" : \"listing revision OCID\",\n \"attachmentId\" : \"attachment OCID\",\n \"displayName\" : \"RackWare RMM Platform\",\n \"contentUrl\" : \"https://cloudmarketplace.oracle.com/marketplace/content?contentId=51603917\",\n \"attachmentType\" : \"Data Sheets\",\n \"timeCreated\" : \"2022-10-18T00:00:00.000Z\",\n \"timeUpdated\" : \"2022-10-19T00:00:00.000Z\"\n}\n" ListingRevisionNoteCollection: description: Results of note search. Contains listing revision note items. properties: items: description: List of note summary. items: $ref: '#/components/schemas/ListingRevisionNoteSummary' type: array required: - items type: object UpdateListingRevisionNoteDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher listing revision. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 type: object ProductSummary: description: The model for the product metadata. properties: additionalFilters: description: Additional filter properties for product items: $ref: '#/components/schemas/AdditionalFilter' maxItems: 10 type: array code: description: The code for the product. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the product. type: string x-obmcs-enumref: '#/definitions/Product/lifecycleState' name: description: The name for the product. maxLength: 255 minLength: 1 type: string productGroup: description: The product group for the product. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the product was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the product was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - lifecycleState - timeCreated - timeUpdated type: object x-example: "{\n \"name\" : \"Oracle Cloud Infrastructure\",\n \"code\" : \"OCI\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2023-03-27T23:27:56.676Z\",\n \"timeUpdated\" : \"2023-03-27T23:27:56.676Z\"\n}\n" NamedLink: description: A link to a resource on the internet. properties: name: description: Text that describes the resource. maxLength: 4000 minLength: 1 type: string url: description: The URL of the resource. maxLength: 4000 minLength: 1 type: string required: - name - url type: object x-example: "{\n \"name\" : \"RackWare Support\",\n \"url\" : \"http://www.rackwareinc.com/support/\"\n}\n" ListingRevisionAttachmentSummary: description: The model for a summary of a listing revision related attachments. properties: attachmentType: description: The specified attachment type. type: string x-obmcs-enumref: '#/definitions/ListingRevisionAttachment/attachmentType' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string contentUrl: description: The URL of the specified attachment. maxLength: 4000 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 specified document. maxLength: 255 minLength: 1 type: string documentCategory: description: Possible lifecycle states. 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 of the listing revision attachment. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the document. type: string x-obmcs-enumref: '#/definitions/ListingRevisionAttachment/lifecycleState' listingRevisionId: description: The ID of the listing revision. maxLength: 255 minLength: 1 type: string mimeType: description: The MIME type of the screenshot. maxLength: 200 minLength: 0 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the related document was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the related document was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string required: - id - listingRevisionId - compartmentId - displayName - attachmentType - contentUrl - timeCreated - timeUpdated type: object x-example: "[\n {\n \"listingId\" : \"listing OCID\",\n \"listingRevisionId\" : \"listing revision OCID\",\n \"displayName\" : \"WLS 12.2.1.3.19041601\",\n \"attachmentType\" : \"CASESTUDIES\",\n \"contentUrl\" : \"content Url\",\n \"timeCreated\" : \"2019-05-02T00:00:00.000Z\",\n \"timeUpdated\" : \"2019-05-02T00:00:00.000Z\"\n },\n {\n \"listingId\" : \"listing OCID\",\n \"listingRevisionId\" : \"listing revision OCID\",\n \"displayName\" : \"WLS 10.3.6.0.19041601(11.1.1.7)\",\n \"attachmentType\" : \"CUSTOMIZATIONGUIDES\",\n \"contentUrl\" : \"content Url\",\n \"timeCreated\" : \"2019-05-02T00:00:00.000Z\",\n \"timeUpdated\" : \"2019-05-02T00:00:00.000Z\"\n }\n]\n" UpdateArtifactDetails: description: 'The model for an Oracle Cloud Infrastructure Marketplace artifact. ' discriminator: propertyName: artifactType properties: artifactType: description: Artifact Type for the artifact. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK type: string x-obmcs-top-level-enum: '#/definitions/ArtifactTypeEnum' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the artifact. 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 type: object ChangeArtifactCompartmentDetails: description: Contains details indicating which compartment the artifact should move to. properties: compartmentId: description: The unique identifier of the compartment for the artifact. maxLength: 255 minLength: 1 type: string required: - compartmentId 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 SupportDocSummary: description: The model for the supportDoc metadata. properties: code: description: The code for the supportDoc. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the supportDoc. type: string x-obmcs-enumref: '#/definitions/SupportDoc/lifecycleState' name: description: The name for the supportDoc. maxLength: 255 minLength: 1 type: string supportDocGroup: description: The supportDoc group for the supportDoc. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the supportDoc was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the product was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - lifecycleState - timeCreated - timeUpdated - code - supportDocGroup type: object x-example: "{\n \"name\" : \"Oracle Cloud Infrastructure\",\n \"code\" : \"OCI\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2023-03-27T23:27:56.676Z\",\n \"timeUpdated\" : \"2023-03-27T23:27:56.676Z\"\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. maxLength: 255 minLength: 1 type: string operationType: description: Type of the work request enum: - PUBLISH_LISTING_REVISION_PACKAGE - UNPUBLISH_LISTING_REVISION_PACKAGE - PUBLISH_LISTING_REVISION - PUBLISH_LISTING_REVISION_AS_PRIVATE - WITHDRAW_LISTING_REVISION - CLONE_LISTING_REVISION - CASCADING_DELETE_LISTING - CASCADING_DELETE_LISTING_REVISION - MARK_AS_DEFAULT_LISTING_REVISION_PACKAGE - CHANGE_LISTING_COMPARTMENT - CREATE_ARTIFACT - VALIDATE_AND_PUBLISH_ARTIFACT - CHANGE_ARTIFACT_COMPARTMENT - CHANGE_TERM_COMPARTMENT - DELETE_ARTIFACT - UPDATE_ARTIFACT 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 - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED 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 ListingRevisionPackage: description: A base object for all types of listing revision packages. discriminator: propertyName: packageType properties: areSecurityUpgradesProvided: description: Identifies whether security upgrades will be provided for this package. type: boolean artifactId: description: The unique identifier for the artifact. maxLength: 255 minLength: 1 type: string compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: The description of this package. maxLength: 255 minLength: 0 type: string displayName: description: The name of the listing revision package. maxLength: 255 minLength: 1 type: string extendedMetadata: additionalProperties: type: string description: 'Additional metadata key/value pairs for the listing revision package summary. For example: `{"partnerListingRevisionPackageStatus": "Published","parentListingRevisionPackageId": "1" }` ' maxLength: 255 maxProperties: 25 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 id: description: The OCID for the listing revision package in Marketplace Publisher. maxLength: 255 minLength: 1 type: string isDefault: description: Identifies that this will be default package for the listing revision. type: boolean lifecycleState: description: The current state for the listing revision package. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string listingRevisionId: description: The unique identifier for the listing revision. maxLength: 255 minLength: 1 type: string packageType: description: The package type for the listing. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK - NONE type: string x-obmcs-top-level-enum: '#/definitions/PackageType' packageVersion: description: The version for the package. maxLength: 200 minLength: 0 type: string status: description: The current status for the listing revision package. enum: - NEW - PUBLISH_IN_PROGRESS - UNPUBLISH_IN_PROGRESS - PUBLISH_FAILED - PUBLISHED - PUBLISHED_AS_PRIVATE - UNPUBLISHED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object termId: description: The unique identifier for the term. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time this listing revision package was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time this listing revision package was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - listingRevisionId - displayName - compartmentId - artifactId - termId - packageVersion - packageType - lifecycleState - status - areSecurityUpgradesProvided - isDefault - timeCreated - timeUpdated type: object x-example: "{\n \"listingId\": \"ocid1.listing.123\",\n \"artifactId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"packageVersion\": \"v1\",\n \"packageType\": \"IMAGE\"\n}\n" TermVersionCollection: description: Results of the term version search. Contains term version items. properties: items: description: List of the Terms version summary. items: $ref: '#/components/schemas/TermVersionSummary' type: array required: - items type: object PublisherSummary: description: The model for a publisher. properties: compartmentId: description: The root compartment of the Publisher. maxLength: 255 minLength: 1 type: string contactEmail: description: The public email address of the publisher for customers. maxLength: 255 minLength: 1 type: string contactPhone: description: The phone number of the publisher in E.164 format. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: A description of the publisher. maxLength: 1000 minLength: 1 type: string displayName: description: The name of the publisher. maxLength: 255 minLength: 1 type: string facebookUrl: description: Publisher's Facebook URL maxLength: 100 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 hqAddress: description: The address of the publisher's headquarters. maxLength: 500 minLength: 1 type: string id: description: Unique OCID identifier for the publisher. maxLength: 255 minLength: 1 type: string legacyId: description: Unique legacy service identifier for the publisher. maxLength: 100 minLength: 1 type: string linkedinUrl: description: Publisher's LinkedIn URL maxLength: 100 minLength: 1 type: string logo: $ref: '#/components/schemas/UploadData' publisherType: description: publisher type. enum: - INTERNAL - EXTERNAL type: string registryNamespace: description: The namespace for the publisher registry to persist artifacts. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the publisher was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the publisher was updated. An RFC3339 formatted datetime string. format: date-time type: string twitterUrl: description: Publisher's Twitter URL maxLength: 100 minLength: 1 type: string websiteUrl: description: The publisher's website. maxLength: 100 minLength: 1 type: string yearFounded: description: The year the publisher's company or organization was founded. format: int64 type: integer required: - id - compartmentId - registryNamespace - displayName - contactEmail - contactPhone - publisherType - timeCreated - timeUpdated type: object x-example: "{\n \"id\" : \"ocid1.marketplacepubisheraccount.oc1.iad.aaaaaaaa6c7hyztjdkfxtzuikystxdonlh6biwd63pm43awkhmdgyd7ucabc\",\n \"legacyId\" : \"7376171\",\n \"displayName\" : \"Rackware, Inc.\",\n \"description\" : \"Data Migration, Cloud Automation and Disaster Recovery\",\n \"yearFounded\" : 2008,\n \"websiteUrl\" : \"http://www.rackwareinc.com/\",\n \"hqAddress\" : \"Fremont, CA, United States\",\n \"logo\" : null\n}\n" ListingCollection: description: Results of listing search. Contains Listing items. properties: items: description: List of listing summary. items: $ref: '#/components/schemas/ListingSummary' type: array required: - items type: object AvailableServiceSummary: description: Available service provider listing for lead generation listings properties: displayName: description: The name of the listing revision. maxLength: 255 minLength: 1 type: string icon: $ref: '#/components/schemas/ListingRevisionIconAttachment' listingId: description: Listing Id for the listing maxLength: 255 type: string shortDescription: description: A short description of the listing revision. maxLength: 320 minLength: 0 type: string tagline: description: The tagline of the listing revision. maxLength: 200 minLength: 0 type: string required: - listingId type: object TermVersion: description: Model object for the term version details. properties: attachment: $ref: '#/components/schemas/TermVersionAttachment' author: description: Who authored the term. Publisher terms will be defaulted to 'PARTNER'. type: string x-obmcs-enumref: '#/definitions/Term/author' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the term version. 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: Unique OCID identifier for the term version. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the term version. enum: - ACTIVE - INACTIVE type: string status: description: The current status for the term version. enum: - AVAILABLE - NOT_AVAILABLE - DELETED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object termAuthor: description: Who authored the term. Publisher terms will be defaulted to 'PARTNER'. type: string x-obmcs-enumref: '#/definitions/Term/author' termId: description: The unique identifier for the term. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the term version was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the term version was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - termId - termAuthor - attachment - displayName - status - lifecycleState - timeCreated - timeUpdated type: object SupportedCurrencySummary: description: The model for the currencies supported by the Marketplace Publisher Service. properties: currencyCode: description: The currency code, in the format specified by ISO-4217. maxLength: 3 minLength: 3 type: string exchangeRate: description: Oracle exchange rate for the currency in USD. format: float type: number lifecycleState: description: The current state for the currency. enum: - ACTIVE - INACTIVE type: string required: - currencyCode - exchangeRate - lifecycleState type: object ListingRevisionAttachmentCollection: description: Results of the listing attachments search. Contains attachment items. properties: items: description: List of attachment summary. items: $ref: '#/components/schemas/ListingRevisionAttachmentSummary' type: array required: - items type: object CreateListingRevisionNoteDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher listing revision note. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 listingRevisionId: description: The unique identifier of the listing revision that the specified note belongs to. maxLength: 255 minLength: 1 type: string noteDetails: description: Notes provided for the listing revision. maxLength: 8000 minLength: 0 type: string required: - listingRevisionId - noteDetails type: object Product: description: The model for the product details. properties: additionalFilters: description: Additional filter properties for product items: $ref: '#/components/schemas/AdditionalFilter' maxItems: 10 type: array code: description: The code for the product. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the product. enum: - ACTIVE - INACTIVE type: string name: description: The name for the product. maxLength: 255 minLength: 1 type: string productGroup: description: The product group for the product. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the product was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the product was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - code - productGroup - lifecycleState - timeCreated - timeUpdated 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 - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' 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 identifier: description: The identifier of the resource the work request affects. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier UpdateListingDetails: description: Details to update an existing listing. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 type: object SupportDoc: description: The model for the supportDoc details. properties: code: description: The code for the supportDoc. maxLength: 255 minLength: 1 type: string contentUrl: description: The URL of the specified attachment. maxLength: 255 minLength: 1 type: string description: description: The description of the supportDoc. maxLength: 500 minLength: 1 type: string fileName: description: The file name of the attachment. maxLength: 255 minLength: 0 type: string lifecycleState: description: The current state for the supportDoc. enum: - ACTIVE - INACTIVE type: string mimeType: description: The MIME type of the attachment. maxLength: 255 minLength: 0 type: string name: description: The name for the supportDoc. maxLength: 255 minLength: 1 type: string supportDocGroup: description: The supportDoc group for the supportDoc. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the supportDoc was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the supportDoc was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - code - supportDocGroup - lifecycleState - timeCreated - timeUpdated type: object CreateListingRevisionPackageDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher listing revision package. properties: areSecurityUpgradesProvided: description: Identifies whether security upgrades will be provided for this package. type: boolean artifactId: description: The unique identifier for the artifact. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: Description for this package. maxLength: 400 minLength: 0 type: string displayName: description: The name for the listing revision package. 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 isDefault: description: Identifies that this will be default package for the listing revision. type: boolean listingRevisionId: description: The OCID for the listing revision in Marketplace Publisher. maxLength: 255 minLength: 1 type: string packageVersion: description: The version for the package. maxLength: 200 minLength: 1 type: string termId: description: The unique identifier for the term. maxLength: 255 minLength: 1 type: string required: - listingRevisionId - packageVersion - artifactId - termId - areSecurityUpgradesProvided type: object ListingRevisionPackageCollection: description: Results of package search. Contains Package items. properties: items: description: List of package summary. items: $ref: '#/components/schemas/ListingRevisionPackageSummary' type: array required: - items type: object LeadCollection: description: The model for the collection of Marketplace Publisher Lead. properties: items: description: List of Lead summary. items: $ref: '#/components/schemas/LeadSummary' type: array required: - items type: object 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 TermVersionAttachment: description: An attachment uploaded by the Publisher for the term. properties: contentUrl: description: The content URL of the uploaded data. maxLength: 2047 minLength: 1 type: string mimeType: description: The MIME type of the uploaded data. maxLength: 255 minLength: 1 type: string required: - contentUrl - mimeType type: object UpdateTermDetails: description: Details to update Marketplace Publisher term. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 type: object TermCollection: description: Results of the term search. Contains term items. properties: items: description: List of the Terms summary. items: $ref: '#/components/schemas/TermSummary' type: array required: - items type: object LanguageItem: description: The model for a language item within an array of filter values. properties: code: description: A code assigned to the item. maxLength: 200 minLength: 1 type: string name: description: The name of the item. maxLength: 200 minLength: 1 type: string required: - name - code type: object x-example: "{\n \"name\" : \"English\",\n \"code\" : \"en_US\"\n}\n" SupportContact: description: Contact information to use to get support. properties: email: description: The email of the contact. maxLength: 4000 minLength: 0 type: string name: description: The name of the contact. maxLength: 1000 minLength: 1 type: string phone: description: The phone number of the contact. maxLength: 200 minLength: 0 type: string subject: description: The email subject line to use when contacting support. maxLength: 200 minLength: 0 type: string required: - name type: object x-example: "{\n \"name\" : \"Tech Support\",\n \"phone\" : null,\n \"email\" : \"support@rackwareinc.com\",\n \"subject\" : null\n}\n" ListingRevisionSummary: description: The model for a summary of an Oracle Cloud Infrastructure Marketplace Publisher listing revision. properties: compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 listing revision. 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 icon: $ref: '#/components/schemas/ListingRevisionIconAttachment' id: description: The OCID for the listing revision in Marketplace Publisher. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Listing. type: string x-obmcs-enumref: '#/definitions/ListingRevision/lifecycleState' listingId: description: The OCID for the listing in Marketplace Publisher. maxLength: 255 minLength: 1 type: string listingType: description: The listing's type. Populated from the listing. enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ListingType' packageType: description: The listing's package type. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK - NONE type: string x-obmcs-top-level-enum: '#/definitions/PackageType' shortDescription: description: A short description of the listing revision. maxLength: 320 minLength: 0 type: string status: description: The current status of the listing revision. type: string x-obmcs-enumref: '#/definitions/ListingRevision/status' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tagline: description: The tagline of the listing revision. maxLength: 200 minLength: 0 type: string timeCreated: description: 'The date and time the listing revision was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the listing revision was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - id - listingId - compartmentId - displayName - lifecycleState - status - packageType - timeCreated - timeUpdated - listingType type: object x-example: "[\n {\n \"id\" : \"\",\n \"name\" : \"Jenkins Certified by Bitnami\",\n \"shortDescription\" : \"Jenkins image is secure, up-to-date and pre-configured to work out of the box.\",\n \"tagline\" : \"Continuous Integration software from the leading publisher\",\n \"icon\" : {\n \"name\" : \"\",\n \"contentUrl\" : \"https://cloudmarketplace.oracle.com/marketplace/content?contentId=53066708\",\n \"mimeType\" : \"image/png\",\n \"fileExtension\" : \"png\"\n },\n \"markets\" : null,\n \"supportedOperatingSystems\": [ {\n \"name\" : \"Linux\"\n }],\n \"listingType\": \"OCI_APPLICATION\",\n },\n {\n \"id\" : \"29367738\",\n \"name\" : \"RackWare RMM 6.5 for OCI\",\n \"shortDescription\" : \"RMM provides complete cloud management. Cloud Migration, Image Mobility, Disaster Recovery, Backup, intelligent provisioning, autoscaling, and cloud governance that harnesses the benefits of cloud technology, while taking advantage of existing IT capabilities and investments.\",\n \"tagline\" : \"RackWare RMM provides an image mobility and disaster recovery solution\",\n \"icon\" : {\n \"name\" : \"\",\n \"contentUrl\" : \"https://cloudmarketplace.oracle.com/marketplace/content?contentId=51603914\",\n \"mimeType\" : \"image/jpeg\",\n \"fileExtension\" : \"jpg\"\n },\n \"markets\" : null,\n \"supportedOperatingSystems\": [ {\n \"name\" : \"Linux\"\n }],\n \"listingType\": \"OCI_APPLICATION\",\n \"compatibleArchitectures\" : [ \"X86\" ],\n }\n]\n" CreateListingRevisionDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher listing revision. discriminator: propertyName: listingType properties: contentLanguage: $ref: '#/components/schemas/LanguageItem' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the listing revision. 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 headline: description: Single line introduction for the listing revision. maxLength: 255 minLength: 1 type: string keywords: description: Keywords associated with the listing revision. maxLength: 500 minLength: 0 type: string listingId: description: The unique identifier for the listing this revision belongs to. maxLength: 255 minLength: 1 type: string listingType: description: The listing's type. Populated from the listing. enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ListingType' longDescription: description: A long description for the listing revision. maxLength: 4000 minLength: 0 type: string shortDescription: description: A short description for the listing revision. maxLength: 320 minLength: 0 type: string status: description: The current status of the Listing revision. type: string x-obmcs-enumref: '#/definitions/ListingRevision/status' supportContacts: description: Contact information to use to get support from the publisher for the listing revision. items: $ref: '#/components/schemas/SupportContact' type: array supportLinks: description: Links to support resources for the listing revision. items: $ref: '#/components/schemas/NamedLink' type: array supportedlanguages: description: Languages supported by the publisher for the listing revision. items: $ref: '#/components/schemas/LanguageItem' type: array tagline: description: The tagline for the listing revision. maxLength: 200 minLength: 0 type: string usageInformation: description: Usage information for the listing revision. maxLength: 4000 minLength: 0 type: string required: - listingId - headline - listingType type: object ListingRevisionCollection: description: Results of listing revision search. Contains Listing revision items. properties: items: description: List of listing revision summary. items: $ref: '#/components/schemas/ListingRevisionSummary' type: array required: - items type: object CreateArtifactDetails: description: Common Details to create Marketplace Publisher artifact. discriminator: propertyName: artifactType properties: artifactType: description: Artifact Type for the artifact. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK type: string x-obmcs-top-level-enum: '#/definitions/ArtifactTypeEnum' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the artifact. 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: - compartmentId - artifactType type: object FilterProperty: description: Properties for the filter properties: code: description: Filter code maxLength: 255 type: string name: description: Name of filter maxLength: 255 type: string type: object SupportedShapeSummary: description: Summary of the database system shape. properties: isFlexible: description: Indicates if the shape is a flex shape. type: boolean memoryOptions: $ref: '#/components/schemas/ShapeMemoryOptions' ocpuOptions: $ref: '#/components/schemas/ShapeOcpuOptions' shape: description: 'The name of the Compute VM shape. Example: `VM.Standard.E4.Flex` ' type: string required: - shape - isFlexible type: object OpnMembership: description: OPN membership information properties: opnMembershipType: description: OPN membership type maxLength: 255 minLength: 1 type: string opnNumber: description: OPN Number number maxLength: 255 minLength: 1 type: string opnStatus: description: OPN status enum: - ACTIVE - INACTIVE - RENEWAL_IN_PROGRESS type: string timeEnd: description: OPN membership end date. An RFC3339 formatted datetime string format: date-time type: string timeStart: description: OPN membership start date. An RFC3339 formatted datetime string format: date-time type: string type: object UpdateListingRevisionAttachmentDetails: description: 'Update the attachment for the listing revision. ' discriminator: propertyName: attachmentType properties: attachmentType: description: The specified attachment type for the listing revision attachment. type: string x-obmcs-enumref: '#/definitions/ListingRevisionAttachment/attachmentType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: The description for the listing revision attachment. maxLength: 400 minLength: 0 type: string displayName: description: The name for the listing revision attachment. 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 type: object Market: description: The model for the market details. properties: billToCountries: description: bill to countries for the market. items: maxLength: 255 minLength: 1 type: string type: array categoryCode: description: The category code of the market. maxLength: 255 minLength: 1 type: string code: description: The code of the market. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the market. enum: - ACTIVE - INACTIVE type: string name: description: The name of the market. maxLength: 255 minLength: 1 type: string realmCode: description: The realm code of the market. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the market was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the market was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - code - categoryCode - billToCountries - lifecycleState - timeCreated - timeUpdated type: object ListingRevisionNoteSummary: description: The model for a summary of a listing revision notes. properties: compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 id: description: The OCID of the listing revision note. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the note. type: string x-obmcs-enumref: '#/definitions/ListingRevisionNote/lifecycleState' listingRevisionId: description: The unique identifier of the listing revision that the specified note belongs to. maxLength: 255 minLength: 1 type: string noteDetails: description: Notes provided for the listing revision. maxLength: 8000 minLength: 0 type: string noteSource: description: type of the note. type: string x-obmcs-enumref: '#/definitions/ListingRevisionNote/noteSource' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the listing revision note was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the listing revision note was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-09-24T21:10:29.600Z` ' format: date-time type: string required: - id - listingRevisionId - compartmentId - noteSource - noteDetails - timeCreated - timeUpdated type: object x-example: "[\n {\n \"listingRevisionId\" : \"listing revision OCID\",\n \"publisherNote\" : \"Weblogic Orchestration\",\n \"adminNote\" : \"listing has been approved\",\n \"timeCreated\" : \"2023-02-14T00:00:00.000Z\",\n \"timeUpdated\" : \"2023-02-14T00:00:00.000Z\"\n }\n]\n" PublishListingRevisionAsPrivateDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher publish as private listing revision. properties: allowedTenancies: description: Allowed tenancies provided when a listing is published as private. items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array type: object ProductCollection: description: Results of a product search. Contains the product items. properties: items: description: List of product summary. items: $ref: '#/components/schemas/ProductSummary' type: array required: - items type: object Term: description: Base model object for the term. properties: author: description: Who authored the term. Publisher terms will be defaulted to 'PARTNER'. enum: - ORACLE - PARTNER type: string compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 id: description: Unique OCID identifier for the term. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the Term. enum: - ACTIVE - INACTIVE type: string name: description: The name for the term. maxLength: 255 minLength: 1 type: string publisherId: description: The unique identifier for the publisher. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the term was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the term was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - author - compartmentId - publisherId - lifecycleState - timeCreated - timeUpdated type: object UpdateListingRevisionDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Publisher listing revision. discriminator: propertyName: listingType properties: contentLanguage: $ref: '#/components/schemas/LanguageItem' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the listing revision. 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 headline: description: Single line introduction for the listing revision. maxLength: 255 minLength: 1 type: string keywords: description: Keywords associated for the listing revision. maxLength: 500 minLength: 0 type: string listingType: description: The listing's type. Populated from the listing. enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ListingType' longDescription: description: A long description for the listing revision. maxLength: 4000 minLength: 0 type: string shortDescription: description: A short description for the listing revision. maxLength: 320 minLength: 0 type: string supportContacts: description: Contact information to use to get support from the publisher for the listing revision. items: $ref: '#/components/schemas/SupportContact' type: array supportLinks: description: Links to support resources for the listing revision. items: $ref: '#/components/schemas/NamedLink' type: array supportedlanguages: description: Languages supported by the listing revision. items: $ref: '#/components/schemas/LanguageItem' type: array tagline: description: The tagline for the listing revision. maxLength: 200 minLength: 0 type: string usageInformation: description: Usage information for the listing revision. maxLength: 4000 minLength: 0 type: string required: - listingType type: object CustomerInstanceReportRecord: description: The model for instance report item properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 instanceId: description: Instance OCID maxLength: 255 minLength: 1 type: string listingId: description: Listing ID maxLength: 255 minLength: 1 type: string listingName: description: Name of the listing maxLength: 255 minLength: 1 type: string listingVersionId: description: Listing version ID maxLength: 255 minLength: 1 type: string ociTenancy: description: The tenancy of the instance maxLength: 255 minLength: 0 type: string packageVersion: description: The version for the package maxLength: 200 minLength: 1 type: string packageVersionId: description: Package version ID maxLength: 255 minLength: 1 type: string publisherId: description: publisher OCID maxLength: 255 minLength: 1 type: string realm: description: The realm of the instance maxLength: 10 minLength: 0 type: string region: description: The region of the instance maxLength: 100 minLength: 0 type: string shape: description: The shape of the instance maxLength: 255 minLength: 0 type: string status: description: Instance status maxLength: 50 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tenantAdminEmail: description: The email of the tenant adminstrator maxLength: 4000 minLength: 1 type: string tenantAdminName: description: The name of the tenant adminstrator maxLength: 255 minLength: 1 type: string timeInstanceCreation: description: 'The date and time that instance was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeInstanceTermination: description: 'The date and time that instance was terminated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: object CreateListingDetails: description: Details to create a new listing. properties: compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 listingType: description: The listing type for the listing. enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ListingType' name: description: The name for the listing. maxLength: 200 minLength: 1 type: string packageType: description: The package type for the listing. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK - NONE type: string x-obmcs-top-level-enum: '#/definitions/PackageType' required: - compartmentId - listingType - packageType - name type: object x-example: "{\n \"Id\": \"ocid1.listing.123\",\n \"compartmentId\": \"ocid1.tenancy.oc1..123a\",\n \"name\": \"OAS_MP_HELM_LISTING\",\n \"listingType\": \"OCI_APPLICATION\",\n \"packageType\": \"HELM_CHART\"\n}\n" CreateListingRevisionAttachmentDetails: description: 'Attachment uploaded by the publisher for the listing revision. ' discriminator: propertyName: attachmentType properties: attachmentType: description: The specified attachment type. type: string x-obmcs-enumref: '#/definitions/ListingRevisionAttachment/attachmentType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: Description for this specified attachment. maxLength: 400 minLength: 0 type: string displayName: description: The name for the listing revision attachment. 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 listingRevisionId: description: The OCID for the listing revision in Marketplace Publisher. maxLength: 255 minLength: 1 type: string required: - listingRevisionId - attachmentType type: object Listing: description: The model for the Marketplace Publisher listing. properties: compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 extendedMetadata: additionalProperties: type: string description: 'Additional metadata key/value pairs for the listing summary. For example: `{"listingRevisionStatus": "Published","listingRevision": "1" }` ' maxLength: 255 maxProperties: 25 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 id: description: Unique OCID identifier for the listing. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Listing. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string listingType: description: The listing type for the listing. enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ListingType' name: description: Name for the listing. maxLength: 255 minLength: 1 type: string packageType: description: The package type for the listing. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK - NONE type: string x-obmcs-top-level-enum: '#/definitions/PackageType' publisherId: description: The unique identifier for the publisher. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the listing was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the listing was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - publisherId - listingType - name - packageType - timeCreated - timeUpdated type: object SupportDocCollection: description: Results of a supportDoc search. Contains the supportDoc items. properties: items: description: List of supportDoc summary. items: $ref: '#/components/schemas/SupportDocSummary' type: array required: - items type: object ListingRevisionIconAttachment: description: An attachment uploaded by the Publisher to be attached to the listing revision. properties: contentUrl: description: The content URL of the uploaded data. maxLength: 2047 minLength: 1 type: string mimeType: description: The MIME type of the uploaded data. maxLength: 255 minLength: 1 type: string required: - contentUrl - mimeType type: object SupportedShapeCollection: description: The list of shapes that can be used to create a database system. properties: items: description: List of supported shapes. items: $ref: '#/components/schemas/SupportedShapeSummary' type: array required: - items type: object DisbursementReportRecord: description: The model for disbursement report item properties: city: description: City maxLength: 255 minLength: 1 type: string country: description: Country maxLength: 16 minLength: 1 type: string currencyCode: description: Currency Code maxLength: 16 minLength: 1 type: string customerDomain: description: Customer Domain maxLength: 255 minLength: 1 type: string customerId: description: Customer ID maxLength: 255 minLength: 1 type: string customerName: description: Customer Name maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 disbursementAmountUsd: description: Disbursement Amount (USD) maxLength: 64 minLength: 1 type: string endUserCustomerId: description: End User Customer ID maxLength: 255 minLength: 1 type: string endUserCustomerName: description: EEnd User Customer Name maxLength: 255 minLength: 1 type: string enterprisePeriod: description: Enterprise Period maxLength: 32 minLength: 1 type: string enterpriseQuarter: description: Enterprise Quarter maxLength: 32 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 fxRateLcToUsd: description: FX Rate (LC to USD) maxLength: 64 minLength: 1 type: string lcAmountForDisbursementAfterTax: description: LC Amount for Disbursement after Tax maxLength: 64 minLength: 1 type: string lcAmountForDisbursementCalculations: description: LC Amount for Disbursement Calculations maxLength: 64 minLength: 1 type: string lcBaseAmountForTaxCalculations: description: LC Base Amount for Tax Calculations maxLength: 64 minLength: 1 type: string lcPartnerPayment: description: LC Partner Payment maxLength: 64 minLength: 1 type: string listingId: description: Listing ID maxLength: 255 minLength: 1 type: string listingName: description: Listing Name maxLength: 255 minLength: 1 type: string partnerId: description: Partner OCID maxLength: 255 minLength: 1 type: string partnerName: description: Partner Name maxLength: 255 minLength: 1 type: string privateOfferId: description: Private Offer ID maxLength: 255 minLength: 0 type: string privateOfferName: description: Private Offer Name maxLength: 255 minLength: 0 type: string sku: description: SKU maxLength: 255 minLength: 1 type: string state: description: State maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object transactionReferenceId: description: Transaction Reference ID maxLength: 255 minLength: 1 type: string transferTaxAmount: description: Transfer Tax Amount maxLength: 64 minLength: 1 type: string transferTaxBaseAmount: description: Transfer Tax Base Amount maxLength: 64 minLength: 1 type: string transferTaxRate: description: Transfer Tax Rate maxLength: 64 minLength: 1 type: string usageQuantity: description: Usage Quantity maxLength: 64 minLength: 1 type: string usedAmountLc: description: Used Amount (LC) maxLength: 64 minLength: 1 type: string withholdingTaxAmount: description: Withholding Tax Amount maxLength: 64 minLength: 1 type: string withholdingTaxRate: description: Withholding Tax Rate maxLength: 64 minLength: 1 type: string zip: description: Zip maxLength: 64 minLength: 1 type: string type: object 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 AvailableServiceCollection: description: Results of available service provider search, returns available services properties: items: description: List of available service providers items: $ref: '#/components/schemas/AvailableServiceSummary' type: array required: - items type: object Category: description: The model for the category details. properties: code: description: The code of the category. maxLength: 200 minLength: 1 type: string lifecycleState: description: The current state for the category. enum: - ACTIVE - INACTIVE type: string name: description: The name for the category. maxLength: 200 minLength: 1 type: string productCode: description: The product that the category belongs to. maxLength: 200 minLength: 1 type: string timeCreated: description: 'The date and time the category was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the category was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2022-09-15T21:10:29.600Z` ' format: date-time type: string required: - name - code - productCode - lifecycleState - timeCreated - timeUpdated type: object UpdateTermVersionDetails: description: Details to update Marketplace Publisher term version. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the term version. maxLength: 200 minLength: 0 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 type: object ArtifactCollection: description: Results of the artifact search. Contains the artifact items. properties: items: description: List of artifact summary. items: $ref: '#/components/schemas/ArtifactSummary' type: array required: - items type: object UpdateListingRevisionPackageDetails: description: The model for an Oracle Cloud Infrastructure Marketplace Listing revison package. properties: areSecurityUpgradesProvided: description: Identifies whether security upgrades will be provided for this package. type: boolean artifactId: description: The unique identifier for the artifact. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 description: description: The description for this package. maxLength: 400 minLength: 0 type: string displayName: description: The name for the listing revision package. 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 isDefault: description: Identifies that this will be default package for the listing revision. type: boolean packageVersion: description: The version for the package. maxLength: 200 minLength: 0 type: string termId: description: The unique term identifier. maxLength: 255 minLength: 1 type: string type: object SupportedCurrencyCollection: description: Result set consisting of list of currencies supported by the Marketplace Publisher Service. properties: items: description: List of Supported Currencies. items: $ref: '#/components/schemas/SupportedCurrencySummary' type: array required: - items type: object ShapeOcpuOptions: description: Options for the the shape OCPU properties: max: description: Maximum OCPU configuration format: float type: number min: description: Minimum OCPU configuration format: float type: number required: - min - max type: object ArtifactSummary: description: The model for the artifact summary. properties: artifactType: description: Artifact Type for the artifact. enum: - CONTAINER_IMAGE - HELM_CHART - MACHINE_IMAGE - STACK type: string x-obmcs-top-level-enum: '#/definitions/ArtifactTypeEnum' compartmentId: description: The unique identifier for the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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 for the artifact. 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: Unique identifier for the artifact. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state for the Artifact. type: string x-obmcs-enumref: '#/definitions/Artifact/lifecycleState' status: description: The current status for the Artifact. type: string x-obmcs-enumref: '#/definitions/Artifact/status' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the artifact was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the artifact was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-03-27T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - artifactType - status - lifecycleState - timeCreated - timeUpdated type: object x-example: "{\n \"Id\": \"ocid1.artifact.123\",\n \"compartmentId\": \"ocid1.tenancy.oc1..aaaaaaaapbxhbccxcjrb4wnlyaix44kkcl2tgtj2lyrlcqcctqmmi26yehxa\",\n \"displayName\": \"OAS_MP_HELM_TEST__021222\",\n \"artifactType\": \"HELM_CHART\",\n \"lifecycleState\": \"ACTIVE\",\n \"status\":\"AVAILABLE\",\n \"timeCreated\" : \"2023-03-27T00:00:00.000Z\",\n \"timeUpdated\" : \"2023-03-27T00:00:00.000Z\"\n\n}\n" AdditionalInfo: description: Additional information about the lead properties: company: description: The company name maxLength: 255 minLength: 5 type: string companyAddress: description: The company address maxLength: 255 minLength: 5 type: string email: description: The email address maxLength: 255 minLength: 5 type: string firstName: description: The first name maxLength: 255 minLength: 1 type: string lastName: description: The last name maxLength: 255 minLength: 1 type: string notes: description: Additional notes maxLength: 255 minLength: 0 type: string phone: description: The phone number maxLength: 20 minLength: 10 type: string 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 parameters: ListingIdentifierPathParam: description: listing OCID in: path name: listingId required: true schema: type: string ListingRevisionAttachmentLifecycleStateQueryParam: description: A filter to return only attachments their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ListingRevisionAttachment/lifecycleState' schema: type: string NameQueryParam: description: A filter to return only resources that match the entire name given. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 InstanceReportDateRangeQueryParam: description: 'The date range of the report ' in: query name: dateRange required: true schema: type: string enum: - THIS_WEEK - LAST_WEEK - THIS_MONTH - LAST_MONTH - LAST_THREE_MONTHS IfMatchHeader: 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 ListingRevisionIdentifierQueryParam: description: OCID of the listing revision. in: query name: listingRevisionId required: true schema: type: string SortByQueryParameter: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated ListingRevisionStatusQueryParam: description: A filter to return only listing revisions their status matches the given listing revision status. in: query name: listingRevisionStatus required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ListingRevision/status' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC LeadIdentifierPathParam: description: Lead ID in: path name: leadId required: true schema: type: string CompartmentIdQueryParameter: description: The ID of the compartment in which to list leads. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string FilterByProductCodeQueryParam: description: product code to filter in: query name: productCode required: false x-default-description: 'null' schema: type: string TermIdHeader: description: Unique OCID identifier for the term. in: header name: term-id required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string CompartmentIdOptionalQueryParam: description: The unique identifier for the compartment. in: query name: compartmentId required: false x-default-description: 'null' schema: type: string ListingTypeQueryParam: description: A filter to return listings based on their type in: query name: listingType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ListingType' schema: type: string enum: - OCI_APPLICATION - LEAD_GENERATION - SERVICE PackageLifecycleStateQueryParam: description: A filter to return only packages their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ListingRevisionPackage/lifecycleState' schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated CategoryCodePathParam: description: Category Code in: path name: categoryCode required: true schema: type: string ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string ListingRevisionIdentifierPathParam: description: listing revision in: path name: listingRevisionId required: true schema: type: string ListingLifecycleStateQueryParam: description: A filter to return only listings their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Listing/lifecycleState' schema: type: string ArtifactLifecycleStateQueryParam: description: A filter to return only artifacts with their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Artifact/lifecycleState' schema: type: string 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 - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED ListingRevisionPackageIdentifierPathParam: description: Unique listing revision package identifier. in: path name: listingRevisionPackageId required: true x-default-description: 'null' schema: type: string SupportDocGroupQueryParam: description: SupportDoc Group in: query name: supportDocGroup required: false x-default-description: 'null' schema: type: string WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string TermIdentifierQueryParam: description: term OCID in: query name: termId required: true x-default-description: 'null' schema: type: string ListingRevisionAttachmentIdentifierPathParam: description: attachment OCID in: path name: listingRevisionAttachmentId required: true schema: type: string ListingRevisionNoteIdentifierPathParam: description: Unique listing revision note identifier. in: path name: listingRevisionNoteId required: true x-default-description: 'null' schema: type: string TermVersionIdentifierPathParam: description: term version OCID in: path name: termVersionId required: true schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page required: false x-default-description: 'null' schema: type: string minLength: 1 PublisherIdentifierPathParam: description: Publisher OCID in: path name: publisherId required: true schema: type: string SupportDocCodePathParam: description: SupportDoc Code in: path name: supportDocCode 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 WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. ' in: query name: sortBy schema: type: string enum: - timestamp default: timestamp ArtifactIdentifierPathParam: description: artifact OCID in: path name: artifactId required: true schema: type: string MarketCodePathParam: description: Market Code in: path name: marketCode required: true schema: type: string RetryTokenHeader: 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 maxLength: 64 minLength: 1 OptionalDisplayNameHeader: description: The name of the resource. in: header name: display-name required: false x-default-description: 'null' schema: type: string maxLength: 200 minLength: 1 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 ListingRevisionLifecycleStateQueryParam: description: A filter to return only listing revisions their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ListingRevision/lifecycleState' schema: type: string ListingIdQueryParam: description: Listing OCID to query resource against. in: query name: listingId required: false x-default-description: 'null' schema: type: string ProductGroupQueryParam: description: Product Group in: query name: productGroup required: false x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 ListingIdentifierQueryParam: description: listing OCID in: query name: listingId required: true x-default-description: 'null' schema: type: string ProductCodePathParam: description: Product Code in: path name: productCode required: true schema: type: string ArtifactStatusQueryParam: description: A filter to return only artifacts with specific status. in: query name: status required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Artifact/status' schema: type: string DisbursementReportDateRangeQueryParam: description: 'The date range of the report ' in: query name: dateRange required: true schema: type: string enum: - LAST_MONTH - LAST_THREE_MONTHS TermIdentifierPathParam: description: term OCID in: path name: termId required: true schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' 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 work. You can use this to query its status. ' 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 type is 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 type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.publisher