Skip to main content


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

Publish Real Time Tasks Pega Process Fabric Hub endpoint

Updated on November 9, 2021

After publishing existing assignments data, the remote application can immediately publish any changes to the assignments. When you invoke the appropriate REST APIs, you ensure that the Pega Process Fabric Hub and your remote application are always in sync. As a result, the Pega Process Fabric Hub reflects accurate data about assignments from your application.

You publish new assignments to the Pega Process Fabric Hub by invoking the following endpoint:

POST /tasks

You update assignments in the Pega Process Fabric Hub by invoking the following endpoint:

PUT /tasks/{task_ID}

When you invoke endpoints to publish real time assignments, ensure that you set the query parameter string preactivationData to false.

Note: As a best practice, when you handle large amounts of data, use scaling mechanisms, such as queues.

The following table shows a sample request body for Publish Real Time Tasks endpoints:

ElementValue
Request URLFor a new assignment:
https://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/tasks
For an existing assignment:
https://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/tasks/0065g000003T5BXAAY
Request headersAuthorization: Bearer access token
Request body
{
  "assignTo": "user1",
  "assignToType": "WL",
  "caseCreateDateTime": "20210112T095051.333 GMT",
  "caseCreateOperator": "user1",
  "caseID": "0065g000005h4BXAAY",
  "caseLabel": "Opportunity",
  "caseTypeClass": "Opportunity",
  "createDateTime": "20210112T101328.528 GMT",
  "createOperator": "areks1",
  "customerName": "",
  "deadlineTime": "20211227T120000.000 GMT",
  "goalTime": "",
  "ID": "0065g000003T5BXAAY",
  "label": "uPlusTelco Mobile Generators",
  "priority": "10",
  "status": "New",
  "updateDateTime": "",
  "updateOperator": "",
  "actions": [
    {
      "ID": "redirect",
      "href": "/0065g000003T5BXAAY",
      "title": "Redirect",
      "type": "GET"
    }
  ]
} 
Response status202
Response bodyNot applicable

For more information, see the the Swagger documentation.

URL redirects

For assignments REST APIs, include an assignment redirect URL in the request payload. The redirect URL and the registration system URL form the absolute assignment redirect URL. When an end user clicks an assignment link in the Pega Process Fabric Hub, the browser opens the absolute redirect URL in a new tab.

The following table shows a sample request payload:

ElementValue
Assignment URLhttps://ap15.uplustelco.com/0065g000002fJBpAAM
systemURL property in the Create Registration REST APIhttps://ap15.uplustelco.com
actions.href property in the Publish Tasks in Batch REST API\/0065g000002fJBpAAM
Sample request payload
{
    "requests": [
     {
     "method": "POST",
     "body": {
      "deadlineTime": "20211227T120000.000 GMT",
      "createOperator": "0055g000004ccPCAAY",
      "caseTypeClass": "Opportunity",
      "label": "uPlusTelco Mobile Generators",
      "priority": "10.0",
      "customerName": "uPlusTelco plc",
      "createDateTime": "20210218T120000.000 GMT",
      "caseLabel": "Opportunity",
      "caseID": "0065g000005h4BXAAY",
      "assignToType": "WL",
      "ID": "0065g000005h4BXAAY",
      "actions": [
       {
        "ID": "redirect",
        "href": "/0065g000005h4BXAAY",
        "title": "Redirect",
        "type": "GET"
       }
    ],
    "assignTo": "user1",
    "status": "New"
    }
   },
   {
    "method": "POST",
    "body": {    
    "deadlineTime": "20211105T120000.000 GMT",
    "createOperator": "0055g000004ccPCAAY",   
    "caseTypeClass": "Opportunity",
    "label": "uPlus Hotels Kitchen Generator",
    "priority": "60.0",
    "customerName": "uPlus Hotels & Resorts Ltd",
    "createDateTime": "20210218T120000.000 GMT",
    "caseLabel": "Opportunity",
    "caseID": "0065g000005h4BbAAI",
    "assignToType": "WL",
    "ID": "0065g000005h4BbAAI",
    "actions": [
     {
      "ID": "redirect",
      "href": "/0065g000005h4BbAAI",
      "title": "Redirect",
      "type": "GET"
     }
    ],
    "assignTo": "user1",
    "status": "New"
   }
  }
 ]
}
  • Previous topic Publish Tasks in Batch Pega Process Fabric Hub endpoint
  • Next topic Publish Work Queues in Batch 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