Body

Documenting RESTful APIs is an important part of ensuring the usability of any program. The easier it is to understand how the RESTful APIs of IBM Conductor with Spark work, the quicker it is to leverage them to achieve your goals.

IBM Spectrum Conductor with Spark can be configured and managed through RESTful APIs.

The RESTful APIs are hosted on:

• The REST web server, which hosts the RESTful APIs for resource management and package deployment.
• The ascd web server, which hosts the RESTful APIs for Spark instance group and application instance management.

Beginning in version 2.2, IBM Spectrum Conductor with Spark makes use of the OpenAPI specification for some of its RESTful APIs as a technical preview of our planned direction for official documentation in future releases. More RESTful APIs will use OpenAPI in the future. The Conductor with Spark version 2.2 RESTful API documentation can still be found in the IBM Spectrum Conductor with Spark Knowledge Center here.

To access the OpenAPI REST documentation, go to http://[ASCD_REST_SERVER]:[ASCD_REST_PORT]/ibm/api/explorer, and use the username ‘restdocs’ and the password ‘restdocs’.

OpenAPI includes the following advantages:

• Categorization of APIs with tags: Easily find the documentation for the API you are looking for. APIs can be found under one or more tags.

• Detailed and organized parameter information: Easily view information such as descriptions, metadata, and JSON object hierarchies.

• The ‘Try it out!’ button within the documentation.

There are some limitations in the current implementation of the OpenAPI REST documentation which will be addressed in future releases, including:

• HTTPS protocol support only.
• Hard coded access credentials, which can be modified in $EGO_CONFDIR/../../ascd/conf/server_ascd.xml.
• The POST/PUT/DELETE methods require authentication, which may prevent the “Try it out!” functionality for those methods.

For more information on OpenAPI, visit https://www.openapis.org.