Module issue_properties_api

Source

Enums§

BulkDeleteIssuePropertyError
struct for typed errors of method bulk_delete_issue_property
BulkSetIssuePropertyError
struct for typed errors of method bulk_set_issue_property
BulkSetIssuesPropertiesError
struct for typed errors of method bulk_set_issues_properties
DeleteIssuePropertyError
struct for typed errors of method delete_issue_property
GetIssuePropertyError
struct for typed errors of method get_issue_property
GetIssuePropertyKeysError
struct for typed errors of method get_issue_property_keys
SetIssuePropertyError
struct for typed errors of method set_issue_property

Functions§

bulk_delete_issue_property
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.
bulk_set_issue_property
Sets a property value on multiple issues. The value set can be a constant or determined by a Jira expression. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictions that apply to all Jira expressions. The issues to be updated can be specified by a filter. The filter identifies issues eligible for update using these criteria: * entityIds Only issues from this list are eligible. * currentValue Only issues with the property set to this value are eligible. * hasProperty: * If true, only issues with the property are eligible. * If false, only issues without the property are eligible. If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible. If an invalid combination of criteria is provided, an error is returned. For example, specifying a currentValue and hasProperty as false would not match any issues (because without the property the property cannot have a value). The filter is optional. Without the filter 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 all eligible issues are updated or, when errors occur, none are updated. * 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.
bulk_set_issues_properties
Sets the values of entity properties on issues. It can set up to 10 entity properties on up to 10,000 issues. The value of the request body must be a valid, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously. This operation is: * transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated. * 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 and Edit issues project permissions for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
delete_issue_property
Deletes an issue’s property. This operation can be accessed anonymously. Permissions required: * Browse projects and Edit issues project permissions for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
get_issue_property
Returns the key and value of an issue’s property. This operation can be accessed anonymously. Permissions required: * Browse projects project permission for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
get_issue_property_keys
Returns the URLs and keys of an issue’s properties. This operation can be accessed anonymously. Permissions required: Property details are only returned where the user has: * Browse projects project permission for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
set_issue_property
Sets the value of an issue’s property. Use this resource to store custom data against an issue. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions required: * Browse projects and Edit issues project permissions for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.