Rate this page:
APIs which handle forms on JSM projects.
To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorization.
Gets a form template as a JSON object on a project.
Permissions required:
Connect app scope required: READ
read:jira-workstring
Requiredstring
RequiredReturned when the form template is retrieved successfully.
The form template associated with a project.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form/{formId}' \
--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
{
"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
}
}
},
"publish": {
"jira": {
"recommendedIssueRequestTypeIds": [
92
],
"issueCreateIssueTypeIds": [
109
],
"issueCreateRequestTypeIds": [
111
],
"submitOnCreate": true,
"validateOnCreate": true
},
"portal": {
"portalRequestTypeIds": [
63
],
"submitOnCreate": true,
"validateOnCreate": true
}
}
}Saves a form template on a project.
Permissions required:
Connect app scope required: WRITE
manage:jira-projectstring
Requiredstring
RequiredA JSON object containing a form template to save.
FormDesignRequest
RequiredFormPublishing
Returned when the form template is saved successfully.
A summary of a form template associated with a project.
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
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form/{formId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"design": {
"conditions": {},
"layout": [
{}
],
"questions": {},
"sections": {},
"settings": {
"name": "New employee onboarding",
"language": "en",
"submit": {
"lock": true,
"pdf": true
}
}
},
"publish": {
"jira": {
"recommendedIssueRequestTypeIds": [
92
],
"issueCreateIssueTypeIds": [
109
],
"issueCreateRequestTypeIds": [
111
],
"submitOnCreate": true,
"validateOnCreate": true
},
"portal": {
"portalRequestTypeIds": [
63
],
"submitOnCreate": true,
"validateOnCreate": true
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"id": "<string>",
"name": "<string>",
"updated": "<string>",
"portalRequestTypeIds": [
77
],
"recommendedIssueRequestTypeIds": [
136
],
"issueCreateIssueTypeIds": [
64
],
"issueCreateRequestTypeIds": [
66
]
}Deletes a form on a project. This won't affect existing issues that already use this form, or any copies of this form in other projects.
Permissions required:
Connect app scope required: DELETE
manage:jira-projectstring
Requiredstring
RequiredReturned when the form template is deleted successfully.
string
1
2
3
4
curl --request DELETE \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form/{formId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
"<string>"Get a list of form templates associated with the project.
Permissions required:
Connect app scope required: READ
read:jira-workstring
RequiredThe list of form templates on the project.
array<FormTemplateIndexEntry>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/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
[
{
"id": "<string>",
"name": "<string>",
"updated": "<string>",
"portalRequestTypeIds": [
77
],
"recommendedIssueRequestTypeIds": [
136
],
"issueCreateIssueTypeIds": [
64
],
"issueCreateRequestTypeIds": [
66
]
}
]Creates a form template on a project.
Permissions required:
Connect app scope required: WRITE
manage:jira-projectstring
RequiredA JSON object containing the content for a form template.
FormDesignRequest
RequiredFormPublishing
Returned when the form template is created successfully.
A summary of a form associated with an issue or request.
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
curl --request POST \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"design": {
"conditions": {},
"layout": [
{}
],
"questions": {},
"sections": {},
"settings": {
"name": "New employee onboarding",
"language": "en",
"submit": {
"lock": true,
"pdf": true
}
}
},
"publish": {
"jira": {
"recommendedIssueRequestTypeIds": [
92
],
"issueCreateIssueTypeIds": [
109
],
"issueCreateRequestTypeIds": [
111
],
"submitOnCreate": true,
"validateOnCreate": true
},
"portal": {
"portalRequestTypeIds": [
63
],
"submitOnCreate": true,
"validateOnCreate": true
}
}
}'1
2
3
4
5
6
7
8
9
10
11
{
"id": "<string>",
"formTemplate": {
"id": "<string>"
},
"internal": true,
"submitted": true,
"lock": true,
"name": "<string>",
"updated": "<string>"
}