Using the REST API

Edit online

As an alternative to the Business Performance Center graphical user interface, you can use the REST API to manage dashboard templates.

Before you begin

Make sure that you are granted the appropriate permissions. See Setting permissions to manage dashboard templates.

About this task

Depending on your authentication scheme, the REST API is accessible to users who were granted the Manage dashboard templates Zen permission. For more information, see Setting permissions to manage dashboard templates.

You call the REST API by using the Swagger user interface or a REST client such as Postman.

Using the Swagger user interface

Edit online

Procedure

  1. Open the Swagger user interface at this URL: <bpc_url>/api/explorer/#

    The Business Performance Center REST APIs window opens.

  2. To see the list of methods, click Show/Hide or List Operations.
  3. To see the code and documentation, click Expand Operations.

Using a REST client

Edit online

Procedure

  1. Get a Zen API Token, as instructed on the Generating API keys for authentication page of the Cloud Pak Platform UI (Zen) documentation.
  2. Generate an Authorization header with the ZenApiKey to be used in the requests, as instructed on the Authorizing HTTP requests by using the Zen API key page of the IBM Cloud Pak® for Business Automation documentation.
  3. Use a REST client, such as Postman, to pass in all requests that the Authorization header generated in step 2.