Skip to main content


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

Endpoint for batch publishing of associations

Updated on August 26, 2022

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

You publish case to operator associations in batch by invoking the following endpoint:

POST /associations/batch

Each batch request can contain up to 50 request items.

The Publish Associations in Batch REST API is optional. Once data sync 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 associations:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/associations/batch?preactivationDataLast=false
Request headersAuthorization: Bearer access token
Request body
{ 
  "requests": [ 
    { 
      "body": { 
        "fromType": "case", 
        "fromID": "EPIC-123", 
        "toID": "begua", 
        "toType": "operator", 
        "action": "create", 
        "category": "Follower",
        “createDateTime”: “20220223T002801.893 GMT”,
        “createOperator”: “0055g000004ccPCAAY”,
        "updateOperator": "0055g000004ccPCATL",
        "updateDateTime": "20210226T061742.441 GMT", 
        "ID": "EPIC-123!begua!Follower" 
      }, 
      "method": "PUT" 
    }, 
    { 
      "body": { 
        "fromType": "case", 
        "fromID": "kYC-123", 
        "toID": "begua", 
        "toType": "operator", 
        "action": "update", 
        "category": "Interested Party",
        “createDateTime”: “20220223T002801.893 GMT”,
        “createOperator”: “0055g000004ccPCAAY”,
        "updateOperator": "0055g000004ccPCATL",
        "updateDateTime": "20210226T061742.441 GMT", 
        "ID": "kYC-123!begua!Approver" 
      }, 
      "method": "PUT" 
    } 
  ] 
}
Response status202
Response bodyNot applicable

After you publish all the existing associations, invoke the Publish Associations in Batch REST API with the preactivationDataLast query string parameter set to true with no request body. Invoking this request informs Pega Process Fabric Hub that the associations sync 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 associations data:

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

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

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