Skip to main content


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

Disable Registration and Enable Registration Pega Process Fabric Hub endpoints

Updated on November 9, 2021

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.

For example, you can disable an application when you must upgrade or maintain the remote application and you want users to refrain from picking work from the application. After you complete maintenance, you can enable the application.

Disable Registration REST API

You disable an application by invoking the following endpoint:

POST /registrations/{ID}/actions/disable

After you call this API, your remote application continues to push data to the Pega Process Fabric Hub, but the Pega Process Fabric Hub does not display the assignments from the remote application in work queues, worklists, and reports. Also, the Pega Process Fabric Hub ignores these assignments in the Next Best Work algorithm.

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

  • You can use this REST API only for applications that have the Active status.
  • The Disable 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 Disable Registration endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/registrations/REG-22951/actions/disable
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": "20210421T171959.354 GMT",
  "platform": "uPlusTelco",
  "productionLevel": "2",
  "status": "Disabled",
  "syncErrors": "5",
  "systemURL": "https://ap15.uplustelco.com",
  "updateDateTime": "20210421T174142.423 GMT",
  "updateOperator": "user1",
  "weighting": "2",
  "actions": [
    {
      "endpoint": "/registrations/REG-22951/actions/disablesync",
      "ID": "DisableSync",
      "method": "POST",
      "name": "Disable synchronization"
    },
    {
      "endpoint": "/registrations/REG-22951",
      "ID": "Edit",
      "method": "PATCH",
      "name": "Edit application details"
    },
    {
      "endpoint": "/registrations/REG-22951/actions/enable",
      "ID": "Enable",
      "method": "POST",
      "name": "Enable application"
    }
  ]
}

For more information, see the Swagger documentation.

Enable Registration REST API

You enable a disabled application by invoking the following endpoint:

POST /registrations/{ID}/actions/enable

After you enable the application, the Pega Process Fabric Hub displays the assignments from this application across worklists, work queues, and reports. The Pega Process Fabric Hub also includes the assignments in the Next Best Work algorithm.

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

  • You can enable only applications that have the Disabled status.
  • The Enable 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 Enable Registration endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/registrations/REG-22951/actions/enable
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": "20210421T171959.354 GMT",
  "platform": "uPlusTelco",
  "productionLevel": "2",
  "status": "Active",
  "syncErrors": "5",
  "systemURL": "https://ap15.uplustelco.com",
  "updateDateTime": "20210421T174306.440 GMT",
  "updateOperator": "user1",
  "weighting": "2",
  "actions": [
    {
      "endpoint": "/registrations/REG-22951/actions/disablesync",
      "ID": "DisableSync",
      "method": "POST",
      "name": "Disable synchronization"
    },
    {
      "endpoint": "/registrations/REG-22951/actions/disable",
      "ID": "Disable",
      "method": "POST",
      "name": "Disable application"
    },
    {
      "endpoint": "/registrations/REG-22951",
      "ID": "Edit",
      "method": "PATCH",
      "name": "Edit application details"
    }
  ]
}

For more information, see the Swagger documentation.

  • Previous topic Get Registration Pega Process Fabric Hub endpoint
  • Next topic Deactivate Registration and Reactivate Registration Pega Process Fabric Hub endpoints

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