Accessing RESTful APIs resources

About this task

  • IBM Control Center Director Web Services automatically generates REST API documentation during API creation.
  • A swagger.json file is created that can be viewed in a Swagger document editor such as Swagger UI.
  • RESTful API documentation lists all RESTful API resources and operations that can be called on those resources.
Note: Before you begin, ensure that you restart the Control Center Director web server.

Procedure

  1. Explore Control Center Director RESTful API resources at: 
    https://<IP_Address>:<Port>/swagger-ui.html
    The login page appears.
  2. Enter connection details for the target Connect:Direct node.
    The dashboard displays a list of all RESTful API resources bundled under a relevant category. Example, category Jobs includes the following API resources such as, DELETE Job, GET Job, GET List, PUT Update Job etc.
  3. Before you access Control Center Director REST APIs, you must first authenticate yourself with Auth API.
    • Invoke /api/auth/login
    • Enter your user name and password. A bearer string is generated with a token.
    • Copy the value of bearer token and click Authorize.
    • Enter the bearer token value and click Close.
  4. Following are some APIs which are not present on the swagger User Interface, but may be useful for configuring Control Center Director.
    1. Under REST APIs for Web Properties section, invoke /api/web-property/post to set the following request parameters: