Forms Export
Forms on Issue
Forms on Project

Rate this page:

Forms Export

APIs which handle exporting form data from Jira.

To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorisation.

Start export

Experimental

POST /jira/forms/cloud/{cloudId}/export

Starts an export of form data on a project.

Permissions required:

read:jira-work

Request

Body parameters

A request indicating forms from a project to be exported.

format Required

string

The format of the exported data.

Valid values: xlsx

projectIdOrKey Required

string

The project key or id to export data from.

formTemplate Required

FormTemplateRef

Metadata of the template the form was created from.

fields

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.

jql

string

Example

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>"
}'

Responses

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

Content typeValue
application/json

ExportResponse

Download export result

Experimental

GET /jira/forms/cloud/{cloudId}/export/{exportId}/{filename}

Downloads the result of an export of form data.

Permissions required:

read:jira-work

Request

Path parameters
exportId Required

string

The export task ID

filename Required

string

The name of the file to export to

Example

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'

Responses

The export has completed successfully, and will be downloaded.

Content typeValue
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Array<string>

Get export status

Experimental

GET /jira/forms/cloud/{cloudId}/export/{exportId}

Gets the status of an export of form data.

Permissions required:

read:jira-work

Request

Path parameters
exportId Required

string

The export task ID

Example

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'

Responses

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

Content typeValue
application/json

ExportStatusResponse

Rate this page: