Skip to main content

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

Optional: Displaying additional fields in Swagger

Updated on August 26, 2022

For a more efficient integration between your remote application and Pega Process Fabric Hub, add information about the additional task, operator, case, and association fields to the Swagger document. As a result, you can include custom fields in your API calls.

Before you begin: Ensure that you prepare your Pega Process Fabric Hub and your remote system for publication. For more information, see Preparing for extending your data model with additional fields. To add relevant information to the Swagger document, you edit the ppf-task-custom-request.yaml, ppf-operator-custom-request.yaml, ppf-case-custom-request.yaml, and ppf-association-custom-request.yaml files in the system that hosts your instance of Pega Process Fabric Hub.
  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Technical category, and then click Text File.
  3. In the list of text file instances, click the file that you want to edit:
    • To add additional assignment fields, click the ppf-task-custom-request file of the yaml type.
    • To add additional operator fields, click the ppf-operator-custom-request file of the yaml type.
    • To add additional case fields, click the ppf-case-custom-request file of the yaml type.
    • To add additional association fields, click the ppf-association-custom-request file of the yaml type.
  4. In the rule form header, click Save as.
  5. On the Save as text file form, in the Context section, in the Add to ruleset section, select the ruleset to store the file.
  6. Click Create and open.
  7. On the Main tab, in the text field, enter the body request that includes information about your additional assignment fields.
  8. Click Save.

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