Skip to main content

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

Creating a case by using an API

Updated on March 29, 2022

Increase the versatility of your Pega Platform application by creating a case by calling the create case microservice from an external application. Consequently, you improve the efficiency of your business processes and save time by automating case creation.

For example, when a customer submits a ticket in a technical support application, the application creates a bug in your project management system, such as JIRA.
The Generate create case microservice code option opens a dialog box that contains the information that you can use in a Pega API call to call the create case microservice from your external application. By calling the microservice, you create a case in your application.
Tip: For more examples of API-based communication that is typical of managing a case life cycle across environments, see Calling sequences for DX API endpoints.
  1. In the navigation pane of Dev Studio, click Case types, and then click the case type that you want to open.
  2. On the Settings tab, click Integration.
  3. In the Microservice APIs section, click Generate create case microservice code.
  4. Create a case of the selected case type from your external application by using the information in the following fields:
    1. In the Request URL (HTTP POST method) field, copy the URL that you can access to create the case, and then paste the URL in the external application.
      Ensure that you invoke the URL by using the HTTP POST method.
    2. In the HTTP authentication header field, copy the header for the microservice call, and then, in the external application, enter the login credentials in the header for basic HTTP authentication.
    3. In the Request body field, copy the body for the microservice call, and then, in the external application, paste the body and replace the values for fields in the content node with values that are appropriate for the case that you want to create.
    For more information, see the documentation for your external application.
    For example: The following figure shows a sample set of values to use in your external application:
    Sample code for creating a case by using an API
    The Generate create case microservice code window with a sample request URL, HTTP authentication header, and request body.
  5. Optional: To see a list of the built-in Pega API REST services in Pega Platform, click View all Pega API.

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