Class IssueTypeSchemesService

This resource represents issue type schemes in classic projects. Use it to:

get issue type schemes and a list of the projects that use them.
associate issue type schemes with projects.
add issue types to issue type schemes.
delete issue types from issue type schemes.
create, update, and delete issue type schemes.
change the order of issue types in issue type schemes.

See

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

Hierarchy

CommonHttpService
- IssueTypeSchemesService

Index

Constructors

constructor

Methods

addIssueTypesToIssueTypeScheme assignIssueTypeSchemeToProject createIssueTypeScheme deleteIssueTypeScheme getAllIssueTypeSchemes getIssueTypeSchemeForProjects getIssueTypeSchemesMapping removeIssueTypeFromIssueTypeScheme reorderIssueTypesInIssueTypeScheme updateIssueTypeScheme initialize

Constructors

constructor

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

Methods

addIssueTypesToIssueTypeScheme

addIssueTypesToIssueTypeScheme(params): Promise<void>
Adds issue types to an issue type scheme.

The added issue types are appended to the issue types list.

If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeIds: IssueTypeIds;
  issueTypeSchemeId: number;
  }
  - issueTypeIds: IssueTypeIds
    Example
  - issueTypeSchemeId: number
    The ID of the issue type scheme.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype @scopes-current manage:jira-configuration @scopes-beta write:issue-type-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-issuetypeschemeid-issuetype-put

assignIssueTypeSchemeToProject

assignIssueTypeSchemeToProject(params): Promise<void>
Assigns an issue type scheme to a project.

If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.

Issue type schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeSchemeProjectAssociation: IssueTypeSchemeProjectAssociation;
  }
  - issueTypeSchemeProjectAssociation: IssueTypeSchemeProjectAssociation
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuetypescheme/project @scopes-current manage:jira-configuration @scopes-beta write:issue-type-scheme:jira, write:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-project-put

createIssueTypeScheme

createIssueTypeScheme(params): Promise<IssueTypeSchemeId>
Creates an issue type scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeSchemeDetails: IssueTypeSchemeDetails;
  }
  - issueTypeSchemeDetails: IssueTypeSchemeDetails
    Example
Returns Promise<IssueTypeSchemeId>
Returned if the request is successful.

example:
```
{
  "issueTypeSchemeId": "10010"
}
```
Path
POST /rest/api/3/issuetypescheme @scopes-current manage:jira-configuration @scopes-beta write:issue-type-scheme:jira

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

deleteIssueTypeScheme

deleteIssueTypeScheme(params): Promise<void>
Deletes an issue type scheme.

Only issue type schemes used in classic projects can be deleted.

Any projects assigned to the scheme are reassigned to the default issue type scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeSchemeId: number;
  }
  - issueTypeSchemeId: number
    The ID of the issue type scheme.
Returns Promise<void>
Returned if the issue type scheme is deleted.

Path
DELETE /rest/api/3/issuetypescheme/{issueTypeSchemeId} @scopes-current manage:jira-configuration @scopes-beta delete:issue-type-scheme:jira, write:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-issuetypeschemeid-delete

getAllIssueTypeSchemes

getAllIssueTypeSchemes(params?): Promise<PageBeanIssueTypeScheme>

Returns a paginated list of issue type schemes.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

params: {
    expand?: string;
    id?: number[];
    maxResults?: number;
    orderBy?:
        | "id"
        | "name"
        | "-id"
        | "+id"
        | "-name"
        | "+name";
    queryString?: string;
    startAt?: number;
} = {}
- Optionalexpand?: string
  Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
  - projects For each issue type schemes, returns information about the projects the issue type scheme is assigned to.
  - issueTypes For each issue type schemes, returns information about the issueTypes the issue type scheme have.
- Optionalid?: number[]
  The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
- OptionalmaxResults?: number
  The maximum number of items to return per page.
- OptionalorderBy?:
      | "id"
      | "name"
      | "-id"
      | "+id"
      | "-name"
      | "+name"
  Order the results by a field:
  - name Sorts by issue type scheme name.
  - id Sorts by issue type scheme ID.
- OptionalqueryString?: string
  String used to perform a case-insensitive partial match with issue type scheme name.
- OptionalstartAt?: number
  The index of the first item to return in a page of results (page offset).

Returns Promise<PageBeanIssueTypeScheme>

Returned if the request is successful.

example:

{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 3,
  "values": [
    {
      "id": "10000",
      "name": "Default Issue Type Scheme",
      "description": "Default issue type scheme is the list of global issue types. All newly created issue types will automatically be added to this scheme.",
      "defaultIssueTypeId": "10003",
      "isDefault": true
    },
    {
      "id": "10001",
      "name": "SUP: Kanban Issue Type Scheme",
      "description": "A collection of issue types suited to use in a kanban style project.",
      "projects": {
        "isLast": true,
        "maxResults": 100,
        "startAt": 0,
        "total": 1,
        "values": [
          {
            "avatarUrls": {
              "16x16": "secure/projectavatar?size=xsmall&pid=10000",
              "24x24": "secure/projectavatar?size=small&pid=10000",
              "32x32": "secure/projectavatar?size=medium&pid=10000",
              "48x48": "secure/projectavatar?size=large&pid=10000"
            },
            "id": "10000",
            "key": "EX",
            "name": "Example",
            "projectCategory": {
              "description": "Project category description",
              "id": "10000",
              "name": "A project category"
            },
            "projectTypeKey": "ProjectTypeKey{key='software'}",
            "self": "project/EX",
            "simplified": false
          }
        ]
      }
    },
    {
      "id": "10002",
      "name": "HR: Scrum issue type scheme",
      "description": "",
      "defaultIssueTypeId": "10004",
      "issueTypes": {
        "isLast": true,
        "maxResults": 100,
        "startAt": 0,
        "total": 1,
        "values": [
          {
            "description": "Improvement Issue Type",
            "hierarchyLevel": -1,
            "iconUrl": "www.example.com",
            "id": "1000L",
            "name": "Improvements",
            "subtask": true
          }
        ]
      }
    }
  ]
}

Path

GET /rest/api/3/issuetypescheme @scopes-current manage:jira-configuration @scopes-beta read:issue-type-scheme:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-get

getIssueTypeSchemeForProjects

getIssueTypeSchemeForProjects(params): Promise<PageBeanIssueTypeSchemeProjects>

Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Parameters

params: {
    maxResults?: number;
    projectId: number[];
    startAt?: number;
}
- OptionalmaxResults?: number
  The maximum number of items to return per page.
- projectId: number[]
  The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, projectId=10000&projectId=10001.
- OptionalstartAt?: number
  The index of the first item to return in a page of results (page offset).

Returns Promise<PageBeanIssueTypeSchemeProjects>

Returned if the request is successful.

example:

{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 3,
  "values": [
    {
      "issueTypeScheme": {
        "id": "10000",
        "name": "Default Issue Type Scheme",
        "description": "Default issue type scheme is the list of global issue types. All newly created issue types will automatically be added to this scheme.",
        "defaultIssueTypeId": "10003",
        "isDefault": true
      },
      "projectIds": [
        "10000",
        "10001"
      ]
    },
    {
      "issueTypeScheme": {
        "id": "10001",
        "name": "SUP: Kanban Issue Type Scheme",
        "description": "A collection of issue types suited to use in a kanban style project."
      },
      "projectIds": [
        "10002"
      ]
    },
    {
      "issueTypeScheme": {
        "id": "10002",
        "name": "HR: Scrum issue type scheme",
        "description": "",
        "defaultIssueTypeId": "10004",
        "issueTypes": {
          "isLast": true,
          "maxResults": 100,
          "startAt": 0,
          "total": 1,
          "values": [
            {
              "description": "Improvement Issue Type",
              "hierarchyLevel": -1,
              "iconUrl": "www.example.com",
              "id": "1000L",
              "name": "Improvements",
              "subtask": true
            }
          ]
        }
      },
      "projectIds": [
        "10003",
        "10004",
        "10005"
      ]
    }
  ]
}

Path

GET /rest/api/3/issuetypescheme/project @scopes-current manage:jira-configuration @scopes-beta read:issue-type-scheme:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-project-get

getIssueTypeSchemesMapping

getIssueTypeSchemesMapping(params?): Promise<PageBeanIssueTypeSchemeMapping>
Returns a paginated list of issue type scheme items.

Only issue type scheme items used in classic projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      issueTypeSchemeId?: number[];
      maxResults?: number;
      startAt?: number;
  } = {}
  - OptionalissueTypeSchemeId?: number[]
    The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, issueTypeSchemeId=10000&issueTypeSchemeId=10001.
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanIssueTypeSchemeMapping>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 4,
  "values": [
    {
      "issueTypeSchemeId": "10000",
      "issueTypeId": "10000"
    },
    {
      "issueTypeSchemeId": "10000",
      "issueTypeId": "10001"
    },
    {
      "issueTypeSchemeId": "10000",
      "issueTypeId": "10002"
    },
    {
      "issueTypeSchemeId": "10001",
      "issueTypeId": "10000"
    }
  ]
}
```
Path
GET /rest/api/3/issuetypescheme/mapping @scopes-current manage:jira-configuration @scopes-beta read:issue-type-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-mapping-get

removeIssueTypeFromIssueTypeScheme

removeIssueTypeFromIssueTypeScheme(params): Promise<void>
Removes an issue type from an issue type scheme.

This operation cannot remove:
- any issue type used by issues.
- any issue types from the default issue type scheme.
- the last standard issue type from an issue type scheme.
Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeId: number;
  issueTypeSchemeId: number;
  }
  - issueTypeId: number
    The ID of the issue type.
  - issueTypeSchemeId: number
    The ID of the issue type scheme.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId} @scopes-current manage:jira-configuration @scopes-beta write:issue-type-scheme:jira

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

reorderIssueTypesInIssueTypeScheme

reorderIssueTypesInIssueTypeScheme(params): Promise<void>
Changes the order of issue types in an issue type scheme.

The request body parameters must meet the following requirements:
- all of the issue types must belong to the issue type scheme.
- either after or position must be provided.
- the issue type in after must not be in the issue type list.
Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeSchemeId: number;
  orderOfIssueTypes: OrderOfIssueTypes;
  }
  - issueTypeSchemeId: number
    The ID of the issue type scheme.
  - orderOfIssueTypes: OrderOfIssueTypes
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move @scopes-current manage:jira-configuration @scopes-beta write:issue-type-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-issuetypeschemeid-issuetype-move-put

updateIssueTypeScheme

updateIssueTypeScheme(params): Promise<void>
Updates an issue type scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeSchemeId: number;
  issueTypeSchemeUpdateDetails: IssueTypeSchemeUpdateDetails;
  }
  - issueTypeSchemeId: number
    The ID of the issue type scheme.
  - issueTypeSchemeUpdateDetails: IssueTypeSchemeUpdateDetails
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuetypescheme/{issueTypeSchemeId} @scopes-current manage:jira-configuration @scopes-beta write:issue-type-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes#api-rest-api-3-issuetypescheme-issuetypeschemeid-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class IssueTypeSchemesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueTypeSchemesService

Methods

addIssueTypesToIssueTypeScheme

Parameters

issueTypeIds: IssueTypeIds

Example

issueTypeSchemeId: number

Returns Promise<void>

Path

See

assignIssueTypeSchemeToProject

Parameters

issueTypeSchemeProjectAssociation: IssueTypeSchemeProjectAssociation

Example

Returns Promise<void>

Path

See

createIssueTypeScheme

Parameters

issueTypeSchemeDetails: IssueTypeSchemeDetails

Example

Returns Promise<IssueTypeSchemeId>

Path

See

deleteIssueTypeScheme

Parameters

issueTypeSchemeId: number

Returns Promise<void>

Path

See

getAllIssueTypeSchemes

Parameters

Optionalexpand?: string

Optionalid?: number[]

OptionalmaxResults?: number

OptionalorderBy?: | "id" | "name" | "-id" | "+id" | "-name" | "+name"

OptionalqueryString?: string

OptionalstartAt?: number

Returns Promise<PageBeanIssueTypeScheme>

Path

See

getIssueTypeSchemeForProjects

Parameters

OptionalmaxResults?: number

projectId: number[]

OptionalstartAt?: number

Returns Promise<PageBeanIssueTypeSchemeProjects>

Path

See

getIssueTypeSchemesMapping

Parameters

OptionalissueTypeSchemeId?: number[]

OptionalmaxResults?: number

OptionalstartAt?: number

Returns Promise<PageBeanIssueTypeSchemeMapping>

Path

See

removeIssueTypeFromIssueTypeScheme

Parameters

issueTypeId: number

issueTypeSchemeId: number

Returns Promise<void>

Path

See

reorderIssueTypesInIssueTypeScheme

Parameters

issueTypeSchemeId: number

orderOfIssueTypes: OrderOfIssueTypes

Example

Returns Promise<void>

`Optional`expand?: string

`Optional`id?: number[]

`Optional`maxResults?: number

`Optional`orderBy?:
| "id"
| "name"
| "-id"
| "+id"
| "-name"
| "+name"

`Optional`queryString?: string

`Optional`startAt?: number

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`issueTypeSchemeId?: number[]

`Optional`maxResults?: number

`Optional`startAt?: number

`Protected` `Static`initialize