DELETE /rest/api/2/issue/properties/{propertyKey}
Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.
The criteria the filter used to identify eligible issues are:
entityIds
Only issues from this list are eligible.currentValue
Only issues with the property set to this value are eligible.
If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.
If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.
This operation is:
- transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
- asynchronous. Follow the
location
link in the response to determine the status of the task and use Get task to obtain subsequent updates.
Permissions required:
- Browse projects project permission for each project containing issues.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit issues project permission for each issue.
Servers
- https://your-domain.atlassian.net
Path parameters
Name | Type | Required | Description |
---|---|---|---|
propertyKey |
String | Yes |
The key of the property. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
entityIds[] |
Array | No |
List of issues to perform the bulk delete operation on. |
currentValue |
No |
The value of properties to perform the bulk operation on. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.