Skip to main content


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

Edit Registration Pega Process Fabric Hub endpoint

Updated on November 9, 2021

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.

You can edit application details by invoking the following endpoint:

PATCH /registrations/{ID}

Before you edit application details, consider the following factors:

  • You cannot edit applications that have a Sync-InProgress or Resolved status.
  • The Edit Registration REST API returns an entire registration instance as a response.
  • In case of errors, the response includes an appropriate status code and error message.

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

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/registrations/REG-22951
Request headersAuthorization: Bearer access token
Request body
{
  "applicationDescription": "Sales Desk application captures sales information and provides sales statistics",
  "weighting": "2"
} 
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": "20210421T173838.338 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 Enable Synchronize Registration Pega Process Fabric Hub endpoint
  • Next topic Get Registrations 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