Class IssuePropertiesService

This resource represents issue properties, which provides for storing custom data against an issue. Use it to get, set, and delete issue properties as well as obtain details of all properties on an issue. Operations to bulk update and delete issue properties are also provided. Issue properties are a type of entity property.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties

Hierarchy

CommonHttpService
- IssuePropertiesService

Index

Constructors

constructor

Methods

bulkDeleteIssueProperty bulkSetIssuePropertiesByIssue bulkSetIssueProperty bulkSetIssuesPropertiesList deleteIssueProperty getIssueProperty getIssuePropertyKeys setIssueProperty initialize

Constructors

constructor

new IssuePropertiesService(getClientInstance): IssuePropertiesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssuePropertiesService
Inherited from CommonHttpService.constructor

Methods

bulkDeleteIssueProperty

bulkDeleteIssueProperty(params): 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:
- 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
- params: {
  issueFilterForBulkPropertyDelete: IssueFilterForBulkPropertyDelete;
  propertyKey: string;
  }
  - issueFilterForBulkPropertyDelete: IssueFilterForBulkPropertyDelete
    Example
  - propertyKey: string
    The key of the property.
Returns Promise<void>
Path
DELETE /rest/api/3/issue/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta delete:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-properties-propertykey-delete

bulkSetIssuePropertiesByIssue

bulkSetIssuePropertiesByIssue(params): Promise<void>
Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up to 100 issues included in the request.

The value of the request body must be a valid, non-empty JSON.

This operation is:
- asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.
- non-transactional. Updating some entities may fail. Such information will available in the task result.
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.
Parameters
- params: {
  multiIssueEntityProperties: MultiIssueEntityProperties;
  }
  - multiIssueEntityProperties: MultiIssueEntityProperties
    Details of the issue properties to be set or updated. Note that if an issue is not found, it is ignored.
    
    Example
Returns Promise<void>
Path
POST /rest/api/3/issue/properties/multi @scopes-current write:jira-work @scopes-beta write:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-properties-multi-post

bulkSetIssueProperty

bulkSetIssueProperty(params): 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:
- 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
- params: {
  bulkIssuePropertyUpdateRequest: BulkIssuePropertyUpdateRequest;
  propertyKey: string;
  }
  - bulkIssuePropertyUpdateRequest: BulkIssuePropertyUpdateRequest
    Example
  - propertyKey: string
    The key of the property. The maximum length is 255 characters.
Returns Promise<void>
Path
PUT /rest/api/3/issue/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta read:jira-expressions:jira, write:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-properties-propertykey-put

bulkSetIssuesPropertiesList

bulkSetIssuesPropertiesList(params): 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:
- 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.
Parameters
- params: {
  issueEntityProperties: IssueEntityProperties;
  }
  - issueEntityProperties: IssueEntityProperties
    Issue properties to be set or updated with values.
Returns Promise<void>
Path
POST /rest/api/3/issue/properties @scopes-current write:jira-work @scopes-beta write:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-properties-post

deleteIssueProperty

deleteIssueProperty(params): Promise<void>
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.
Parameters
- params: {
  issueIdOrKey: string;
  propertyKey: string;
  }
  - issueIdOrKey: string
    The key or ID of the issue.
  - propertyKey: string
    The key of the property.
Returns Promise<void>
Path
DELETE /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta delete:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-issueidorkey-properties-propertykey-delete

getIssueProperty

getIssueProperty(params): Promise<EntityProperty>
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.
Parameters
- params: {
  issueIdOrKey: string;
  propertyKey: string;
  }
  - issueIdOrKey: string
    The key or ID of the issue.
  - propertyKey: string
    The key of the property.
Returns Promise<EntityProperty>
Returned if the request is successful.

example:
```
{
  "key": "issue.support",
  "value": {
    "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
    "system.support.time": "1m"
  }
}
```
Path
GET /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} @scopes-current read:jira-work @scopes-beta read:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-issueidorkey-properties-propertykey-get

getIssuePropertyKeys

getIssuePropertyKeys(params): Promise<PropertyKeys>
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.
Parameters
- params: {
  issueIdOrKey: string;
  }
  - issueIdOrKey: string
    The key or ID of the issue.
Returns Promise<PropertyKeys>
Returned if the request is successful.

example:
```
{
  "keys": [
    {
      "key": "issue.support",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
    }
  ]
}
```
Path
GET /rest/api/3/issue/{issueIdOrKey}/properties @scopes-current read:jira-work @scopes-beta read:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-issueidorkey-properties-get

setIssueProperty

setIssueProperty(params): Promise<{
body: unknown;
created: boolean;
}>
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.
Parameters
- params: {
      issueIdOrKey: string;
      propertyKey: string;
      requestBody: unknown;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - propertyKey: string
    The key of the issue property. The maximum length is 255 characters.
  - requestBody: unknown
    The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes.
Returns Promise<{
body: unknown;
created: boolean;
}>
- status: 200, mediaType: application/json
  
  Returned if the issue property is updated.
- status: 201, mediaType: application/json
  
  Returned if the issue property is created.
Path
PUT /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta write:issue.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties#api-rest-api-3-issue-issueidorkey-properties-propertykey-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssuePropertiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssuePropertiesService

Methods

bulkDeleteIssueProperty

Parameters

issueFilterForBulkPropertyDelete: IssueFilterForBulkPropertyDelete

Example

propertyKey: string

Returns Promise<void>

Path

See

bulkSetIssuePropertiesByIssue

Parameters

multiIssueEntityProperties: MultiIssueEntityProperties

Example

Returns Promise<void>

Path

See

bulkSetIssueProperty

Parameters

bulkIssuePropertyUpdateRequest: BulkIssuePropertyUpdateRequest

Example

propertyKey: string

Returns Promise<void>

Path

See

bulkSetIssuesPropertiesList

Parameters

issueEntityProperties: IssueEntityProperties

Returns Promise<void>

Path

See

deleteIssueProperty

Parameters

issueIdOrKey: string

propertyKey: string

Returns Promise<void>

Path

See

getIssueProperty

Parameters

issueIdOrKey: string

propertyKey: string

Returns Promise<EntityProperty>

Path

See

getIssuePropertyKeys

Parameters

issueIdOrKey: string

Returns Promise<PropertyKeys>

Path

See

setIssueProperty

Parameters

issueIdOrKey: string

propertyKey: string

requestBody: unknown

Returns Promise<{ body: unknown; created: boolean; }>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

Returns Promise<{
body: unknown;
created: boolean;
}>

`Protected` `Static`initialize