Cloud
Forms / Reference / REST API

Forms Export

Postman Collection
OpenAPI

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.

POST

Start exportExperimental

Starts an export of form data on a project.

Permissions required:

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

read:jira-work

Request

Request bodyapplication/json

A request specifying the export.

format

string

Required
projectIdOrKey

string

Required
formTemplate

FormTemplateRef

Required
fields

array<string>

jql

string

Responses

Returned when the project's forms have started export successfully.

application/json

ExportResponse

Indicates that the export process has started successfully.

POST/export
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>" }'
200Response
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" }
GET

Get export statusExperimental

Gets the status of an export of form data.

Permissions required:

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

read:jira-work

Request

Path parameters

exportId

string

Required

Responses

The status of an export; whether it has completed successfully or failed, or its current progress.

application/json

ExportStatusResponse

The status of an export.

GET/export/{exportId}
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'
200Response
1 2 3 4 5 { "complete": false, "failed": false, "progress": 43 }
GET

Download export resultExperimental

Downloads the result of an export of form data.

Permissions required:

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

read:jira-work

Request

Path parameters

exportId

string

Required
filename

string

Required

Responses

The export has completed successfully, and will be downloaded.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

array<string>

GET/export/{exportId}/{filename}
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'

Rate this page: