Jira automation to delete forms on an Issue
Summary
This article is about using automation to delete Forms attached to a Jira Issue
Environment
Jira Service Management Cloud
Jira Automation Cloud
Cause
Currently, it is not natively possible to delete forms using Jira Automation and hence this article is created as a WorkAround for the following Feature Request
Solution
We will use Rest API Calls to Get the list of Forms attached to the Issue and then Delete them.
- API Calls to Get the form UUID: Get form index
- API Call to Delete the Form: Delete form
Use the steps below to configure a built-in automation rule to automatically
- Go to Project Settings > Automation > Create Rule
- One could either configure an Automated Trigger or have a Manual Trigger; as stated in Jira automation triggers, for the purpose of this example we will use Manual Trigger.
Select "Send Web Request " under "Add an Action"
Headers ( Optional )Authorization Basic <Base64-ApiKey> X-ExperimentalAPI opt-in BASE64 encode the string.
Linux/Unix/MacOS:
echo -n user@example.com:api_token_string | base64
- HTTP Method: GET
- Check: Delay execution of subsequent rule actions until we've received a response for this web request
- (Optional) Add Audit Log to Capture Issue Key: {{issue}}
- (Optional) Add comments to capture Form ID from the Web Response: {{webResponse.body.id}}
- If there are multiple Forms, we need to run the Delete API against each Form ID
Create another variable (e.g., {{FORM}}) with the following structure:
- Create a Branching For Each condition ; For Each {{FORM}}
Select "Send Web Request " under "Add an Action"
Web Request URL https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}
Headers ( Optional )Authorization Basic <Base64-ApiKey> X-ExperimentalAPI opt-in BASE64 encode the string.
Linux/Unix/MacOS:
echo -n user@example.com:api_token_string | base64
- HTTP Method: DELETE
- Check: Delay execution of subsequent rule actions until we've received a response for this web request
- (Optional) Add a comment to capture the HTTP Response Status: {{webResponse.status}}
To get Cloud ID :
Go to : https://admin.atlassian.com/
Click on your "site" of interest and you will get the Cloud id in the URL
Resulting URL Example: https://admin.atlassian.com/s/<Your_cloud_id>users