Get form XLSX

GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/xlsx

Gets a single form on an issue as an XLSX file.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request GET \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/xlsx' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'

Responses

Get form simplified answers

GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/answers

Gets the answers from a form on an issue 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:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request GET \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/answers' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Get form index

GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form

Gets a list of forms on the issue with basic metadata about them.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request GET \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Add form

POST /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form

Adds a form template to an issue.

Permissions required:

• Browse projects and Edit issues project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Body parameters

Example

1
2
3
4
5
6
7
8
9
10

curl --request POST \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "formTemplate": {
    "id": "<string>"
  }
}'

Responses

Change visibility to external

PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/external

Changes the visibility of a form on an issue from internal only to external. External forms can be viewed in the portal by customers.

Permissions required:

• Browse projects and Edit issues project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request PUT \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/external' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Change visibility to internal

PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/internal

Changes the visibility of a form on an issue from external to internal only. Internal forms can not be viewed in the portal by customers.

Permissions required:

• Browse projects and Edit issues project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request PUT \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/internal' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Get form

GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}

Gets a single form on an issue as a complete JSON object.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request GET \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Delete form

DELETE /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}

Deletes a form from an issue.

Permissions required:

• Browse projects and Edit issues project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request DELETE \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Get form PDF

GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/pdf

Gets a single form on an issue as a PDF file.

Permissions required:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request GET \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/pdf' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/pdf'

Responses

Submit form

PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/submit

Changes the status of a form on an issue 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:

• Browse projects and Edit issues project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Example

1
2
3
4

curl --request PUT \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/submit' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Reopen form

PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/reopen

Changes the status of a submitted form on an issue to open to enable editing. Locked forms can only be reopened by a project admin.

Permissions required:

• Browse projects and Edit issues project permission for the project that the issue is in.

• If issue-level security is configured, issue-level security permission to view the issue.

• Administer Jira project permission if the form is locked.

Request

Example

1
2
3
4

curl --request PUT \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/reopen' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Copy forms

POST /jira/forms/cloud/{cloudId}/issue/{sourceIssueIdOrKey}/form/copy/{targetIssueIdOrKey}

Copy forms from one issue to another.

Permissions required:

• Browse projects and Edit issues project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Request

Body parameters

Example

1
2
3
4
5
6
7
8
9
10

curl --request POST \
  --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{sourceIssueIdOrKey}/form/copy/{targetIssueIdOrKey}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    "<string>"
  ]
}'

Responses