Sign in

v3

latestOpenAPI 3.0.12026-08-0474115357.9 KB
Servicedesk

Create request type

This method enables a customer request type to be added to a service desk based on an issue type. Note that not all customer request type fields can be specified in the request and these fields are given the following default values:

  • Request type icon is given the headset icon.
  • Request type groups is left empty, which means this customer request type will not be visible on the customer portal.
  • Request type status mapping is left empty, so the request type has no custom status mapping but inherits the status map from the issue type upon which it is based.
  • Request type field mapping is set to show the required fields as specified by the issue type used to create the customer request type.

These fields can be updated by a service desk administrator using the Request types option in Project settings.
Request Types are created in next-gen projects by creating Issue Types. Please use the Jira Cloud Platform Create issue type endpoint instead.

Permissions required: Service desk's administrator

post/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype

Path parameters

serviceDeskIdstring required

The ID of the service desk where the customer request type is to be created. This can alternatively be a project identifier.

Request body

descriptionstring

Description of the request type on the service desk.

helpTextstring

Help text for the request type on the service desk.

issueTypeIdstring

ID of the request type to add to the service desk.

namestring

Name of the request type on the service desk.

Response

Returns the customer request type created.

_expandsstring[]

List of items that can be expanded in the response by specifying the expand query parameter.

canCreateRequestboolean

Whether the user has permission to create a request with this request type.

descriptionstring

Description of the request type.

groupIdsstring[]

List of the request type groups the request type belongs to.

helpTextstring

Help text for the request type.

idstring

ID for the request type.

issueTypeIdstring

ID of the issue type the request type is based upon.

namestring

Short name for the request type.

portalIdstring

ID of the customer portal associated with the service desk project.

practicestring

The request type's practice

restrictionStatus'OPEN' | 'RESTRICTED'

Whether request type is restricted or not.

serviceDeskIdstring

ID of the service desk the request type belongs to.