@manageiq/service-portal-api

catalog_api

CatalogApi - JavaScript client for catalog_api This is a API to fetch and order catalog items from different cloud sources This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.1.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install catalog_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CatalogApi = require('catalog_api');

var defaultClient = CatalogApi.ApiClient.instance;
// Configure API key authorization: APIKeyAuth
var APIKeyAuth = defaultClient.authentications['APIKeyAuth'];
APIKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyAuth.apiKeyPrefix['x-rh-auth-identity'] = "Token"
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CatalogApi.AdminsApi()
var portfolioId = "portfolioId_example"; // {String} The Portfolio ID
var addPortfolioItem = new CatalogApi.AddPortfolioItem(); // {AddPortfolioItem} 
api.addPortfolioItemToPortfolio(portfolioId, addPortfolioItem).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://localhost/r/insights/platform/catalog

Class	Method	HTTP request	Description
CatalogApi.AdminsApi	addPortfolioItemToPortfolio	POST /portfolios/{portfolio_id}/portfolio_items	Add Portfolio item to a portfolio
CatalogApi.AdminsApi	addToOrder	POST /orders/{order_id}/order_items	Add an Order Item to the Order in Pending State
CatalogApi.AdminsApi	createOrder	POST /orders	Create a new order
CatalogApi.AdminsApi	createPortfolio	POST /portfolios	API to add a new portfolio
CatalogApi.AdminsApi	createPortfolioItem	POST /portfolio_items	API to add a new portfolio item
CatalogApi.AdminsApi	destroyPortfolio	DELETE /portfolios/{id}	Delete an existing portfolio
CatalogApi.AdminsApi	destroyPortfolioItem	DELETE /portfolio_items/{id}	Delete an existing portfolio item
CatalogApi.AdminsApi	fetchPortfolioItemsWithPortfolio	GET /portfolios/{portfolio_id}/portfolio_items	Fetch all portfolio items from a specific portfolio
CatalogApi.AdminsApi	listOrderItems	GET /orders/{order_id}/order_items	Get a list of items in a given order
CatalogApi.AdminsApi	listOrders	GET /orders	Get a list of orders
CatalogApi.AdminsApi	listPortfolioItems	GET /portfolio_items	API to list all portfolio items
CatalogApi.AdminsApi	listPortfolios	GET /portfolios	API to list portfolios
CatalogApi.AdminsApi	listProgressMessages	GET /order_items/{order_item_id}/progress_messages	Get a list of progress messages in an item
CatalogApi.AdminsApi	listProviderControlParameters	GET /portfolio_items/{portfolio_item_id}/provider_control_parameters	Fetches the provider control parameters for this portfolio item, it needs to be provided when provisioning the portfolio item.
CatalogApi.AdminsApi	listServicePlans	GET /portfolio_items/{portfolio_item_id}/service_plans	Fetches all the service plans for a specific portfolio item, this requires a connection to the topology service.
CatalogApi.AdminsApi	showOrderItem	GET /orders/{order_id}/order_items/{id}	Get an individual order item from a given order
CatalogApi.AdminsApi	showPortfolio	GET /portfolios/{id}	Fetch a specific Portfolio
CatalogApi.AdminsApi	showPortfolioItem	GET /portfolio_items/{id}	Fetch a specific Portfolio Item
CatalogApi.AdminsApi	submitOrder	POST /orders/{order_id}/submit_order	Submit the given order
CatalogApi.AdminsApi	updatePortfolio	PATCH /portfolios/{id}	Edit an existing portfolio
CatalogApi.DefaultApi	updatePortfolioItem	PATCH /portfolio_items/{id}	Edit an existing Portfolio Item
CatalogApi.UsersApi	addToOrder	POST /orders/{order_id}/order_items	Add an Order Item to the Order in Pending State
CatalogApi.UsersApi	fetchPortfolioItemsWithPortfolio	GET /portfolios/{portfolio_id}/portfolio_items	Fetch all portfolio items from a specific portfolio
CatalogApi.UsersApi	listOrderItems	GET /orders/{order_id}/order_items	Get a list of items in a given order
CatalogApi.UsersApi	listOrders	GET /orders	Get a list of orders
CatalogApi.UsersApi	listPortfolioItems	GET /portfolio_items	API to list all portfolio items
CatalogApi.UsersApi	listPortfolios	GET /portfolios	API to list portfolios
CatalogApi.UsersApi	listProgressMessages	GET /order_items/{order_item_id}/progress_messages	Get a list of progress messages in an item
CatalogApi.UsersApi	listProviderControlParameters	GET /portfolio_items/{portfolio_item_id}/provider_control_parameters	Fetches the provider control parameters for this portfolio item, it needs to be provided when provisioning the portfolio item.
CatalogApi.UsersApi	listServicePlans	GET /portfolio_items/{portfolio_item_id}/service_plans	Fetches all the service plans for a specific portfolio item, this requires a connection to the topology service.
CatalogApi.UsersApi	showOrderItem	GET /orders/{order_id}/order_items/{id}	Get an individual order item from a given order
CatalogApi.UsersApi	showPortfolio	GET /portfolios/{id}	Fetch a specific Portfolio
CatalogApi.UsersApi	showPortfolioItem	GET /portfolio_items/{id}	Fetch a specific Portfolio Item

Documentation for Models

• CatalogApi.AddPortfolioItem
• CatalogApi.CollectionLinks
• CatalogApi.CollectionMetadata
• CatalogApi.CreatePortfolioItem
• CatalogApi.Order
• CatalogApi.OrderItem
• CatalogApi.OrderItemsCollection
• CatalogApi.OrdersCollection
• CatalogApi.Organization
• CatalogApi.Portfolio
• CatalogApi.PortfolioItem
• CatalogApi.PortfolioItemsCollection
• CatalogApi.PortfoliosCollection
• CatalogApi.ProgressMessage
• CatalogApi.ProgressMessagesCollection
• CatalogApi.ProviderControlParameters
• CatalogApi.ServicePlan

Documentation for Authorization

APIKeyAuth

• Type: API key
• API key parameter name: x-rh-auth-identity
• Location: HTTP header

BasicAuth

• Type: HTTP basic authentication