Skip to main content


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

Endpoint for batch publishing of cases

Updated on August 26, 2022

The Publish Cases in Batch endpoint helps you synchronize data between your remote application and Pega Process Fabric Hub in bulk. The cases data publication is done from remote application, and Pega Process Fabric Hub only accepts cases data.

You publish cases in batch by invoking the following endpoint:

POST /cases/batch

Each batch request can contain up to 50 request items.

The batch endpoint is optional. Once the data synchronization of all the resource types (which is tasks, work queues, and operator mappings), is complete, the registration automatically moves to the active state and the application that you register is ready for use in Pega Process Fabric.

The following table shows a sample request body for the batch endpoint for cases:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/cases/batch
Request headersAuthorization: Bearer access token
Request body
{  
  "requests": [  
    {  
      "body": {  
        "ID": "EPIC-1",  
        "createDateTime": "20210226T061741.441 GMT",  
        "createOperator": "0055g000004ccPCAAY",  
        "label": "Credit Loan",  
        "status": "New",  
        "updateDateTime": "20210226T061741.441 GMT",  
        "updateOperator": "0055g000004ccPCAAY",  
        "customerName": "uPlusTelco plc",  
        "priority": "30",  
        "deadlineTime": "20211227T120000.000 GMT", 
        "actions": [  
          {  
            "href": "case/EPIC-1",  
            "ID": "redirect",  
            "title": "Redirect and Open",  
            "type": "Get"  
          }  
        ]  
      },  
      "method": "POST"  
        },  
        {  
      "body": {  
        "ID": "EPIC-2",  
        "createDateTime": "20210226T061741.441 GMT",  
        "createOperator": "0055g000004ccPCAAY",  
        "label": "Submit Loan",  
        "status": "OPEN-IN-PROGRESS",  
        "updateDateTime": "20210226T061741.441 GMT",  
        "updateOperator": "0055g000004ccPCAAY ",  
        "customerName": "uPlus Hotels & Resorts Ltd",  
        "priority": "60",  
        "deadlineTime" : "20211227T120000.000 GMT", 
        "actions": [  
          {  
            "href": "case/EPIC-2",  
            "ID": "redirect",  
            "title": "Redirect and Open",  
            "type": "Get"  
          }  
        ]  
      },  
      "method": "POST"  
     }  
   ]  
}
Response status202
Response bodyNot applicable

After you publish all the existing open cases, invoke the batch endpoint with the preactivationDataLast query string parameter set to true with no request body. Invoking this request informs Pega Process Fabric Hub that cases synchronization is complete. For example, the following table shows information about the endpoint that you invoke to inform Pega Process Fabric Hub that the application has published all the case data:

ElementValue
Request MethodPOST
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/cases/batch?preactivationDataLast=true
Request headersAuthorization: Bearer access token
Request bodyNot applicable
Response status202
Response bodyNot applicable

URL redirects

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

The following table shows a sample request payload:

ElementValue
Case URLhttps://ap15.uplustelco.com/case/0065g000002fJBpAAM
systemURL property in the Create Registration REST APIhttps://ap15.uplustelco.com
actions.href property in the Publish Cases in Batch REST APIcase/0065g000002fJBpAAM
Sample request payload
{ 
   "requests": [ 
    { 
    "body": { 
     "ID": "0065g000002fJBpAAM", 
     "createDateTime": "20210226T061741.441 GMT", 
     "createOperator": "0055g000004ccPCAAY", 
     "label": "Credit Loan", 
     "status": "New", 
     "updateDateTime": "20210226T061741.441 GMT", 
     "updateOperator": "0055g000004ccPCAAY", 
     "customerName": "uPlusTelco plc", 
     "priority": "30", 
     "deadlineTime": "20211227T120000.000 GMT", 
     "actions": [ 
      { 
       "href":"case/0065g000002fJBpAAM", 
       "ID": "redirect", 
       "title": "Redirect and Open", 
       "type": "Get" 
      } 
   ] 
   }, 
   "method": "POST" 
    }, 
   { 
   "body": { 
    "ID": "EPIC-2", 
    "createDateTime": "20210226T061741.441 GMT", 
    "createOperator": "0055g000004ccPCAAY", 
    "label": "Submit Loan", 
    "status": "OPEN-IN-PROGRESS", 
    "updateDateTime": "20210226T061741.441 GMT", 
    "updateOperator": "0055g000004ccPCAAY ", 
    "customerName": "uPlus Hotels & Resorts Ltd", 
    "priority": "60", 
    "deadlineTime": " 20211227T120000.000 GMT", 
    "actions": [ 
     { 
      "href": "case/EPIC-1234", 
      "ID": "redirect", 
      "title": "Redirect and Open", 
      "type": "Get" 
     } 
    ] 
   }, 
   "method": "POST" 
  } 
 ] 
}

For more information, see the Swagger documentation and Accessing and testing Pega DX API Version 1.

Related articles

Registration APIs for Pega Process Fabric Hub

Tags

Pega Process Fabric Hub 2.1 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