Open topic with navigation

TIBCO® Control Plane 1.0.0

# Accessing the API Documentation with Swagger UI

Use the Swagger UI to access the API Documentation for TIBCO BusinessWorks Container Edition capability where you can try out operations and see results using sample data.

Before you beginBefore you start using the API, select Authorize on Swagger UI and ensure you have generated the OAuth Access Token from the TIBCO Control Plane. For more information, see Generating Access Token.

Procedure
1. In the TIBCO Control Plane, click Data Planes from the left navigation.
2. On the Data Plane card, click Go to Data Plane.
3. From the Capabilities pane, select a TIBCO BusinessWorks Container Edition capability.
4. On the TIBCO BusinessWorks Container Edition Capabilities page, select API Docs from the top-right corner.

ResultThe TIBCO BusinessWorks™ Container Edition Capability APIs page displays on the Swagger UI.

The Swagger UI page contains the following sections:

Apps: This section displays all the APIs available to manage app builds.

Provisioned Software & Plugins: This section displays all the APIs available to manage provisioned software and plug-ins.

Smart Engine: This section displays all the APIs available to manage smart engine.

What to do nextYou can try out the APIs on the Swagger UI by selecting the Try it out option for each API.
Subtopics

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO® Control Plane

Copyright © 2023-2024. Cloud Software Group, Inc. All Rights Reserved.