APIs which handle external forms on customer requests in the portal. For internal forms, see Forms on Issue.
To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorization.
Gets the answers from a form on a request that are simplified into a flattened list for scripting tool ease of use. Multivalued answers will be flattened to a comma-separated string.
Permissions required:
Connect app scope required: READ
read:servicedesk-requeststring
Requiredstring
RequiredReturned when the form answers are retrieved successfully.
array<FormSimplifiedAnswer>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/format/answers' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"label": "<string>",
"fieldKey": "<string>",
"answer": "<string>",
"choice": "<string>"
}
]Retrieve metadata for all attachments in a form on a request.
Permissions required:
Connect app scope required: READ
read:servicedesk-requeststring
Requiredstring
RequiredReturned when the metadata associated with the attachment fields on the form are successfully retrieved.
A response containing all the form's attachments.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/attachment' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"fields": {}
}Gets a single form on a request as a complete JSON object.
Permissions required:
Connect app scope required: READ
read:servicedesk-requeststring
Requiredstring
RequiredReturned when the form is retrieved successfully.
A form associated with an issue or request.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/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
{
"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
}
}
},
"state": {
"visibility": "i",
"status": "o",
"answers": {}
}
}Saves form answers on a request.
Permissions required:
Connect app scope required: WRITE
write:servicedesk-requeststring
Requiredstring
RequiredA request to save form answers.
object
RequiredReturned when form answers are successfully saved.
A form associated with an issue or request.
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"answers": {}
}'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
{
"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
}
}
},
"state": {
"visibility": "i",
"status": "o",
"answers": {}
}
}Gets a list of forms on the customer request with basic metadata about them.
Permissions required:
Connect app scope required: READ
read:servicedesk-requeststring
RequiredThe list of forms on the customer request.
array<FormIndexEntry>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
[
{
"id": "<string>",
"formTemplate": {
"id": "<string>"
},
"internal": true,
"submitted": true,
"lock": true,
"name": "<string>",
"updated": "<string>"
}
]Gets a single form on a request as a PDF file.
Permissions required:
Connect app scope required: READ
read:servicedesk-requeststring
Requiredstring
RequiredReturned when the pdf is retrieved successfully.
string
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/format/pdf' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/pdf'Gets a single form on a request as an XLSX file.
Permissions required:
Connect app scope required: READ
read:servicedesk-requeststring
Requiredstring
RequiredReturned when the xlsx is retrieved successfully.
string
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/format/xlsx' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'Changes the status of a form on a request to submitted.
Depending on how the form is configured the form may either enter the submitted state or the locked state. Locked forms are considered to be submitted and locked and can only be reopened by project admins.
The current iteration of this API does not check that form answers are valid.
Permissions required:
Connect app scope required: WRITE
write:servicedesk-requeststring
Requiredstring
RequiredReturned when the form is submitted successfully.
A response indicating the current status of a form on an issue or request.
1
2
3
4
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/action/submit' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"status": "open"
}Get all external form data for questions and answers on a form added to a request. 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:
Connect app scope required: READ
read:servicedesk-requeststring
Requiredstring
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}/request/{issueIdOrKey}/form/{formId}/externaldata' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"fields": {}
}Rate this page: