Skip to main content


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

Endpoint for batch publishing of operators

Updated on August 26, 2022

Publish Operators in Batch REST API helps you provide mappings of work queues and operators in Pega Process Fabric Hub. As a result, users can access appropriate work queues to process assignments and process cases faster in your organization.

You publish operators mapping to Pega Process Fabric Hub by invoking the following endpoint:

POST /operators/batch

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

The following table includes a sample request body for the Publish Operators in Batch REST API endpoint:

ElementValue
Request URLhttps://vlenghydcnt17263-processfabrichub.lab.pega.com/prweb/api/ppf/v1/operators/batch?preactivationData=true
Request headersAuthorization: Bearer access token
Request body
{
  "requests": [
    {
      "method": "PUT",
      "body": {
        "ID": "user1",
        "workqueues": [
          {
            "ID": "SalesApprovals"
          },
          {
            "ID": "CostApprovals"
          }
        ]
      }
    },
    {
      "method": "PUT",
      "body": {
        "ID": "user2",
        "workqueues": [
          {
            "ID": "SalesApprovals"
          }
        ]
      }
    }
  ]
} 
Response status202
Response bodyNot applicable

For more information about the endpoint protocol, see the Swagger documentation.

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

The following table lists information about the endpoint that you invoke to inform Pega Process Fabric Hub that the application published operator mappings data:

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

For more information about how Pega Process Fabric Hub displays a work queue common to multiple applications, see Assignments management in Interwoven Worklist and Pega Process Fabric Hub FAQ.

After you publish assignment, work queues, and operators data to Pega Process Fabric Hub, the application in Pega Process Fabric Hub moves from the Sync-InProgess to Active state.

Resynchronizing operators mappings

To ensure that Pega Process Fabric Hub displays accurate information about operators and work queue mappings in your remote application, you can resynchronize data after you modify it in your application, such as after you assign new users to a work queue or remove a user from a work queue. To resynchronize operators mappings, you first delete operators data in Pega Process Fabric Hub by invoking the following endpoint:

DELETE /operators

You then republish operators mappings data by invoking the Publish Operators in the Batch API endpoint.

Note: As a best practice, invoke the Disable Registration REST API before you resynchronize operator mappings data. For more information, see Disable Registration and Enable Registration Pega Process Fabric Hub endpoints.

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