Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Deactivate Registration and Reactivate Registration Pega Process Fabric Hub endpoints

Updated on November 9, 2021

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.

For example, you can deactivate an application to review job candidates when your organization plans to stop hiring new employees. When the business circumstances change and the organization resumes the hiring process, you can reactivate the application.

Deactivate Registration REST API

You invoke the Deactivate Registration REST API by calling the following endpoint:

POST /registrations/{ID}/actions/disablesync

After you call this REST API, the Pega Process Fabric Hub stops accepting any data that the remote application publishes, and the Registered applications landing page displays the application with the Disabled - Sync Stopped status. The Pega Process Fabric Hub does not display assignments from a disabled application across worklists, work queues, and reports, and ignores the assignments from the application in the Next Best Work algorithm.

Before you call the Deactivate Registration REST API, consider the following factors:

  • If you try to synchronize data with an application that has the Disabled - Sync Stopped status by invoking data synchronization APIs, the API responds with the HTTP response code 403, which means that the access to the resource is unavailable.
  • The Deactivate Registration REST API returns an entire registration instance as a response.
  • If an error occurs, the response includes an appropriate status code and error message.

The following table shows a sample response body for the Deactivate Registration endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/registrations/REG-22951/actions/disablesync
Request headersAuthorization: Bearer access token
Request bodyNot applicable
Response status200
Response body
{
  "applicationDescription": "Sales Desk application captures sales information and provides sales statistics",
  "applicationLabel": "uPlusTelco - Sales Desk 3",
  "applicationName": "SalesDesk3",
  "clientID": "69747281128570844473",
  "createDateTime": "20210421T164737.626 GMT",
  "createOperator": "user1",
  "icon": "pi pi-app-solid app-registration-logo app-logo-s",
  "ID": "REG-22951",
  "platform": "uPlusTelco",
  "productionLevel": "2",
  "status": "Inactive",
  "syncErrors": "0",
  "systemURL": "https://ap15.uplustelco.com",
  "updateDateTime": "20210421T174436.639 GMT",
  "updateOperator": "user1",
  "weighting": "2",
  "actions": [
    {
      "endpoint": "/registrations/REG-22951",
      "ID": "Delete", 
      "method": "DELETE", 
      "name": "Delete application"
    },
    {
      "endpoint": "/registrations/REG-22951",
      "ID": "Edit",
      "method": "PATCH",
      "name": "Edit application details"
    },
    {
      "endpoint": "/registrations/REG-22951/actions/enablesync",
      "ID": "EnableSync",
      "method": "POST",
      "name": "Re-enable synchronization"
    }
  ]
}

For more information, see the Swagger documentation.

Reactivate Registration REST API

You invoke the Reactivate Registration REST API by calling the following endpoint:

POST /registrations/{ID}/actions/enablesync

After you call this REST API, the application gets the Open-ResyncProgress status, and the Pega Process Fabric Hub accepts batch requests from the application. Batch requests include data about resources, such as assignments, worklists, work queues, and operators. After the process of resynchronizing resources finishes, the application moves to the Active state.

Before you call the Reactivate Registration REST API, consider the following factors:

  • The Reactivate Registration REST API returns an entire registration instance as a response.
  • If an error occurs, the response includes an appropriate status code and error message.

The following table shows a sample response body for the Reactivate Registration endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/registrations/REG-22951/actions/enablesync
Request headersAuthorization: Bearer access token
Request bodyNot applicable
Response status200
Response body
{
  "applicationDescription": "Sales Desk application captures sales information and provides sales statistics",
  "applicationLabel": "uPlusTelco - Sales Desk 3",
  "applicationName": "SalesDesk3",
  "clientID": "69747281128570844473",
  "createDateTime": "20210421T164737.626 GMT",
  "createOperator": "user1",
  "icon": "pi pi-app-solid app-registration-logo app-logo-s",
  "ID": "REG-22951",
  "lastTaskSyncedDateTime": "",
  "platform": "uPlusTelco",
  "productionLevel": "2",
  "status": "Open-ResyncProgress",
  "syncErrors": "0",
  "systemURL": "https://ap15.uplustelco.com",
  "updateDateTime": "20210421T174541.934 GMT",
  "updateOperator": "user1",
  "weighting": "2"
}

For more information, see the Swagger documentation.

  • Previous topic Disable Registration and Enable Registration Pega Process Fabric Hub endpoints
  • Next topic Delete Registration Pega Process Fabric Hub endpoint

Related articles

Data Synchronization APIs for the Pega Process Fabric Hub

Tags

Pega Process Fabric Hub 1.0 Case Management

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us