Class ScreenSchemesService

This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes.

See

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

Hierarchy

  • CommonHttpService
    • ScreenSchemesService

Constructors

constructor

Methods

createScreenScheme deleteScreenScheme getScreenSchemes updateScreenScheme initialize

Constructors

constructor

  • new ScreenSchemesService(getClientInstance): ScreenSchemesService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns ScreenSchemesService

Methods

createScreenScheme

deleteScreenScheme

getScreenSchemes

  • getScreenSchemes(params?): Promise<PageBeanScreenScheme>

  • Returns a paginated list of screen schemes.

    Only 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 include additional information in the response. This parameter accepts issueTypeScreenSchemes that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to.

      • Optionalid?: number[]

        The list of 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:

        • id Sorts by screen scheme ID.
        • name Sorts by screen scheme name.
      • OptionalqueryString?: string

        String used to perform a case-insensitive partial match with screen scheme name.

      • OptionalstartAt?: number

        The index of the first item to return in a page of results (page offset).

    Returns Promise<PageBeanScreenScheme>

    Returned if the request is successful.

    example:

    {
      "isLast": true,
      "maxResults": 100,
      "self": "https://your-domain.atlassian.net/rest/api/3/screenscheme?maxResults=25&startAt=0",
      "startAt": 0,
      "total": 2,
      "values": [
        {
          "id": 10010,
          "name": "Employee screen scheme",
          "description": "Manage employee data",
          "screens": {
            "default": 10017,
            "edit": 10019,
            "create": 10019,
            "view": 10020
          },
          "issueTypeScreenSchemes": {
            "isLast": true,
            "maxResults": 100,
            "startAt": 0,
            "total": 1,
            "values": [
              {
                "id": "10000",
                "name": "Office issue type screen scheme",
                "description": "Managing office projects"
              }
            ]
          }
        },
        {
          "id": 10032,
          "name": "Office screen scheme",
          "description": "Manage office data",
          "screens": {
            "default": 10020
          }
        }
      ]
    }

    Path

    GET /rest/api/3/screenscheme @scopes-current manage:jira-project @scopes-beta read:screen-scheme:jira, read:issue-type-screen-scheme:jira

    See

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

updateScreenScheme

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods