Class IssueTypePropertiesService

This resource represents issue type properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type properties as well as obtain the keys of all properties on a issues type. Issue type properties are a type of entity property.

See

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

Hierarchy

CommonHttpService
- IssueTypePropertiesService

Index

Constructors

constructor

Methods

deleteIssueTypeProperty getIssueTypeProperty getIssueTypePropertyKeys setIssueTypeProperty initialize

Constructors

constructor

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

Methods

deleteIssueTypeProperty

deleteIssueTypeProperty(params): Promise<void>
Deletes the issue type property.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeId: string;
  propertyKey: string;
  }
  - issueTypeId: string
    The ID of the issue type.
  - propertyKey: string
    The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
Returns Promise<void>
Path
DELETE /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} @scopes-current manage:jira-configuration @scopes-beta delete:issue-type.property:jira

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

getIssueTypeProperty

getIssueTypeProperty(params): Promise<EntityProperty>
Returns the key and value of the issue type property.

This operation can be accessed anonymously.

Permissions required:
- Administer Jira global permission to get the details of any issue type.
- Browse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.
Parameters
- params: {
  issueTypeId: string;
  propertyKey: string;
  }
  - issueTypeId: string
    The ID of the issue type.
  - propertyKey: string
    The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
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/issuetype/{issueTypeId}/properties/{propertyKey} @scopes-current read:jira-work @scopes-beta read:issue-type.property:jira

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

getIssueTypePropertyKeys

getIssueTypePropertyKeys(params): Promise<PropertyKeys>
Returns all the issue type property keys of the issue type.

This operation can be accessed anonymously.

Permissions required:
- Administer Jira global permission to get the property keys of any issue type.
- Browse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.
Parameters
- params: {
  issueTypeId: string;
  }
  - issueTypeId: string
    The ID of the issue type.
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/issuetype/{issueTypeId}/properties @scopes-current read:jira-work @scopes-beta read:issue-type.property:jira

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

setIssueTypeProperty

setIssueTypeProperty(params): Promise<{
body: unknown;
created: boolean;
}>
Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      issueTypeId: string;
      propertyKey: string;
      requestBody: unknown;
  }
  - issueTypeId: string
    The ID of the issue type.
  - propertyKey: string
    The key of the issue type 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.
    
    Example
Returns Promise<{
body: unknown;
created: boolean;
}>
- status: 200, mediaType: application/json
  
  Returned if the issue type property is updated.
- status: 201, mediaType: application/json
  
  Returned if the issue type property is created.
Path
PUT /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} @scopes-current manage:jira-configuration @scopes-beta write:issue-type.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties#api-rest-api-3-issuetype-issuetypeid-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 IssueTypePropertiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueTypePropertiesService

Methods

deleteIssueTypeProperty

Parameters

issueTypeId: string

propertyKey: string

Returns Promise<void>

Path

See

getIssueTypeProperty

Parameters

issueTypeId: string

propertyKey: string

Returns Promise<EntityProperty>

Path

See

getIssueTypePropertyKeys

Parameters

issueTypeId: string

Returns Promise<PropertyKeys>

Path

See

setIssueTypeProperty

Parameters

issueTypeId: string

propertyKey: string

requestBody: unknown

Example

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