Skip to main content

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

Creating change requests with the Pega API

Updated on January 22, 2021

You can integrate Pega 1:1 Operations Manager with an external application, for example, Atlassian's Jira or Pega Agile Studio. In this way, you can continue to use the external application for managing and approving ideas, and then send the change requests that you create in the external application directly to Pega 1:1 Operations Manager by using the Pega API.

Change request creation

You create new change requests using the POST method.

Required parameters
  • caseTypeID - Specify the class name of the Change Request class.
  • caseTypeID - Specify the process name. The default value is pyStartCase.
  • content - Specify additional case type properties related to the case type.
Request URL
Sample request
"processID":"pyStartCase","content":{"pyLabel":"changeRequestLabel","Name":"Change request name"}}
Sample response
{"ID":"PEGAMKT-WORK-OPS OPSCR-244","nextPageID": "Confirm","pxObjClass": "Pega-API-CaseManagement-Case"
Successful response code

Change request updates

You update change requests using the GET and PUT method of the cases{ID} Pega API.

Required parameters
  • ID - Specify the ID of the change request that you want to update.
  • If-Match - Specify the ETag value. To get the ETag value, make a REST call to any method (for example, GET /cases/{ID}) with a dummy If-Match value, then check the ETag value in the response header.
  • requestBody - Specify the properties that you want to update. To check the input structure for requestBody, call the GET /cases/{ID} method.
Request URL
Sample request
If-Match:"20190808T102253.902 GMT", requestBody: "{"content":{"pyLabel":"changeRequestLabel","Name":"Change request name"}}"
Successful response code
  • Previous topic Extending the treatment sections in Pega 1:1 Operations Manager
  • Next topic Implementing case types and attributes

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us