Skip to main content


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

Enable Synchronize Registration Pega Process Fabric Hub endpoint

Updated on November 9, 2021

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.

You invoke the Enable Synchronize Registration REST API by calling the following endpoint:

POST /registration/{ID}/actions/enablesync

After you invoke this REST API, the registered application receives the Sync-InProgress status, and the Pega Process Fabric Hub can accept data that the application publishes. After the synchronization finishes, the application moves to the Active status. The following figure shows the Registered applications landing page in the Pega Process Fabric Hub with three active applications:

Registered applications landing page
Registered applications landing page that includes active applications

Note: The response for the Enable Synchronize Registration REST API includes the client ID and client secret that you use to obtain an access token for data synchronization APIs. For more information, see Accessing Pega Process Fabric Hub data synchronization endpoints.

The following table shows a sample response body and a sample request body for the Enable Synchronize Registration endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1registrations/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 insights", 
  "applicationLabel": "uPlusTelco - Sales Desk 3", 
  "applicationName": "SalesDesk3", 
  "clientID": "69747281128570844473", 
  "clientSecret": "9D771C63684057968DBBFB24E8B60C28", 
  "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-SyncProgress", 
  "syncErrors": "0", 
  "systemURL": "https://ap15.uplustelco.com", 
  "updateDateTime": "20210421T165527.911 GMT", 
  "updateOperator": "user1", 
  "weighting": "1" 
}

For more information, see the Swagger documentation.

  • Previous topic Create Registration Pega Process Fabric Hub endpoint
  • Next topic Edit Registration Pega Process Fabric Hub endpoint

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

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