{ "opencollection": "1.0.0", "info": { "name": "Service Catalog API", "version": "20210527" }, "items": [ { "info": { "name": "serviceCatalog", "type": "folder" }, "items": [ { "info": { "name": "Lists the applications in a catalog or a tenancy.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/applications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "serviceCatalogId", "value": "", "type": "query", "description": "The unique identifier for the service catalog." }, { "name": "entityType", "value": "", "type": "query", "description": "The type of the application in the service catalog." }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "displayName", "value": "", "type": "query", "description": "Exact match name filter." }, { "name": "entityId", "value": "", "type": "query", "description": "The unique identifier of the entity associated with service catalog." }, { "name": "publisherId", "value": "", "type": "query", "description": "Limit results to just this publisher." }, { "name": "packageType", "value": "", "type": "query", "description": "Name of the package type. If multiple package types are provided, then any resource with\none or more matching package types will be returned.\n" }, { "name": "pricing", "value": "", "type": "query", "description": "Name of the pricing type. If multiple pricing types are provided, then any resource with\none or more matching pricing models will be returned.\n" }, { "name": "isFeatured", "value": "", "type": "query", "description": "Indicates whether to show only featured resources. If this is set to `false` or is omitted, then all resources will be returned.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." } ] }, "docs": "Lists all the applications in a service catalog or a tenancy.\nIf no parameter is specified, all catalogs from all compartments in\nthe tenancy will be scanned for any type of content.\n" }, { "info": { "name": "Lists the packages in a private application.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/privateApplicationPackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateApplicationId", "value": "", "type": "query", "description": "The unique identifier for the private application." }, { "name": "privateApplicationPackageId", "value": "", "type": "query", "description": "The unique identifier for the private application package." }, { "name": "packageType", "value": "", "type": "query", "description": "Name of the package type. If multiple package types are provided, then any resource with\none or more matching package types will be returned.\n" }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to use to sort listed results. You can only specify one field to sort by.\n`TIMECREATED` displays results in descending order by default. You can change your\npreference by specifying a different sort order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." }, { "name": "displayName", "value": "", "type": "query", "description": "Exact match name filter." } ] }, "docs": "Lists the packages in the specified private application." }, { "info": { "name": "Gets the details of a specified private application package.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/privateApplicationPackages/:privateApplicationPackageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateApplicationPackageId", "value": "", "type": "path", "description": "The unique identifier for the private application package." } ] }, "docs": "Gets the details of a specific package within a given private application." }, { "info": { "name": "Downloads the configuration of a private application package.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/privateApplicationPackages/:privateApplicationPackageId/actions/downloadConfig", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateApplicationPackageId", "value": "", "type": "path", "description": "The unique identifier for the private application package." } ] }, "docs": "Downloads the configuration that was used to create the private application package." }, { "info": { "name": "List all private applications.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/privateApplications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "privateApplicationId", "value": "", "type": "query", "description": "The unique identifier for the private application." }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to use to sort listed results. You can only specify one field to sort by.\nDefault is `TIMECREATED`.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." }, { "name": "displayName", "value": "", "type": "query", "description": "Exact match name filter." } ] }, "docs": "Lists all the private applications in a given compartment." }, { "info": { "name": "Creates a private application.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:24000/20210527/privateApplications", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a private application along with a single package to be hosted." }, { "info": { "name": "Gets a private application.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/privateApplications/:privateApplicationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateApplicationId", "value": "", "type": "path", "description": "The unique identifier for the private application." } ] }, "docs": "Gets the details of the specified private application." }, { "info": { "name": "Updates an existing private application.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:24000/20210527/privateApplications/:privateApplicationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "privateApplicationId", "value": "", "type": "path", "description": "The unique identifier for the private application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of an existing private application." }, { "info": { "name": "Deletes a private application.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:24000/20210527/privateApplications/:privateApplicationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateApplicationId", "value": "", "type": "path", "description": "The unique identifier for the private application." } ] }, "docs": "Deletes an existing private application." }, { "info": { "name": "Changes the compartment of the private application.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:24000/20210527/privateApplications/:privateApplicationId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "privateApplicationId", "value": "", "type": "path", "description": "The unique identifier for the private application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified private application from one compartment to another." }, { "info": { "name": "Downloads the logo image of the private application.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/privateApplications/:privateApplicationId/actions/downloadLogo", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateApplicationId", "value": "", "type": "path", "description": "The unique identifier for the private application." } ] }, "docs": "Downloads the binary payload of the logo image of the private application." }, { "info": { "name": "Lists resource associations.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/serviceCatalogAssociations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceCatalogAssociationId", "value": "", "type": "query", "description": "The unique identifier for the service catalog association." }, { "name": "serviceCatalogId", "value": "", "type": "query", "description": "The unique identifier for the service catalog." }, { "name": "entityId", "value": "", "type": "query", "description": "The unique identifier of the entity associated with service catalog." }, { "name": "entityType", "value": "", "type": "query", "description": "The type of the application in the service catalog." }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "Default is `TIMECREATED`" } ] }, "docs": "Lists all the resource associations for a specific service catalog." }, { "info": { "name": "Creates a service catalog association.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:24000/20210527/serviceCatalogAssociations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an association between service catalog and a resource." }, { "info": { "name": "Gets the details of a service catalog association.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/serviceCatalogAssociations/:serviceCatalogAssociationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceCatalogAssociationId", "value": "", "type": "path", "description": "The unique identifier of the service catalog association." } ] }, "docs": "Gets detailed information about specific service catalog association." }, { "info": { "name": "Removes an association between service catalog and a resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:24000/20210527/serviceCatalogAssociations/:serviceCatalogAssociationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceCatalogAssociationId", "value": "", "type": "path", "description": "The unique identifier of the service catalog association." } ] }, "docs": "Removes an association between service catalog and a resource." }, { "info": { "name": "Retrieves all the service catalogs in the given compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/serviceCatalogs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "name": "serviceCatalogId", "value": "", "type": "query", "description": "The unique identifier for the service catalog." }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "sortBy", "value": "", "type": "query", "description": "Default is `TIMECREATED`" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." }, { "name": "displayName", "value": "", "type": "query", "description": "Exact match name filter." } ] }, "docs": "Lists all the service catalogs in the given compartment." }, { "info": { "name": "Creates a service catalog in the compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:24000/20210527/serviceCatalogs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a brand new service catalog in a given compartment." }, { "info": { "name": "Get the details of the service catalog.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/serviceCatalogs/:serviceCatalogId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceCatalogId", "value": "", "type": "path", "description": "The unique identifier for the service catalog." } ] }, "docs": "Gets detailed information about the service catalog including name, compartmentId" }, { "info": { "name": "Updates the details of the service catalog.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:24000/20210527/serviceCatalogs/:serviceCatalogId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "serviceCatalogId", "value": "", "type": "path", "description": "The unique identifier for the service catalog." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of a previously created service catalog." }, { "info": { "name": "Deletes an existing service catalog.", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:24000/20210527/serviceCatalogs/:serviceCatalogId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceCatalogId", "value": "", "type": "path", "description": "The unique identifier for the service catalog." } ] }, "docs": "Deletes the specified service catalog from the compartment." }, { "info": { "name": "Replace associations in bulk.", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:24000/20210527/serviceCatalogs/:serviceCatalogId/actions/bulkReplaceAssociations", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceCatalogId", "value": "", "type": "path", "description": "The unique identifier for the service catalog." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace all associations of a given service catalog in one bulk transaction." }, { "info": { "name": "Changes the compartment of the service catalog.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:24000/20210527/serviceCatalogs/:serviceCatalogId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "serviceCatalogId", "value": "", "type": "path", "description": "The unique identifier for the service catalog." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified service catalog from one compartment to another." }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier for the compartment." }, { "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": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." }, { "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://localhost:24000/20210527/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/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": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:24000/20210527/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": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "limit", "value": "", "type": "query", "description": "How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n" }, { "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to apply, either `ASC` or `DESC`. Default is `ASC`." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }