Jira.js - Jira Cloud API library
    Preparing search index...

    Class IssueProperties

    Index

    Constructors

    Methods

    • 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:

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<void>

    • 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:

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<T>

    • 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:

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<void>

    • 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:

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<T>

    • Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified along with up to 10,000 issues on which to set or update that list of entity properties.

      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:

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<void>

    • Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified along with up to 10,000 issues on which to set or update that list of entity properties.

      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:

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<T>