APIs which handle forms in the portal (service desk).
To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorization.
Get all external form data for questions and default answers on a form added to a request type. Forms can be linked to external sources including Jira fields and data connections, with this API returning the latest responses on these linked fields.
Permissions required:
read:servicedesk-requestConnect app scope required: READ
string
Requiredinteger
RequiredThe external field data for questions and answers on a form.
A response containing all external data for questions and answers on a form.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form/externaldata' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"fields": {}
}Gets a form template as a JSON object on a request type.
Permissions required:
read:servicedesk-requestConnect app scope required: READ
string
Requiredinteger
Requiredstring
Returned when the form is retrieved successfully.
The form template associated with a request type in the portal.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form' \
--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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
"id": "c18bde7a-d846-11ed-afa1-0242ac120002",
"updated": "2023-04-11T08:59:18Z",
"design": {
"conditions": {},
"layout": [
{}
],
"questions": {},
"sections": {},
"settings": {
"name": "New employee onboarding",
"language": "en",
"submit": {
"lock": true,
"pdf": true
},
"primaryLocale": {
"language": "<string>",
"displayName": "<string>",
"country": "<string>",
"variant": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
},
"translatedLocale": {
"language": "<string>",
"displayName": "<string>",
"country": "<string>",
"variant": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
}
}
},
"publish": {
"portalRequestTypeIds": [
63
],
"submitOnCreate": true,
"validateOnCreate": true
}
}Rate this page: