Rate this page:
APIs which handle exporting form data from Jira.
To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorisation.
POST /jira/forms/cloud/{cloudId}/export
Starts an export of form data on a project.
Permissions required:
read:jira-work
A request indicating forms from a project to be exported.
string
The format of the exported data.
Valid values: xlsx
string
The project key or id to export data from.
Metadata of the template the form was created from.
Array<string>
An array with the name(s) of Jira fields. The export will include the values of each of these Jira fields, for each issue.
string
A JQL query. The export will be limited to include only issues that match this JQL query.
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>"
}'
Returned when the project's forms have started export successfully.
Content type | Value |
---|---|
application/json |
GET /jira/forms/cloud/{cloudId}/export/{exportId}/{filename}
Downloads the result of an export of form data.
Permissions required:
read:jira-work
string
The export task ID
string
The name of the file to export to
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'
The export has completed successfully, and will be downloaded.
Content type | Value |
---|---|
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Array<string> |
GET /jira/forms/cloud/{cloudId}/export/{exportId}
Gets the status of an export of form data.
Permissions required:
read:jira-work
string
The export task ID
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'
The status of an export; whether it has completed successfully or failed, or its current progress.
Content type | Value |
---|---|
application/json |
Rate this page: