Cloud
Forms / Reference / REST API

Forms on Customer Request

Postman Collection
OpenAPI
GET

Get form simplified answersExperimental

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

  • View request permission to view the customer request.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Responses

Returned when the form answers are retrieved successfully.

application/json

array<FormSimplifiedAnswer>

GET/request/{issueIdOrKey}/form/{formId}/format/answers
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/format/answers' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 [ { "label": "<string>", "fieldKey": "<string>", "answer": "<string>", "choice": "<string>" } ]
GET

Get form attachments metadataExperimental

Retrieve metadata for all attachments in a form on a request.

Permissions required:

  • View request permission to view the customer request.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Responses

Returned when the metadata associated with the attachment fields on the form are successfully retrieved.

application/json

FormAttachmentsMetadata

A response containing all the form's attachments.

GET/request/{issueIdOrKey}/form/{formId}/attachment
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/attachment' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 { "fields": {} }
PUT

Submit formExperimental

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

  • Edit request permission to edit the customer request.
Scopes

Connect app scope requiredWRITE

write:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Responses

Returned when the form is submitted successfully.

application/json

FormStatusResponse

A response indicating the current status of a form on an issue or request.

PUT/request/{issueIdOrKey}/form/{formId}/action/submit
1 2 3 4 curl --request PUT \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/action/submit' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 { "status": "open" }
GET

Get formExperimental

Gets a single form on a request as a complete JSON object.

Permissions required:

  • View request permission to view the customer request.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Responses

Returned when the form is retrieved successfully.

application/json

Form

A form associated with an issue or request.

GET/request/{issueIdOrKey}/form/{formId}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "id": "c18bde7a-d846-11ed-afa1-0242ac120002", "updated": "2023-04-11T08:59:18Z", "design": { "conditions": {}, "layout": [ {} ], "questions": {}, "sections": {}, "settings": { "name": "New employee onboarding", "language": "en", "submit": { "lock": true, "pdf": true } } }, "state": { "visibility": "i", "status": "o", "answers": {} } }
PUT

Save form answersExperimental

Saves form answers on a request.

Permissions required:

  • Edit request permission to edit the customer request.
Scopes

Connect app scope requiredWRITE

write:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Request bodyapplication/json

A request to save form answers.

answers

object

Required

Responses

Returned when form answers are successfully saved.

application/json

Form

A form associated with an issue or request.

PUT/request/{issueIdOrKey}/form/{formId}
1 2 3 4 5 6 7 8 curl --request PUT \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "answers": {} }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "id": "c18bde7a-d846-11ed-afa1-0242ac120002", "updated": "2023-04-11T08:59:18Z", "design": { "conditions": {}, "layout": [ {} ], "questions": {}, "sections": {}, "settings": { "name": "New employee onboarding", "language": "en", "submit": { "lock": true, "pdf": true } } }, "state": { "visibility": "i", "status": "o", "answers": {} } }
GET

Get form indexExperimental

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

Permissions required:

  • View request permission to view the customer request.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required

Responses

The list of forms on the customer request.

application/json

array<FormIndexEntry>

GET/request/{issueIdOrKey}/form
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 [ { "id": "<string>", "formTemplate": { "id": "<string>" }, "internal": true, "submitted": true, "lock": true, "name": "<string>", "updated": "<string>" } ]
GET

Get form PDFExperimental

Gets a single form on a request as a PDF file.

Permissions required:

  • View request permission to view the customer request.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Responses

Returned when the pdf is retrieved successfully.

application/pdf

string

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

Get form XLSXExperimental

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

Permissions required:

  • View request permission to view the customer request.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Responses

Returned when the xlsx is retrieved successfully.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string

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

Get external form dataExperimental

Get all external form data for questions and answers on a form added to a request. Forms can be linked to external sources including Jira fields and data connections, with this API returning the latest responses on these linked fields.

Permissions required:

  • View request permission to view the customer request.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

issueIdOrKey

string

Required
formId

string

Required

Responses

The external field data for questions and answers on a form.

application/json

ExternalFieldDataResponse

A response containing all external data for questions and answers on a form.

GET/request/{issueIdOrKey}/form/{formId}/externaldata
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/request/{issueIdOrKey}/form/{formId}/externaldata' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 { "fields": {} }