Class RequesttypeService

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-requesttype

Hierarchy

  • CommonHttpService
    • RequesttypeService

Constructors

constructor

Methods

getAllRequestTypes initialize

Constructors

constructor

  • new RequesttypeService(getClientInstance): RequesttypeService
  • Internal

    Create a new instance of the service.

    Parameters

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

        • Returns CommonHttpClient

    Returns RequesttypeService

Methods

getAllRequestTypes

  • getAllRequestTypes(params?): Promise<PagedDtoRequestTypeDto>

  • This method returns all customer request types used in the Jira Service Management instance, optionally filtered by a query string.

    Use servicedeskapi/servicedesk/{serviceDeskId}/requesttype to find the customer request types supported by a specific service desk.

    The returned list of customer request types can be filtered using the searchQuery parameter. The parameter is matched against the customer request types' name or description. For example, searching for "Install", "Inst", "Equi", or "Equipment" will match a customer request type with the name "Equipment Installation Request".

    Note: This API by default will filter out request types hidden in the portal (i.e. request types without groups and request types where a user doesn't have permission) when searchQuery is provided, unless includeHiddenRequestTypesInSearch is set to true. Restricted request types will not be returned for those who aren't admins.

    Permissions required: Any

    Parameters

    • params: {
          expand?: string[];
          includeHiddenRequestTypesInSearch?: boolean;
          limit?: number;
          restrictionStatus?: string;
          searchQuery?: string;
          serviceDeskId?: number[];
          start?: number;
      } = {}
      • Optionalexpand?: string[]
      • OptionalincludeHiddenRequestTypesInSearch?: boolean

        Whether to include hidden request types when searching with searchQuery.

      • Optionallimit?: number

        The maximum number of items to return per page. Default: 50. See the Pagination section for more details.

      • OptionalrestrictionStatus?: string

        Request type restriction status (open or restricted) used to filter the results.

      • OptionalsearchQuery?: string

        String to be used to filter the results.

      • OptionalserviceDeskId?: number[]

        Filter the request types by service desk Ids provided. Multiple values of the query parameter are supported. For example, serviceDeskId=1&serviceDeskId=2 will return request types only for service desks 1 and 2.

      • Optionalstart?: number

        The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

    Returns Promise<PagedDtoRequestTypeDto>

    Returns the request types, on the specified page of the results.

    example:

    {
      "_expands": [],
      "size": 3,
      "start": 3,
      "limit": 3,
      "isLastPage": false,
      "_links": {
        "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
        "context": "context",
        "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=6&limit=3",
        "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=0&limit=3"
      },
      "values": [
        {
          "_expands": [],
          "id": "11001",
          "_links": {
            "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
          },
          "name": "Get IT Help",
          "description": "Get IT Help",
          "helpText": "Please tell us clearly the problem you have within 100 words.",
          "issueTypeId": "12345",
          "serviceDeskId": "28",
          "portalId": "2",
          "groupIds": [
            "12"
          ],
          "icon": {
            "id": "12345",
            "_links": {
              "iconUrls": {
                "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
                "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
                "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
                "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
              }
            }
          }
        },
        {
          "_expands": [],
          "id": "11002",
          "_links": {
            "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11002"
          },
          "name": "Request a new account",
          "description": "Request a new account",
          "issueTypeId": "12345",
          "serviceDeskId": "28",
          "portalId": "2",
          "groupIds": [
            "13",
            "14"
          ],
          "icon": {
            "id": "12346",
            "_links": {
              "iconUrls": {
                "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=large",
                "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=small",
                "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=xsmall",
                "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=medium"
              }
            }
          }
        },
        {
          "_expands": [],
          "id": "11003",
          "_links": {
            "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11003"
          },
          "name": "Hardware request",
          "description": "Request a hardware support",
          "issueTypeId": "12345",
          "serviceDeskId": "28",
          "portalId": "2",
          "groupIds": [
            "13"
          ],
          "icon": {
            "id": "12347",
            "_links": {
              "iconUrls": {
                "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=large",
                "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=small",
                "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=xsmall",
                "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=medium"
              }
            }
          }
        }
      ]
    }

    Path

    GET /rest/servicedeskapi/requesttype @scopes-current read:servicedesk-request @scopes-beta read:requesttype:jira-service-management

    See

    https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-requesttype#api-rest-servicedeskapi-requesttype-get

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