Creating change requests with the DX API v1
You can integrate Pega 1:1 Operations Manager with an external application, for example, Atlassian's Jira or Adobe Workfront. Integration will enable your organization to orchestrate the action creation process through other external systems. 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 DX API v1.
For more information about DX APIs, see DX API overview.
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
- https://<host:port>/prweb/api/v1/cases
- Sample request
{"caseTypeID":"PegaMKT-Work-Ops-ChangeRequest","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
- 201
Change request updates
You update change requests using the GET and PUT method of the cases{ID} DX API v1.
- 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
- https://<host:port>/prweb/api/v1/cases
- Sample request
ID:"PEGAMKT-WORK-OPS OPSCR-244",If-Match:"20190808T102253.902 GMT",requestBody:"{"content":{"pyLabel":"changeRequestLabel","Name":"Change request name"}}"- Successful response code
- 204
Previous topic Extending the treatment sections in Pega 1:1 Operations Manager Next topic Guidelines for extending Pega 1:1 Operations Manager