• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / / REST API

Request Type

Postman Collection
OpenAPI
GET

Get request type fields

Returns the fields for a request type, for a given request type Id and service project Id. These are the fields that are required to create a customer request of that particular request type.

In addition, the following information about the current user's permissions for the request type is returned:

  • canRaiseOnBehalfOf field - Returns true, if the user has permission to raise requests on behalf of customers. Otherwise, returns false.
  • canAddRequestParticipants field - Returns true, if the user can add request participants. Otherwise, returns false.

Request

Path parameters

serviceDeskId

string

Required
requestTypeId

string

Required

Responses

Returns the requested request type fields and related fields, at the specified page of the results.

application/json

CustomerRequestCreateMetaDTO
GET/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "requestTypeFields": [ { "fieldId": "<string>", "name": "<string>", "description": "<string>", "required": true, "validValues": [ { "value": "<string>", "label": "<string>" } ], "jiraSchema": {} } ], "canRaiseOnBehalfOf": true, "canAddRequestParticipants": true }
GET

Get request type groups

Returns all request type groups from a service project, for a given service project Id. The groups will be in the same order as the order in which they appear on the customer portal

Request

Path parameters

serviceDeskId

string

Required

Query parameters

start

number

limit

number

Responses

Returns the requested request type groups, at the specified page of the results.

application/json

object
GET/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 { "_expands": [ "<string>" ], "size": 1, "start": 0, "limit": 50, "isLastPage": true, "_links": { "base": "<string>", "context": "<string>", "next": "<string>", "prev": "<string>", "self": "<string>" }, "values": [ { "id": "<string>", "name": "<string>" } ] }
GET

Get request types

Returns all request types from a service project, for a given service project Id.

Request

Path parameters

serviceDeskId

string

Required

Query parameters

groupId

string

restrictionStatus

string

start

number

limit

number

Responses

Returns the requested request types, at the specified page of the results.

application/json

object
GET/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 { "_expands": [ "<string>" ], "size": 1, "start": 0, "limit": 50, "isLastPage": true, "_links": { "base": "<string>", "context": "<string>", "next": "<string>", "prev": "<string>", "self": "<string>" }, "values": [ { "id": "<string>", "_links": { "self": "<string>" }, "name": "<string>", "description": "<string>", "helpText": "<string>", "serviceDeskId": "<string>", "groupIds": [ "<string>" ], "icon": { "id": "<string>", "_links": {} }, "restrictionStatus": "OPEN" } ] }
PUT

Update request type

Updates a request type for a given service project. Note Issue Type cannot be changed.

Permissions:

The calling user must be a project administrator for the service project project.

Request

Path parameters

serviceDeskId

string

Required

Request bodyapplication/json

The request type to update.

description

string

helpText

string

name

string

requestTypeId

integer

Responses

Returns the updated request type

application/json

RequestTypeDTO
PUT/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
1 2 3 4 5 6 7 8 9 10 curl --request PUT \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "description": "<string>", "helpText": "<string>", "name": "<string>", "requestTypeId": 2154 }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "id": "<string>", "_links": { "self": "<string>" }, "name": "<string>", "description": "<string>", "helpText": "<string>", "serviceDeskId": "<string>", "groupIds": [ "<string>" ], "icon": { "id": "<string>", "_links": { "iconUrls": {} } }, "restrictionStatus": "OPEN" }
POST

Create request type

Creates a new request type for a given service project. Certain fields cannot be specified on creation. These fields are given default values instead, as shown below.

Request Type icon - Question mark icon

Request Type groups - Empty, i.e. this request type will be hidden by default and not visible on the customer portal

Request Type status mapping - Empty, i.e. no custom status mapping

Request Type field mapping - Show the required fields as specified by the issue type

These fields can be updated after creation by a project administrator using the Agent view.

Permissions:

The calling user must be a project administrator for the service project project.

Request

Path parameters

serviceDeskId

string

Required

Request bodyapplication/json

The request type to create.

issueTypeId

string

name

string

description

string

helpText

string

Responses

Returns the newly created request type

application/json

RequestTypeDTO
POST/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "issueTypeId": "<string>", "name": "<string>", "description": "<string>", "helpText": "<string>" }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "id": "<string>", "_links": { "self": "<string>" }, "name": "<string>", "description": "<string>", "helpText": "<string>", "serviceDeskId": "<string>", "groupIds": [ "<string>" ], "icon": { "id": "<string>", "_links": { "iconUrls": {} } }, "restrictionStatus": "OPEN" }
GET

Get request types by ID

Returns a request type for a given request type Id.

Request

Path parameters

serviceDeskId

string

Required
requestTypeId

string

Required

Query parameters

restrictionStatus

string

Responses

Returns the requested request type.

application/json

RequestTypeDTO
GET/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "id": "<string>", "_links": { "self": "<string>" }, "name": "<string>", "description": "<string>", "helpText": "<string>", "serviceDeskId": "<string>", "groupIds": [ "<string>" ], "icon": { "id": "<string>", "_links": { "iconUrls": {} } }, "restrictionStatus": "OPEN" }
DEL

Delete request type

Deletes a request type for a given service project.

Permissions:

The calling user must be a project administrator for the service project project.

Request

Path parameters

serviceDeskId

string

Required
requestTypeId

string

Required

Responses

Returned if the delete was successful

DEL/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}'

Rate this page: