Registration APIs for the Pega Process Fabric Hub
Registration REST APIs help you manage your application life cycle in the Pega Process Fabric Hub. By calling relevant endpoints, you can register your remote application with the Pega Process Fabric Hub, and then manage the application in a way that meets your unique business needs.
For example, you can stop the synchronization between your application and the Pega Process Fabric Hub when the application is out of use, and then restart synchronization when business circumstances change.Before you use REST APIs to manage your application life cycle in the Pega Process Fabric Hub, you must obtain the corresponding access token. You then can call endpoints that trigger actions that lead you to your business goals.
To learn how to get the access token and details about registration endpoints, see the following articles:
- Accessing Pega Process Fabric Hub registration APIs
Explore the Pega Process Fabric Hub APIs in order to register your third-party application in the Pega Process Fabric Hub, and as a result resolve work faster.
- Create Registration Pega Process Fabric Hub endpoint
The Create Registration REST API informs the Pega Process Fabric Hub that your application is ready for registration. Invoking this REST API is the first step that you take to register applications with the Pega Process Fabric Hub.
- Enable Synchronize Registration Pega Process Fabric Hub endpoint
The Enable Synchronize Registration REST API prepares the Pega Process Fabric Hub to accept assignment and operator data from the registered application. Invoke this REST API before you publish data from the registered application to the Pega Process Fabric Hub application.
- Edit Registration Pega Process Fabric Hub endpoint
The Edit Registration REST API helps you adjust a registered application to your unique business requirements. For example, you can change the application short description to provide more information for users of the Pega Process Fabric Hub, or change the application weighting to suggest next best work to the users.
- Get Registrations Pega Process Fabric Hub endpoint
The Get Registrations REST API helps you obtain details of applications that are registered with the Pega Process Fabric Hub. For example, you can quickly view the statuses of your registered applications to check if each application has a status that matches your business needs.
- Get Registration Pega Process Fabric Hub endpoint
The Get Registration REST API helps you to retrieve details about a specific, registered application. For example, you can check the application label, short description, and the client secret and client ID that you use to manage the application.
- Disable Registration and Enable Registration Pega Process Fabric Hub endpoints
The Disable Registration REST API helps you hide assignments from your remote application in the Pega Process Fabric Hub without stopping data synchronization between the Pega Process Fabric Hub and your remote application. When you want to include the assignments from the application in the Pega Process Fabric Hub again, you call the Enable Registration REST API.
- Deactivate Registration and Reactivate Registration Pega Process Fabric Hub endpoints
The Deactivate Registration REST API helps you stop data synchronization between your remote application and the Pega Process Fabric Hub, for example, when the application is currently out of use. When your business process requires you to resume publishing assignments from the application to the Pega Process Fabric Hub, you can call the Reactivate Registration REST API.
- Delete Registration Pega Process Fabric Hub endpoint
The Delete Registration REST API helps you efficiently manage data in the Pega Process Fabric Hub by deleting connections with applications that you no longer need for your business processes.
Previous topic Application registration life cycle for third-party applications Next topic Accessing Pega Process Fabric Hub registration APIs