{ "opencollection": "1.0.0", "info": { "name": "MarketplacePublisherService Marketplace Publisher API", "version": "20241201" }, "items": [ { "info": { "name": "MarketplacePublisher", "type": "folder" }, "items": [ { "info": { "name": "ListArtifacts", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/artifacts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only artifacts with their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only artifacts with specific status." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Lists the artifacts in your compartment. You must specify your compartment's OCID as the value for\nthe compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "CreateArtifact", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/artifacts", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new artifact in your compartment.\nYou must specify your compartment ID in the request object.\n\nYou must also specify a *name* for the artifact(although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [Update](#/en/marketplace-publisher/20241201/artifacts/UpdateArtifact)..\n\nYou must also specify a *artifactType* for the artifact. Allowed values are CONTAINER_IMAGE and HELM_CHART\n\nYou must also provide the container or helm chart registry det" }, { "info": { "name": "GetArtifact", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/artifacts/:artifactId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "artifact OCID" } ] }, "docs": "Gets the specified artifact's information." }, { "info": { "name": "UpdateArtifact", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/artifacts/:artifactId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "artifact OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified artifact identified by the id." }, { "info": { "name": "DeleteArtifact", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/artifacts/:artifactId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "artifact OCID" } ] }, "docs": "Deletes the specified artifact." }, { "info": { "name": "ChangeArtifactCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/artifacts/:artifactId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "artifact OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified artifact to the specified compartment within the same tenancy." }, { "info": { "name": "Validate and publish artifact.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/artifacts/:artifactId/actions/validateAndPublish", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "artifact OCID" } ] }, "docs": "Validate and publish artifact." }, { "info": { "name": "List published service listing", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/availableServices", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "List all published service listing revisions\n" }, { "info": { "name": "ListCategories", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/categories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "productCode", "value": "", "type": "query", "description": "product code to filter" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "Lists the categories in your compartment. You must specify your compartment's OCID as the value for\nthe compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "GetCategory", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/categories/:categoryCode", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "categoryCode", "value": "", "type": "path", "description": "Category Code" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." } ] }, "docs": "Gets the specified category's information." }, { "info": { "name": "List customer instance report records", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/customerInstanceReportRecords", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "dateRange", "value": "", "type": "query", "description": "The date range of the report\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "List customer instance report records\n" }, { "info": { "name": "List disbursement report records", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/disbursementReportRecords", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "dateRange", "value": "", "type": "query", "description": "The date range of the report\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "List disbursement report records\n" }, { "info": { "name": "List leads of a listing", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/leads", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingId", "value": "", "type": "query", "description": "Listing OCID to query resource against." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list leads." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\n" } ] }, "docs": "Lists the leads in your compartment that belong to a listing. You must specify your listing's OCID as the value for\nthe listing ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Get the details for a specific lead", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/leads/:leadId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "leadId", "value": "", "type": "path", "description": "Lead ID" } ] }, "docs": "Gets the details for a lead.\n" }, { "info": { "name": "ListListingRevisionAttachments.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisionAttachments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "query", "description": "OCID of the listing revision." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only attachments their lifecycleState matches the given lifecycleState." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Gets the list of attachments for a listing revision in a compartment\n" }, { "info": { "name": "CreateListingRevisionAttachment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisionAttachments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new listing revision attachment.\n" }, { "info": { "name": "GetListingRevisionAttachment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisionAttachments/:listingRevisionAttachmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionAttachmentId", "value": "", "type": "path", "description": "attachment OCID" } ] }, "docs": "Get the details of the specified listing revision attachment.\n" }, { "info": { "name": "UpdateListingRevisionAttachment", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/listingRevisionAttachments/:listingRevisionAttachmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionAttachmentId", "value": "", "type": "path", "description": "attachment OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Listing Revision Attachment" }, { "info": { "name": "DeleteListingRevisionAttachment", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/listingRevisionAttachments/:listingRevisionAttachmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionAttachmentId", "value": "", "type": "path", "description": "attachment OCID" } ] }, "docs": "Deletes a listing revision attachment by the identifier" }, { "info": { "name": "Gets the binary data of listing revision attachment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisionAttachments/:listingRevisionAttachmentId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionAttachmentId", "value": "", "type": "path", "description": "attachment OCID" } ] }, "docs": "Get the attachment content by identifier.\n" }, { "info": { "name": "Update listing revision attachment content", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/listingRevisionAttachments/:listingRevisionAttachmentId/content", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionAttachmentId", "value": "", "type": "path", "description": "attachment OCID" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Update a file to listing revision attachment" }, { "info": { "name": "Gets the list of notes for a listing revision.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisionNotes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "listingRevisionId", "value": "", "type": "query", "description": "OCID of the listing revision." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Gets the list of notes for a listing revision.\n" }, { "info": { "name": "CreateListingRevisionNote", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisionNotes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Listing Revision Note.\n" }, { "info": { "name": "GetListingRevisionNote", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisionNotes/:listingRevisionNoteId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionNoteId", "value": "", "type": "path", "description": "Unique listing revision note identifier." } ] }, "docs": "Get note details by the identifier" }, { "info": { "name": "UpdateListingRevisionNote", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/listingRevisionNotes/:listingRevisionNoteId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionNoteId", "value": "", "type": "path", "description": "Unique listing revision note identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Listing Revision Note tag data" }, { "info": { "name": "DeleteListingRevisionNote", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/listingRevisionNotes/:listingRevisionNoteId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionNoteId", "value": "", "type": "path", "description": "Unique listing revision note identifier." } ] }, "docs": "Deletes a listing revision note by the identifier." }, { "info": { "name": "ListListingRevisionPackages.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisionPackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "listingRevisionId", "value": "", "type": "query", "description": "OCID of the listing revision." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only packages their lifecycleState matches the given lifecycleState." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Gets the list of packages for a listing revision.\n" }, { "info": { "name": "CreateListingRevisionPackage", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisionPackages", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Listing Revision Package.\n" }, { "info": { "name": "Get the details of a specific package version.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisionPackages/:listingRevisionPackageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionPackageId", "value": "", "type": "path", "description": "Unique listing revision package identifier." } ] }, "docs": "Get the details of the specified version of a package.\n" }, { "info": { "name": "UpdateListingRevisionPackage", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/listingRevisionPackages/:listingRevisionPackageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionPackageId", "value": "", "type": "path", "description": "Unique listing revision package identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Listing Revision Package." }, { "info": { "name": "DeleteListingRevisionPackage", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/listingRevisionPackages/:listingRevisionPackageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionPackageId", "value": "", "type": "path", "description": "Unique listing revision package identifier." } ] }, "docs": "Deletes a listing revision package by the identifier" }, { "info": { "name": "MarkListingRevisionPackageAsDefault", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisionPackages/:listingRevisionPackageId/actions/markAsDefault", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionPackageId", "value": "", "type": "path", "description": "Unique listing revision package identifier." } ] }, "docs": "Mark the Listing Revision Package identified by the id and package version as default" }, { "info": { "name": "PublishListingRevisionPackage.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisionPackages/:listingRevisionPackageId/actions/publish", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionPackageId", "value": "", "type": "path", "description": "Unique listing revision package identifier." } ] }, "docs": "Updates the Listing Revision Package to publish status" }, { "info": { "name": "UnPublishListingRevisionPackage", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisionPackages/:listingRevisionPackageId/actions/unPublish", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionPackageId", "value": "", "type": "path", "description": "Unique listing revision package identifier." } ] }, "docs": "Updates the Listing Revision Package to Unpublish status" }, { "info": { "name": "Gets the list of listing revisions for a listing.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingId", "value": "", "type": "query", "description": "listing OCID" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only listing revisions their lifecycleState matches the given lifecycleState." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "listingRevisionStatus", "value": "", "type": "query", "description": "A filter to return only listing revisions their status matches the given listing revision status." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Lists the list of listing revisions for a specific listing ID, compartment ID or listing revision status.\n\nYou can specify your compartment's OCID as the value for the compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Creates a new Listing Revision", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Listing Revision.\n" }, { "info": { "name": "GetListingRevision.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Gets the details for a listing revision.\n" }, { "info": { "name": "UpdateListingRevision", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Listing Revision" }, { "info": { "name": "DeleteListingRevision", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Deletes a listing by the identifier" }, { "info": { "name": "Cascade delete listing revision and its subresources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/actions/cascadingDelete", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Cascade delete listing revision and its subresources." }, { "info": { "name": "ChangeListingRevisionToNewStatus", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/actions/changeToNewStatus", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Updates the Listing Revision to New status" }, { "info": { "name": "CloneListingRevision.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/actions/clone", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Clone the published/withdrawn Listing Revision identified by the identifier." }, { "info": { "name": "PublishListingRevision.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/actions/publish", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Publish the Listing revision identified by Identifier." }, { "info": { "name": "PublishListingRevisionAsPrivate.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/actions/publishAsPrivate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Listing Revision to PublishAsPrivate" }, { "info": { "name": "SubmitListingRevisionForReview", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/actions/submitForReview", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Listing Revision identified by the id for review" }, { "info": { "name": "WithdrawListingRevision", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/actions/withdraw", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Update the Listing Revision identified by the id as Withdraw/UnPublished." }, { "info": { "name": "Gets the binary data of listing revision icon.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/icon/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ] }, "docs": "Gets the content for a listing revision icon.\n" }, { "info": { "name": "UpdateListingRevisionIconContent", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/listingRevisions/:listingRevisionId/icon/content", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingRevisionId", "value": "", "type": "path", "description": "listing revision" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Updates the Listing Revision" }, { "info": { "name": "ListListings", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only listings their lifecycleState matches the given lifecycleState." }, { "name": "listingType", "value": "", "type": "query", "description": "A filter to return listings based on their type" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Lists the listings in your compartment. You must specify your compartment's OCID as the value for\nthe compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "CreateListing", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listings", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new listing in your compartment.\nYou must specify your compartment ID in the request object.\n\nYou must also specify a *name* for the listing and cannot be updated later.\n\nYou must also specify a *packageType* for the listing. Allowed values are CONTAINER_IMAGE and HELM_CHART\n\nAfter you send your request, the new object's `lifecycleState` will be CREATING.\nBefore using the object, first make sure its `lifecycleState` has changed to ACTIVE.\n" }, { "info": { "name": "GetListing", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/listings/:listingId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingId", "value": "", "type": "path", "description": "listing OCID" } ] }, "docs": "Gets the details for a listing.\n" }, { "info": { "name": "UpdateListing", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/listings/:listingId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingId", "value": "", "type": "path", "description": "listing OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Listing identified by the id." }, { "info": { "name": "DeleteListing", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/listings/:listingId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "listingId", "value": "", "type": "path", "description": "listing OCID" } ] }, "docs": "Deletes a listing by the identifier" }, { "info": { "name": "CascadingDeleteListing", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listings/:listingId/actions/cascadingDelete", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "listingId", "value": "", "type": "path", "description": "listing OCID" } ] }, "docs": "Cascade delete the listing and its subresources." }, { "info": { "name": "ChangeListingCompartmentDetails", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/listings/:listingId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "listingId", "value": "", "type": "path", "description": "listing OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a listing from one compartment to another" }, { "info": { "name": "ListMarkets", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/markets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "listingId", "value": "", "type": "query", "description": "Listing OCID to query resource against." } ] }, "docs": "Lists the markets in your compartment. You must specify your compartment's OCID as the value for\nthe compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "GetMarket", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/markets/:marketCode", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "marketCode", "value": "", "type": "path", "description": "Market Code" } ] }, "docs": "Gets the specified market's information." }, { "info": { "name": "ListProducts", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/products", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "productGroup", "value": "", "type": "query", "description": "Product Group" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "Lists the products in your compartment. You must specify your compartment's OCID as the value for\nthe compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Get Product", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/products/:productCode", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "productCode", "value": "", "type": "path", "description": "Product Code" } ] }, "docs": "Gets a Product by code identifier" }, { "info": { "name": "Gets a list of all publishers", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/publishers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "Returns a list of publishers." }, { "info": { "name": "Get Publisher", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/publishers/:publisherId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "publisherId", "value": "", "type": "path", "description": "Publisher OCID" } ] }, "docs": "Gets a Publisher by identifier" }, { "info": { "name": "List support docs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/supportDocs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "supportDocGroup", "value": "", "type": "query", "description": "SupportDoc Group" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "Lists the supportDocs in your compartment. You must specify your compartment's OCID as the value for\nthe compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Get details of a specific support doc", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/supportDocs/:supportDocCode", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "supportDocCode", "value": "", "type": "path", "description": "SupportDoc Code" } ] }, "docs": "Gets a SupportDoc by code identifier" }, { "info": { "name": "Get Support Doc content", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/supportDocs/:supportDocCode/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "supportDocCode", "value": "", "type": "path", "description": "SupportDoc Code" } ] }, "docs": "Gets a Support Doc content by supportDocCode" }, { "info": { "name": "Lists the currencies supported by the Marketplace", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/supportedCurrencies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Lists the currencies supported by the Marketplace Publisher Service. You must specify your compartment's OCID as the value for\nthe compartment ID.\nFor information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "ListSupportedShapes", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/supportedShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "Lists the shapes available to select from.\n" }, { "info": { "name": "Gets a list of all the publisher term versions", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/termVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termId", "value": "", "type": "query", "description": "term OCID" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." } ] }, "docs": "Returns a list of the publisher term versions." }, { "info": { "name": "Creates a new Term Version", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/termVersions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "display-name", "value": "" }, { "name": "term-id", "value": "" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Creates a new Term Version." }, { "info": { "name": "GetTermVersion", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/termVersions/:termVersionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termVersionId", "value": "", "type": "path", "description": "term version OCID" } ] }, "docs": "Gets a Term Version by the identifier" }, { "info": { "name": "UpdateTermVersion", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/termVersions/:termVersionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termVersionId", "value": "", "type": "path", "description": "term version OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Term Version" }, { "info": { "name": "DeleteTermVersion", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/termVersions/:termVersionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termVersionId", "value": "", "type": "path", "description": "term version OCID" } ] }, "docs": "Deletes a Term by the identifier" }, { "info": { "name": "ActivateTermVersion", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/termVersions/:termVersionId/actions/Activate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termVersionId", "value": "", "type": "path", "description": "term version OCID" } ] }, "docs": "Mark the Term Version identified by the id as active" }, { "info": { "name": "Gets the binary data of term version.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/termVersions/:termVersionId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termVersionId", "value": "", "type": "path", "description": "term version OCID" } ] }, "docs": "Gets a Term Version content by the identifier." }, { "info": { "name": "UpdateTermVersionContent", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/termVersions/:termVersionId/content", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "display-name", "value": "" } ], "params": [ { "name": "termVersionId", "value": "", "type": "path", "description": "term version OCID" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Updates the Term Version attachment" }, { "info": { "name": "Gets a list of all the publisher terms", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/terms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "Returns a list of the publisher terms." }, { "info": { "name": "Creates a new Term", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/terms", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Term.\n" }, { "info": { "name": "Gets a Term by identifier", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/terms/:termId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termId", "value": "", "type": "path", "description": "term OCID" } ] }, "docs": "Gets a Term by identifier" }, { "info": { "name": "Update the Term identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20241201/terms/:termId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termId", "value": "", "type": "path", "description": "term OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Term" }, { "info": { "name": "Delete a provisioned Term", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/terms/:termId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "termId", "value": "", "type": "path", "description": "term OCID" } ] }, "docs": "Deletes a Term by the identifier" }, { "info": { "name": "ChangeTermCompartmentDetails", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20241201/terms/:termId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "termId", "value": "", "type": "path", "description": "term OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a term from one compartment to another" }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given OperationStatus." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets details of the work request with the given ID." }, { "info": { "name": "Cancel work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20241201/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Cancels the work request with the given ID." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a (paginated) list of errors for the work request with the given ID.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20241201/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a (paginated) list of logs for the work request with the given ID.\n" } ] } ], "bundled": true }