Skip to main content


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

Create Registration Pega Process Fabric Hub endpoint

Updated on November 9, 2021

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.

You invoke the Create registration REST API by using the following endpoint and providing relevant input:

POST /registrations
Invoking this REST API creates an application registration entry that contains relevant details in the Pega Process Fabric Hub, and the application receives the Pending-Activation status in the Pega Process Fabric Hub. As a result, you can view the application on the Registered applications landing page in the Pega Process Fabric Hub. If needed, you can perform further edits through the API before you continue application registration process.

The following figure shows the Registered applications landing page in the Pega Process Fabric Hub that includes an application with the Pending-Activation status:

Registered applications landing page
The Registered applications landing page in the Pega Process Fabric Hub with one application in the Pending-Activation status and two active applications

The following table shows sample request body and sample response body for the Create Registration endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/registrations
Request headersAuthorization: Bearer access token
Request body
{
  "systemURL": "https://ap15.uplusteclo.com", 
  "applicationName": "SalesDesk3", 
  "applicationLabel": "uPlusTelco - Sales Desk 3", 
  "applicationDescription": "Sales Desk application captures sales information and provides sales insights", 
  "platform": "uPlusTelco", 
  "productionLevel": 2 
}
Response status201
Response body
{
  "applicationDescription": "Sales Desk application captures sales information and provides sales insights", 
  "applicationLabel": "uPlusTelco - Sales Desk 3", 
  "applicationName": "SalesDesk3", 
  "createDateTime": "20210421T164737.626 GMT", 
  "createOperator": "user1", 
  "ID": "REG-22951", 
  "platform": "uPlusTelco", 
  "productionLevel": "2", 
  "status": "Pending-Activation", 
  "systemURL": "https://ap15.uplusteclo.com", 
  "weighting": "1", 
  "actions": [ 
    { 
      "endpoint": "/registrations/REG-22951/actions/enablesync", 
      "ID": "EnableSync", 
      "method": "POST", 
      "name": "Enable synchronization" 
    }, 
    { 
      "endpoint": "/registrations/REG-22951", 
      "ID": "Delete", 
      "method": "DELETE", 
      "name": "Delete application" 
    }, 
    { 
      "endpoint": "/registrations/REG-22951", 
      "ID": "Edit", 
      "method": "PATCH", 
      "name": "Edit application details" 
    } 
  ] 
}

For more information, see the Swagger documentation.

  • Previous topic Accessing Pega Process Fabric Hub registration APIs
  • Next topic Enable Synchronize 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