Skip to main content


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

Publish Work Queues in Batch Pega Process Fabric Hub endpoint

Updated on November 9, 2021

The Publish Work Queues in Batch REST API ensures that users can process assignments from your remote application by interacting with a correlated work queue in the Pega Process Fabric Hub. Publishing work queue data in a batch saves time, and users can process work faster.

You publish data for all work queues in your remote application to the Pega Process Fabric Hub by invoking the following endpoint:

POST /workqueues/batch

Each batch request can contain up to 50 request items. When you publish data, ensure that you set the preactivationData query string parameter to true.

The following table shows a sample request body for the Publish Work Queues in Batch API endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/workqueues/batch?preactivationData=true
Request headersAuthorization: Bearer access token
Request body
{ 
  "requests": [ 
    { 
      "method": "POST", 
      "body": { 
        "ID": "SalesApprovals", 
        "label": "Sales approvals", 
        "type": "standard" 
      } 
    }, 
    { 
      "method": "POST", 
      "body": { 
        "ID": "CostApprovals", 
        "label": "Cost approvals", 
        "type": "standard" 
      } 
    } 
  ] 
} 
Response status202
Response bodyNot applicable

For more information, see the the Swagger documentation.

After you publish the work queues to the Pega Process Fabric Hub, invoke the Publish Work Queues in Batch REST API with the preactivationDataLast and preactivationData query string parameters set to true with no request body. Invoking this request informs the Pega Process Fabric Hub that the work queues synchronization is complete.

The following table shows information about the endpoint that you invoke to inform the Pega Process Fabric Hub that the application published the work queues data:

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

Resynchronizing work queues data

To ensure that the Pega Process Fabric Hub displays current information about work queues in your remote application, you resynchronize data after you create or update work queues. To resynchronize work queues, you first delete work queues data in the Pega Process Fabric Hub by invoking the following endpoint:

DELETE /workqueues

You then republish work queues data by invoking the Publish Work Queues in Batch API endpoint.

Note: As a best practice, invoke the Disable Registration REST API before you resynchronize work queues data. For more information, see Disable Registration and Enable Registration Pega Process Fabric Hub endpoints.
  • Previous topic Publish Real Time Tasks Pega Process Fabric Hub endpoint
  • Next topic Publish Operators 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