Retrieving a list of product views using the Common REST API

You can use the Common REST API (CRA) to retrieve a list of views for a product using the views endpoint. This endpoint retrieves the views for a specific product and returns a JSON.

• • Before you begin
  • Retrieving the list of views for a product using the views endpoint
  • Example

Before you begin

• You must have the CRA installed and running. For more information, see Setting-up-the-Common-REST-API.
• Log in to the service and acquire a token. For more information, see Logging-in-to-a-service-using-the-Common-REST-API.

Retrieving the list of views for a product using the views endpoint

The views endpoint uses the GET method to retrieve a list of views for a specific product. Use a URL based on the following structure:

https://<hostName>:<portNumber>/cra/serviceGateway/services/<serviceName>/products/<productName>/views

The variables represent the following values:

• <hostName> is the name of the mainframe host where the CRA server is running.
• <portNumber> is the port number of the CRA server.
• <serviceName> is the name of the service as it appears on the list. For more information, see To retrieve a list of services.
• <productName> is the name of the product as it appears on the list. For more information, see Retrieving-a-list-of-installed-products-using-the-Common-REST-API.

Authorization

Parameters

This endpoint does not accept any query parameters.

Response body

On successful completion, the response body contains a JSON object with the following properties:

Each element in the product array contains a JSON object with the following properties

HTTP status and reason codes

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

Example

Request

The request example uses the following values:

• <hostName> = myCRAhost
• <portNumber> = 443
• <serviceName> = Mva
• <productName> = MVMVS

Response