After you publish existing case data, the remote application can immediately publish
any changes to the cases. When you invoke the appropriate REST APIs, you ensure that
Pega Process Fabric Hub and your remote application are always in sync. As a
result, Pega Process Fabric Hub reflects accurate data about cases from your
application.
You publish new cases to Pega Process Fabric Hub by invoking the following
endpoint:
POST /cases
You update cases in Pega Process Fabric Hub by invoking the following
endpoint:
PUT /cases/{caseID}
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 the real-time endpoints:
| Element | Value |
| Request URL | For a new
case:https://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/cases
https://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/cases/EPIC-2
|
| Request headers | Authorization: Bearer access token |
| Request body | For a new case:POST /cases
{
“ID”: “R-12010”,
“label”: “Repayment Extension”,
“status”: “New”,
“createDateTime”: “20220223T002801.893 GMT”,
“createOperator”: “0055g000004ccPCAAY”,
“updateDateTime”: “20220223T003001.893 GMT”,
"updateOperator": "0055g000004ccPCAAY",
"priority": "40",
"deadlineTime" :"20211227T120000.000 GMT",
"customerName": "uPlusTelco plc",
“actions”: [
{
“ID”: “redirect”,
“href”: “/case/R-12010”,
"title": "Redirect and Open",
"type": "Get"
}
]
}
PUT /cases/R-12010
{
“ID”: “R-12010”,
“label”: “Repayment Extension”,
“status”: “New”,
“createDateTime”: “20220223T002801.893 GMT”,
“createOperator”: “0055g000004ccPCAAY”,
“updateDateTime”: “20220223T003001.893 GMT”,
"updateOperator": "0055g000004ccPCATL",
"priority": "40",
"deadlineTime" :"20211227T120000.000 GMT",
"customerName": "uPlusTelco plc",
“actions”: [
{
“ID”: “redirect”,
“href”: “/case/R-12010”,
"title": "Redirect and Open",
"type": "Get"
}
]
}
|
| Response status | 202 |
| Response body | Not 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:
| Element | Value |
| Case URL | https://ap15.uplustelco.com/case/0065g000002fJBpAAM |
| systemURL property in the Create
Registration REST API | https://ap15.uplustelco.com |
| actions.href property in the Publish
Cases in Batch REST API | case/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"
}
]
}
|
