Open topic with navigation

TIBCO® Control Plane 1.0.0

# Managing Smart Engine

This section displays all the APIs available to manage smart engine for the TIBCO BusinessWorks Container Edition Capability.

Note: For any APIs using the Namespace parameter, if you want to use a namespace different from the default data plane namespace, see Deploying App Outside Data Plane Namespace.

## API for Enabling or Disabling Smart Engine

Use the `POST /v1/dp/apps/{appId}/instances/{instanceId}/smartengine` API to enable smart engine for an application instance of a specified app Id. Use the `DELETE /v1/dp/apps/{appId}/instances/{instanceId}/smartengine` API to disable smart engine for an application instance of a specified app Id.

To enable or disable an app, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Namespace: The namespace where the application is deployed.

METHOD | Path Parameters
--- | ---
POST DELETE | Parameters: appId (required) Type: String Parameters: instanceId Type: String Parameters: namespace Type: String

## API for Viewing a list of Smart Engine Report

Use the `GET /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/reports` API to view a list of reports generated for a specific app instance.

To view a list of smart engine report for an app instance, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Namespace: The namespace where the application is deployed.

METHOD | Path Parameters
--- | ---
GET | Parameters: appId (required) Type: String Parameters: instanceId Type: String Parameters: namespace Type: String

## API for Generating Smart Engine Report

Use the `POST /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/reports` API to generate reports for app instances that have smart engine enabled.

To generate a smart engine report for an app instance, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Namespace: The namespace where the application is deployed.

- EngineData: Set the optional engineData parameter to true or false.

METHOD | Path Parameters
--- | ---
POST | Parameters: appId (required) Type: String Parameters: instanceId Type: String Parameters: namespace Type: String Parameters: engineData Type: Boolean

## API for Deleting all Smart Engine Report

Use the `DELETE /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/reports` API to delete all smart engine reports generated for an app instance of the specified app Id.

To generate a smart engine report for an app instance, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The application Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Namespace: The namespace of the data plane.

METHOD | Path Parameters
--- | ---
DELETE | Parameters: appId (required) Type: String Parameters: instanceId Type: String Parameters: namespace Type: String Parameters: engineData Type: Boolean

## API for Downloading a Smart Engine Report

Use the `GET /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/reports/{reportsId}` API to generate reports for app instances that have smart engine enabled.

To generate a smart engine report for an app instance, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The application Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Report Id: The report Id to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/reports/` method.

- Namespace: The namespace where the application is deployed.

METHOD | Path Parameters
--- | ---
DELETE | Parameters: appId (required) Type: String Parameters: instanceId (required) Type: String Parameters: reportId (required) Type: String Parameters: namespace Type: String

## API for Deleting a Smart Engine Report

Use the `DELETE /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/reports/{reportsId}` API to delete a smart engine reports generated for an app instance of the specified app Id.

To generate a smart engine report for an app instance, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The application Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Report Id: The report Id to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/reports/` method.

- Namespace: The namespace where the application is deployed.

METHOD | Path Parameters
--- | ---
DELETE | Parameters: appId (required) Type: String Parameters: instanceId (required) Type: String Parameters: reportId (required) Type: String Parameters: namespace Type: String

## API for Viewing a list of Smart Engine Triggers

Use the `GET /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/triggers` API to generate a list of smart engine triggers for an app instance of the specific app Id.

To view a list of smart engine report for an app instance, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Namespace: The namespace where the application is deployed.

METHOD | Path Parameters
--- | ---
GET | Parameters: appId (required) Type: String Parameters: instanceId Type: String Parameters: namespace Type: String

## API for Updating Smart Engine Triggers

Use the `PUT /v1/dp/apps/{appId}/instances/{instanceId}/smartengine/triggers/{triggerId}` API to update the trigger settings for an app instance of the specific app Id.

To view a list of smart engine report for an app instance, you need the following parameters:

- App Id: The application Id. This can be retrieved using the `GET /v1/dp/apps` method.

- Instance Id: The Id of the application instance to be accessed. This can be retrieved using the `GET /v1/dp/apps/{appId}/instances` method.

- Trigger Id: The trigger ID to be updated for the specified app instance.

- Namespace: The namespace where the application is deployed.

METHOD | Path Parameters
--- | ---
PUT | Parameters: appId (required) Type: String Parameters: instanceId (required) Type: String Parameters: triggerId (required) Type: String Parameters: namespace Type: String

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.