Submitting or reopening a Form using Automation and REST API

Bruno Altenhofen

This guide is designed to assist users in utilizing the Forms API to automatically submit or reopen forms.

 

If you need to handle multiple forms, please refer to the following article:

• Automatically Update Form Fields and Handle Multiple Forms

Steps to Follow:

• Set Up an Automation Rule:
  • Create an API token for the web request process. This requires base64 encoding your credentials along with the API token. For detailed instructions, see the documentation:
    • Automation for Jira - Send Web Request using Jira REST API
  • Utilize the API to submit or reopen a form using a PUT request. Example usage includes:
    • Reopening a Form:

      The request method will be PUT:

      PUT https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/reopen

      - Your Cloud ID (not Org ID) is needed. Find it in the URL by visiting https://<instance>.atlassian.net/admin/jira-service-desk/portal-only-customers.

      Tip: The Org ID appears as /o/ before the ID (e.g., https://admin.atlassian.com/O/<org_id>), while the Cloud ID appears as /s/ (e.g., https://admin.atlassian.com/S/<cloud_id>).

      - Use smart values like {{issue.id}} or {{issue.key}} to dynamically add the issue ID or key.

      - Access the formId using smart values such as {{issue.forms.formTemplateID}}.

      {{issue.forms.formTemplateID}}

      For more information about using forms smart values, please refer to the article below:
       -  Using Forms Smart Values
      
      Watch the automation rule in action below:

      https://www.youtube.com/watch?v=6WcYc1YXtoI
    • Submitting a Form:

      The request method will also be PUT:

      PUT https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/submit

      - Follow the same steps as above. See the automation rule in action below:

      https://www.youtube.com/watch?v=SNN3mxJtGY4

Note: Ensure the "Delay execution of..." option is enabled. This ensures the rule waits for the web request to complete before proceeding, which is crucial when the outcome affects subsequent automation steps.

Bruna Silva

Amazing article!