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.Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturns the requested request type fields and related fields, at the specified page of the results.
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'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
}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
Forge and OAuth2 apps cannot access this REST resource.
string
Requirednumber
number
Returns the requested request type groups, at the specified page of the results.
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'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>"
}
]
}Returns all request types from a service project, for a given service project Id.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
number
number
Returns the requested request types, at the specified page of the results.
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'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"
}
]
}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.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe request type to create.
string
string
string
string
Returns the newly created request type
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>"
}'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"
}Returns a request type for a given request type Id.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturns the requested request type.
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'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"
}Rate this page: