Class IssueTypeScreenSchemesService

This resource represents issue type screen schemes. Use it to:

get issue type screen schemes and a list of the projects that use them.
create issue type screen schemes.
update issue type screen schemes.
delete issue type screen schemes.
associate issue type screen schemes with projects.
append issue type to screen scheme mappings to issue type screen schemes.
remove issue type to screen scheme mappings from issue type screen schemes.
update default screen scheme of issue type screen scheme.

See

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

Hierarchy

CommonHttpService
- IssueTypeScreenSchemesService

Index

Constructors

constructor

Methods

appendMappingsForIssueTypeScreenScheme assignIssueTypeScreenSchemeToProject createIssueTypeScreenScheme deleteIssueTypeScreenScheme getIssueTypeScreenSchemeMappings getIssueTypeScreenSchemeProjectAssociations getIssueTypeScreenSchemes getProjectsForIssueTypeScreenScheme removeMappingsFromIssueTypeScreenScheme updateDefaultScreenScheme updateIssueTypeScreenScheme initialize

Constructors

constructor

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

Methods

appendMappingsForIssueTypeScreenScheme

appendMappingsForIssueTypeScreenScheme(params): Promise<void>
Appends issue type to screen scheme mappings to an issue type screen scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeScreenSchemeId: string;
  issueTypeScreenSchemeMappingDetails: IssueTypeScreenSchemeMappingDetails;
  }
  - issueTypeScreenSchemeId: string
    The ID of the issue type screen scheme.
  - issueTypeScreenSchemeMappingDetails: IssueTypeScreenSchemeMappingDetails
    Example
    { "issueTypeMappings": [ { "issueTypeId": "10000", "screenSchemeId": "10001" }, { "issueTypeId": "10001", "screenSchemeId": "10002" }, { "issueTypeId": "10002", "screenSchemeId": "10002" } ] }
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping @scopes-current manage:jira-configuration @scopes-beta write:issue-type-screen-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-mapping-put

assignIssueTypeScreenSchemeToProject

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

Issue type screen schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeScreenSchemeProjectAssociation: IssueTypeScreenSchemeProjectAssociation;
  }
  - issueTypeScreenSchemeProjectAssociation: IssueTypeScreenSchemeProjectAssociation
    Example
    { "issueTypeScreenSchemeId": "10001", "projectId": "10002" }
Returns Promise<void>
Returned if the request is successful.

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

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

createIssueTypeScreenScheme

createIssueTypeScreenScheme(params): Promise<IssueTypeScreenSchemeId>
Creates an issue type screen scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeScreenSchemeDetails: IssueTypeScreenSchemeDetails;
  }
  - issueTypeScreenSchemeDetails: IssueTypeScreenSchemeDetails
    An issue type screen scheme bean.
    Example
    { "issueTypeMappings": [ { "issueTypeId": "default", "screenSchemeId": "10001" }, { "issueTypeId": "10001", "screenSchemeId": "10002" }, { "issueTypeId": "10002", "screenSchemeId": "10002" } ], "name": "Scrum issue type screen scheme" }
Returns Promise<IssueTypeScreenSchemeId>
Returned if the request is successful.

example:
```
{
  "id": "10001"
}
```
Path
POST /rest/api/3/issuetypescreenscheme @scopes-current manage:jira-configuration @scopes-beta write:issue-type-screen-scheme:jira

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

deleteIssueTypeScreenScheme

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

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

Path
DELETE /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId} @scopes-current manage:jira-configuration @scopes-beta delete:issue-type-screen-scheme:jira

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

getIssueTypeScreenSchemeMappings

getIssueTypeScreenSchemeMappings(params?): Promise<PageBeanIssueTypeScreenSchemeItem>
Returns a paginated list of issue type screen scheme items.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      issueTypeScreenSchemeId?: number[];
      maxResults?: number;
      startAt?: number;
  } = {}
  - OptionalissueTypeScreenSchemeId?: number[]
    The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=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<PageBeanIssueTypeScreenSchemeItem>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 4,
  "values": [
    {
      "issueTypeId": "10000",
      "issueTypeScreenSchemeId": "10020",
      "screenSchemeId": "10010"
    },
    {
      "issueTypeId": "10001",
      "issueTypeScreenSchemeId": "10021",
      "screenSchemeId": "10010"
    },
    {
      "issueTypeId": "10002",
      "issueTypeScreenSchemeId": "10022",
      "screenSchemeId": "10010"
    },
    {
      "issueTypeId": "default",
      "issueTypeScreenSchemeId": "10023",
      "screenSchemeId": "10011"
    }
  ]
}
```
Path
GET /rest/api/3/issuetypescreenscheme/mapping @scopes-current manage:jira-configuration @scopes-beta read:issue-type-screen-scheme:jira

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

getIssueTypeScreenSchemeProjectAssociations

getIssueTypeScreenSchemeProjectAssociations(params): Promise<PageBeanIssueTypeScreenSchemesProjects>
Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.

Only issue type screen 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 projects, separate IDs with ampersand: projectId=10000&projectId=10001.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanIssueTypeScreenSchemesProjects>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 1,
  "values": [
    {
      "issueTypeScreenScheme": {
        "id": "1",
        "name": "Default Issue Type Screen Scheme",
        "description": "The default issue type screen scheme"
      },
      "projectIds": [
        "10000",
        "10001"
      ]
    }
  ]
}
```
Path
GET /rest/api/3/issuetypescreenscheme/project @scopes-current manage:jira-configuration @scopes-beta read:issue-type-screen-scheme:jira

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

getIssueTypeScreenSchemes

getIssueTypeScreenSchemes(params?): Promise<PageBeanIssueTypeScreenScheme>

Returns a paginated list of issue type screen schemes.

Only issue type screen 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 projects that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to.
- Optionalid?: number[]
  The list of issue type screen scheme 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 screen scheme name.
  - id Sorts by issue type screen scheme ID.
- OptionalqueryString?: string
  String used to perform a case-insensitive partial match with issue type screen scheme name.
- OptionalstartAt?: number
  The index of the first item to return in a page of results (page offset).

Returns Promise<PageBeanIssueTypeScreenScheme>

Returned if the request is successful.

example:

{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 2,
  "values": [
    {
      "id": "1",
      "name": "Default Issue Type Screen Scheme",
      "description": "The default issue type screen scheme"
    },
    {
      "id": "10000",
      "name": "Office issue type screen scheme",
      "description": "Managing office projects",
      "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
          }
        ]
      }
    }
  ]
}

Path

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

See

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

getProjectsForIssueTypeScreenScheme

getProjectsForIssueTypeScreenScheme(params): Promise<PageBeanProjectDetails>
Returns a paginated list of projects associated with an issue type screen scheme.

Only company-managed projects associated with an issue type screen scheme are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      issueTypeScreenSchemeId: number;
      maxResults?: number;
      query?: string;
      startAt?: number;
  }
  - issueTypeScreenSchemeId: number
    The ID of the issue type screen scheme.
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - Optionalquery?: string
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanProjectDetails>
Returned if the request is successful.

example:
```
{
  "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
    }
  ]
}
```
Path
GET /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project @scopes-current manage:jira-configuration @scopes-beta read:project:jira, read:avatar:jira, read:project-category:jira

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

removeMappingsFromIssueTypeScreenScheme

removeMappingsFromIssueTypeScreenScheme(params): Promise<void>
Removes issue type to screen scheme mappings from an issue type screen scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeIds: IssueTypeIds;
  issueTypeScreenSchemeId: string;
  }
  - issueTypeIds: IssueTypeIds
    Example
    { "issueTypeIds": [ "10000", "10001", "10004" ] }
  - issueTypeScreenSchemeId: string
    The ID of the issue type screen scheme.
Returns Promise<void>
Returned if the screen scheme mappings are removed from the issue type screen scheme.

Path
POST /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove @scopes-current manage:jira-configuration @scopes-beta write:issue-type-screen-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-mapping-remove-post

updateDefaultScreenScheme

updateDefaultScreenScheme(params): Promise<void>
Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeScreenSchemeId: string;
  updateDefaultScreenScheme: UpdateDefaultScreenScheme;
  }
  - issueTypeScreenSchemeId: string
    The ID of the issue type screen scheme.
  - updateDefaultScreenScheme: UpdateDefaultScreenScheme
    Example
    { "screenSchemeId": "10010" }
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default @scopes-current manage:jira-configuration @scopes-beta write:issue-type-screen-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-mapping-default-put

updateIssueTypeScreenScheme

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

Permissions required: Administer Jira global permission.
Parameters
- params: {
  issueTypeScreenSchemeId: string;
  issueTypeScreenSchemeUpdateDetails: IssueTypeScreenSchemeUpdateDetails;
  }
  - issueTypeScreenSchemeId: string
    The ID of the issue type screen scheme.
  - issueTypeScreenSchemeUpdateDetails: IssueTypeScreenSchemeUpdateDetails
    The issue type screen scheme update details.
    Example
    { "description": "Screens for scrum issue types.", "name": "Scrum scheme" }
Returns Promise<void>
Returned if the request is successful.

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

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

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class IssueTypeScreenSchemesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueTypeScreenSchemesService

Methods

appendMappingsForIssueTypeScreenScheme

Parameters

issueTypeScreenSchemeId: string

issueTypeScreenSchemeMappingDetails: IssueTypeScreenSchemeMappingDetails

Example

Returns Promise<void>

Path

See

assignIssueTypeScreenSchemeToProject

Parameters

issueTypeScreenSchemeProjectAssociation: IssueTypeScreenSchemeProjectAssociation

Example

Returns Promise<void>

Path

See

createIssueTypeScreenScheme

Parameters

issueTypeScreenSchemeDetails: IssueTypeScreenSchemeDetails

Example

Returns Promise<IssueTypeScreenSchemeId>

Path

See

deleteIssueTypeScreenScheme

Parameters

issueTypeScreenSchemeId: string

Returns Promise<void>

Path

See

getIssueTypeScreenSchemeMappings

Parameters

OptionalissueTypeScreenSchemeId?: number[]

OptionalmaxResults?: number

OptionalstartAt?: number

Returns Promise<PageBeanIssueTypeScreenSchemeItem>

Path

See

getIssueTypeScreenSchemeProjectAssociations

Parameters

OptionalmaxResults?: number

projectId: number[]

OptionalstartAt?: number

Returns Promise<PageBeanIssueTypeScreenSchemesProjects>

Path

See

getIssueTypeScreenSchemes

Parameters

Optionalexpand?: string

Optionalid?: number[]

OptionalmaxResults?: number

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

OptionalqueryString?: string

OptionalstartAt?: number

Returns Promise<PageBeanIssueTypeScreenScheme>

Path

See

getProjectsForIssueTypeScreenScheme

Parameters

issueTypeScreenSchemeId: number

OptionalmaxResults?: number

Optionalquery?: string

OptionalstartAt?: number

Returns Promise<PageBeanProjectDetails>

Path

See

removeMappingsFromIssueTypeScreenScheme

Parameters

issueTypeIds: IssueTypeIds

Example

`Optional`issueTypeScreenSchemeId?: number[]

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`maxResults?: number

`Optional`startAt?: number

`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`query?: string

`Optional`startAt?: number

`Protected` `Static`initialize