APIs which handle exporting form data from Jira.
To learn how to export forms, read exporting forms.
To learn about the appropriate URI structure for your chosen authentication method, read authentication and authorization.
Starts an export of form data on a project.
Permissions required:
Connect app scope required: READ
read:jira-workA request specifying the export.
string
Requiredstring
RequiredFormTemplateRef
Requiredarray<string>
string
Returned when the project's forms have started export successfully.
Indicates that the export process has started successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request POST \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/export' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"format": "xlsx",
"projectIdOrKey": "<string>",
"formTemplate": {
"id": "<string>"
},
"fields": [
"<string>"
],
"jql": "<string>"
}'1
2
3
4
5
{
"format": "xlsx",
"id": "responses-xlsx-10000-0-000000000",
"statusUrl": "https://api.atlassian.com/jira/forms/cloud/{cloudId}/export/responses-xlsx-10000-0-000000000"
}Downloads the result of an export of form data.
Permissions required:
Connect app scope required: READ
read:jira-workstring
Requiredstring
RequiredThe export has completed successfully, and will be downloaded.
array<string>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/export/{exportId}/{filename}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'Gets the status of an export of form data.
Permissions required:
Connect app scope required: READ
read:jira-workstring
RequiredThe status of an export; whether it has completed successfully or failed, or its current progress.
The status of an export.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/export/{exportId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
{
"complete": false,
"failed": false,
"progress": 43
}Rate this page: