...
Frontend Action:
The front end processes the response and displays the filtered results to the user.
UI Elements:
A table view to present the filtered file records.
The results section updates dynamically upon receiving the response.
...
...
Overview
A REST (Representational State Transfer) Provider is a service that offers resources and functionalities over HTTP(S) using standard REST principles. It enables clients to interact with the service through predefined APIs, facilitating the integration and communication between different systems.
In this particular use case, the process flow is shared by developing a REST provider that will eventually be integrated with the user interface.
Follow the steps below to create a REST Provider:
Click Configure > WEB SERVICES > REST Provider.
Click Create REST Provider.
In Create REST Provider window, type the name and description of the new Web Service Provider service in the Name and Description fields respectively.
...
Type API Version, for example, your API version can be 1
...
Type the resource end path URL in the Resource End Path field. The URL can be static or dynamic. Static URL example: /get/FileQueueDetails
...
Process
...
Set parameterName attribute of the context source should be restRequest
searchQuery - To enable the Advanced Search option
start_date - Advanced search criteria
end_date - Advanced search criteria
start - Pagination control in the user interface
| Info |
|---|
The above variables need to be bound in the user interface to process requests from the user. |
...
flow
...
activity
...
In this use case, you need to select GET as the method type.
...
Select the Response Schema (For example, we are opting for the schema that has been utilized in the process flow as the target schema
...
Save it.
Process flow activity:
Source Activity - The source comprises a database. It is necessary to create DbInfo and DbLayout to be invoked in the source activity
...
Context Target -The target will be ContextTarget to store data in the flow for the REST provider.
...
3. Create REST Provider End-point
Overview
A REST (Representational State Transfer) Provider is a service that offers resources and functionalities over HTTP(S) using standard REST principles. It enables clients to interact with the service through predefined APIs, facilitating the integration and communication between different systems.
In this particular use case, the process flow is shared by developing a REST provider that will eventually be integrated with the user interface.
Follow the steps below to create a REST Provider:
Click Configure > WEB SERVICES > REST Provider.
Click Create REST Provider.
In Create REST Provider window, type the name and description of the new Web Service Provider service in the Name and Description fields respectively.
...
Type API Version, for example, your API version can be 1
Type the resource end path URL in the Resource End Path field. The URL can be static or dynamic. Static URL example: /get/FileQueueDetails
Select the process flow name to trigger with the web service from the Process Flow Name field.
Set parameterName attribute of the context source should be restRequest
searchQuery - To enable the Advanced Search option
start_date - Advanced search criteria
end_date - Advanced search criteria
start - Pagination control in the user interface
| Info |
|---|
The above variables need to be bound in the user interface to process requests from the user. |
| Info |
|---|
Select the process flow name to trigger with the web service from the Process Flow Name field. |
...
Click Add Method and select GET as the method type.
...
Select the Response Schema (For example, we are opting for the schema that has been utilized in the process flow as the target schema)
...
Save it.
4. Publish the Provider (REST URL) at UI
...