Function: bulkDeleteIssueProperty()

function bulkDeleteIssueProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/cloud/api/issueProperties.ts:186

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.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ currentValue?: unknown; entityIds?: number[]; propertyKey: string; }	-
parameters.currentValue?	unknown	The value of properties to perform the bulk operation on.
parameters.entityIds?	number[]	List of issues to perform the bulk delete operation on.
parameters.propertyKey?	string	The key of the property.
options?	RequestOptions	-

Returns

Promise<void>