Page History
Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
When compiling a service from the Designer to a deployable repository, a REST service is created for generated from each BPMN model. Users with authorization for the . Depending on your deployment target, you can test this service in the PAS Administration or in API Management.
Deployment as Container | Deployment to Integration Component (Bridge) |
---|---|
For services that have been deployed as container, you have access to the test UI via the PAS Administration: | For services that have been deployed to the PAS integration component (Bridge) |
, you have access to |
Via a link on the xUML service page, you can access a REST service documentation page where you can inspect the service interface:
Image Removed
In section Rest Ports, you find, maybe among others, the RESTServicethe test UI via the API Management. To test a service in API Management, you have to make sure that the service settings are set correctly before you start the deployment. The settings are different depending on whether a service has a user interface or not: |
Testing Containerized xUML Services
Image Added | When the service has been deployed successfully, use icon Open Administration Image Added in the deployment controls. This will open the details of the service within PAS Administration.
| ||
Image Added | On this page, open section Details. | ||
Image Added | Scroll down to tab Endpoints. For each endpoint, you can now use the correspondingImage Added icon in section Test. | ||
Image Added | A click on the test icon will open the Swagger UI within your PAS Administration. | ||
Image Added | Expand the REST operation to see the necessary parameters. To start testing, enter the required data and click the Execute button. Scroll down to check the test responses. |
Integration Service without UI
Image Added | If your service does not contain any forms:
| ||||||||
Image Added | When the service has been deployed successfully, use icon Open Test API Image Added in the deployment controls. | ||||||||
Image Added | The test UI opens within API Management. You can do the following here:
| ||||||||
Image Added | Expand the REST operation to see the necessary parameters. To start testing, enter the required data and click the Execute button. | ||||||||
Image Added | Scroll down to check the test responses. |
Integration Service with UI
Image Added | If your service does contain forms:
|
| |||||||||
Image Added | When the service has been deployed successfully, use icon Open Test API Image Added in the deployment controls. If your service contains more than one BPMN model, a list of all available processes opens. Select the one you want to test. | ||||||||
Image Added | The test UI opens within API Management.
Open the sidebar menu APIs and select My APIs. | ||||||||
Image Added | Use the filter to search for your API. Click its name to open it. | ||||||||
Image Added | Open tab Implementation and check the API Endpoint. The displayed URL will start with https://... | ||||||||
Image Added | Now you have to change the API Endpoint:
Example:
Now Save and Re-Publish to activate the change.
| ||||||||
Image Added | Now switch back to the Designer and click the Open Test API icon Image Addedagain. The test UI opens. Now you can do the following:
| ||||||||
Image Added |
RESTService Documentation
Image Removed | On this page, you can inspect the BPMN Process API interface. |
Image Removed | Expand the REST operation to see the necessary parameters and response.. To start testing, enter the required data and click the Execute button. |
Image Added | Scroll down to check the test responses. |
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
| ||
Rp | ||
children |
Panel | ||
---|---|---|
| ||