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.
\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *Edit request* permission to edit the customer request.","operationId":"submitForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"KOKO-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form is submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormStatusResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested customer request or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in submitting the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:servicedesk-request"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/request/{issueIdOrKey}/form/{formId}":{"get":{"tags":["Forms on Customer Request"],"summary":"Get form","description":"Gets a single form on a request as a complete JSON object.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *View request* permission to view the customer request.","operationId":"getRequestForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form is retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested customer request was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the request form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"put":{"tags":["Forms on Customer Request"],"summary":"Save form answers","description":"Saves form answers on a request.
\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *Edit request* permission to edit the customer request.","operationId":"saveFormAnswers","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"KOKO-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"requestBody":{"description":"A request to save form answers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveFormRequest"}}},"required":false},"responses":{"200":{"description":"Returned when form answers are successfully saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"400":{"description":"The form answers provided were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested customer request or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in saving the form answers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:servicedesk-request"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/request/{issueIdOrKey}/form":{"get":{"tags":["Forms on Customer Request"],"summary":"Get form index","description":"Gets a list of forms on the customer request with basic metadata about them.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *View request* permission to view the customer request.","operationId":"getRequestFormIndex","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"}],"responses":{"200":{"description":"The list of forms on the customer request.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormIndexEntry"}}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested customer request was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the request form index.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/request/{issueIdOrKey}/form/{formId}/format/pdf":{"get":{"tags":["Forms on Customer Request"],"summary":"Get form PDF","description":"Gets a single form on a request as a PDF file.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *View request* permission to view the customer request.","operationId":"getRequestFormPdf","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the pdf is retrieved successfully.","content":{"application/pdf":{"schema":{"type":"string"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested customer request or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form pdf.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/request/{issueIdOrKey}/form/{formId}/format/xlsx":{"get":{"tags":["Forms on Customer Request"],"summary":"Get form XLSX","description":"Gets a single form on a request as an XLSX file.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *View request* permission to view the customer request.","operationId":"getRequestFormXlsx","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the xlsx is retrieved successfully.","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested customer request or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form xlsx.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/request/{issueIdOrKey}/form/{formId}/externaldata":{"get":{"tags":["Forms on Customer Request"],"summary":"Get external form data","description":"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.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *View request* permission to view the customer request.","operationId":"getRequestFormExternalData","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"The external field data for questions and answers on a form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalFieldDataResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested customer request was not found, the user does not have permission to view it, or the form status is submitted or locked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the external field data on the request form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/export":{"post":{"tags":["Forms Export"],"summary":"Start export","description":"Starts an export of form data on a project.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"start","requestBody":{"description":"A request specifying the export.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":false},"responses":{"200":{"description":"Returned when the project's forms have started export successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested project was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in exporting.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/export/{exportId}":{"get":{"tags":["Forms Export"],"summary":"Get export status","description":"Gets the status of an export of form data.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getStatus","parameters":[{"name":"exportId","in":"path","description":"The export task ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The status of an export; whether it has completed successfully or failed, or its current progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStatusResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The export task ID was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the export status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/export/{exportId}/{filename}":{"get":{"tags":["Forms Export"],"summary":"Download export result","description":"Downloads the result of an export of form data.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"download","parameters":[{"name":"exportId","in":"path","description":"The export task ID","required":true,"schema":{"type":"string"}},{"name":"filename","in":"path","description":"The name of the file to export to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The export has completed successfully, and will be downloaded.","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"The export has not yet completed, or the provided filename is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The export task ID was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in downloading the export.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/project/{projectIdOrKey}/form/{formId}":{"get":{"tags":["Forms on Project"],"summary":"Get form template","description":"Gets a form template as a JSON object on a project.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getFormTemplate","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project key or ID","required":true,"schema":{"type":"string"},"example":"EX"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"},{"name":"requestLanguage","in":"query","description":"The requested language for the form to be translated to","schema":{"type":"string"},"example":"en-US"}],"responses":{"200":{"description":"Returned when the form template is retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormTemplate"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested project was not found or the user does not have permission to access the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the project form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}]},"put":{"tags":["Forms on Project"],"summary":"Save form template","description":"Saves a form template on a project.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Administer Jira* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"saveFormTemplate","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project key or ID","required":true,"schema":{"type":"string"},"example":"EX"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"requestBody":{"description":"A JSON object containing a form template to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormTemplateRequest"}}},"required":false},"responses":{"200":{"description":"Returned when the form template is saved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormTemplateIndexEntry"}}}},"400":{"description":"The form template provided was invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested project was not found or the user does not have permission to administer the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in saving the form template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["manage:jira-project"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}]},"delete":{"tags":["Forms on Project"],"summary":"Delete form template","description":"Deletes a form on a project. This won't affect existing issues that already use this form, or any copies of this form in other projects.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Administer Jira* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"deleteFormTemplate","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project key or ID","required":true,"schema":{"type":"string"},"example":"EX"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form template is deleted successfully.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"A bad request was made.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested project was not found or the user does not have permission to administer the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in deleting the form template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["manage:jira-project"]}],"x-atlassian-connect-scope":"DELETE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}]}},"/project/{projectIdOrKey}/form":{"get":{"tags":["Forms on Project"],"summary":"Get project form index","description":"Get a list of form templates associated with the project.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getFormTemplateIndex","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project key or ID","required":true,"schema":{"type":"string"},"example":"EX"}],"responses":{"200":{"description":"The list of form templates on the project.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormTemplateIndexEntry"}}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested project was not found or the user does not have permission to access the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the project forms index.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}]},"post":{"tags":["Forms on Project"],"summary":"Create form template","description":"Creates a form template on a project.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Administer Jira* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"createFormTemplate","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project key or ID","required":true,"schema":{"type":"string"},"example":"EX"}],"requestBody":{"description":"A JSON object containing the content for a form template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormTemplateRequest"}}},"required":false},"responses":{"200":{"description":"Returned when the form template is created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormIndexEntry"}}}},"400":{"description":"There are duplicate question keys on the form template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested project was not found or the user does not have permission to administer the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in creating the form template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["manage:jira-project"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}]}},"/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form":{"get":{"tags":["Forms on Portal"],"summary":"Get form on a request type","description":"Gets a form template as a JSON object on a request type.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *View Service Desk* permission to view the service desk.","operationId":"getFormTemplate","parameters":[{"name":"serviceDeskId","in":"path","description":"The service desk ID. This can alternatively be a [project identifier](#project-identifiers).","required":true,"schema":{"type":"string"},"example":15},{"name":"requestTypeId","in":"path","description":"The request type ID","required":true,"schema":{"type":"integer","format":"int64"},"example":11001},{"name":"requestLanguage","in":"query","description":"The requested language for the form to be translated to","schema":{"type":"string"},"example":"en-US"}],"responses":{"200":{"description":"Returned when the form is retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalFormTemplate"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The request type was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the request form template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}]}},"/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form/externaldata":{"get":{"tags":["Forms on Portal"],"summary":"Get external form data on a request type","description":"Get all external form data for questions and default answers on a form added to a request type. Forms can be linked to external sources including Jira fields and data connections, with this API returning the latest responses on these linked fields.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#permissions) required:**\n\n * *View Service Desk* permission to view the service desk.","operationId":"getFormTemplateExternalData","parameters":[{"name":"serviceDeskId","in":"path","description":"The service desk ID. This can alternatively be a [project identifier](#project-identifiers).","required":true,"schema":{"type":"string"},"example":15},{"name":"requestTypeId","in":"path","description":"The request type ID","required":true,"schema":{"type":"integer","format":"int64"},"example":11001}],"responses":{"200":{"description":"The external field data for questions and answers on a form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalFieldDataResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The request type was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the external field data on the request type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:servicedesk-request"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}]}},"/issue/{issueIdOrKey}/form/{formId}":{"get":{"tags":["Forms on Issue"],"summary":"Get form","description":"Gets a single form on an issue as a complete JSON object.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form is retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"put":{"tags":["Forms on Issue"],"summary":"Save form answers","description":"Saves form answers on an issue.
\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"saveFormAnswers","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"KOKO-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"requestBody":{"description":"A request to save form answers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveFormRequest"}}},"required":false},"responses":{"200":{"description":"Returned when form answers are successfully saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"400":{"description":"The form answers provided were invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in saving the form answers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"delete":{"tags":["Forms on Issue"],"summary":"Delete form","description":"Deletes a form from an issue.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"deleteForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"}},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returned when the form is deleted successfully.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"A bad request was made.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in deleting the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/attachment":{"get":{"tags":["Forms on Issue"],"summary":"Get form attachments metadata","description":"Retrieve metadata for all attachments in a form on an issue.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getIssueFormAttachmentsMetadata","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ZAINA-123"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"7f9b3a40-9f25-4c06-9e46-3b3c9588aa5d"}],"responses":{"200":{"description":"Returned when the metadata associated with the attachment fields on the form are successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormAttachmentsMetadata"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the attachments metadata on the issue form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/format/pdf":{"get":{"tags":["Forms on Issue"],"summary":"Get form PDF","description":"Gets a single form on an issue as a PDF file.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getFormPdf","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the pdf is retrieved successfully.","content":{"application/pdf":{"schema":{"type":"string"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form pdf.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/format/xlsx":{"get":{"tags":["Forms on Issue"],"summary":"Get form XLSX","description":"Gets a single form on an issue as an XLSX file.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getFormXlsx","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the xlsx is retrieved successfully.","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form xlsx.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form":{"get":{"tags":["Forms on Issue"],"summary":"Get form index","description":"Gets a list of forms on the issue with basic metadata about them.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getFormIndex","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"}],"responses":{"200":{"description":"The list of forms on the issue.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormIndexEntry"}}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form index.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"post":{"tags":["Forms on Issue"],"summary":"Add form","description":"Adds a form template to an issue.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"addForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A request specifying an attach form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachFormRequest"}}},"required":false},"responses":{"200":{"description":"Returned when the form template is attached successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormIndexEntry"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form template was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in attaching the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/action/submit":{"put":{"tags":["Forms on Issue"],"summary":"Submit form","description":"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.
\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"submitForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form is submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormStatusResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/action/reopen":{"put":{"tags":["Forms on Issue"],"summary":"Reopen form","description":"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.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n\n * *Administer Jira* [project permission](https://confluence.atlassian.com/x/x4dKLg) if the form is locked.","operationId":"reopenForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form is reopened successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormStatusResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The form is locked and can only be reopened by a project admin"},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{sourceIssueIdOrKey}/form/copy/{targetIssueIdOrKey}":{"post":{"tags":["Forms on Issue"],"summary":"Copy forms","description":"Copy forms from one issue to another.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"copyForms","parameters":[{"name":"sourceIssueIdOrKey","in":"path","description":"The source issue key or ID","required":true,"schema":{"type":"string"}},{"name":"targetIssueIdOrKey","in":"path","description":"The target issue key or ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A request with a list of form IDs to copy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyFormsRequest"}}},"required":false},"responses":{"200":{"description":"Returned when the forms are copied successfully, or with partial success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyFormsResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested source or target issue was not found, or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in copying the forms.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/externaldata":{"get":{"tags":["Forms on Issue"],"summary":"Get external form data","description":"Get all external form data for questions and answers on a form on an issue. Forms can be linked to external sources including Jira fields and data connections, with this API returning the latest responses on these linked fields.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getFormExternalData","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"The external field data for questions and answers on a form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalFieldDataResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the external field data on the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/action/external":{"put":{"tags":["Forms on Issue"],"summary":"Change visibility to external","description":"Changes the visibility of a form on an issue from internal only to external. External forms can be viewed in the portal by customers.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"externaliseForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form is successfully set to external.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormVisibilityResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form or setting the form visibility.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/action/internal":{"put":{"tags":["Forms on Issue"],"summary":"Change visibility to internal","description":"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.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects and Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"internaliseForm","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form is successfully set to internal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormVisibilityResponse"}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form or setting the form visibility.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/issue/{issueIdOrKey}/form/{formId}/format/answers":{"get":{"tags":["Forms on Issue"],"summary":"Get form simplified answers","description":"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.\n\n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getFormSimplifiedAnswers","parameters":[{"name":"issueIdOrKey","in":"path","description":"The issue key or ID","required":true,"schema":{"type":"string"},"example":"ISS-1"},{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"string","format":"uuid"},"example":"c18bde7a-d846-11ed-afa1-0242ac120002"}],"responses":{"200":{"description":"Returned when the form answers are retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormSimplifiedAnswer"}}}}},"401":{"description":"The user is not authorised to make this request."},"403":{"description":"The user does not have permission to make this request."},"404":{"description":"The requested issue or form was not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"412":{"description":"A form has an invalid/unsupported value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"429":{"description":"The rate limit has been exceeded due to too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}},"500":{"description":"There was an internal error in retrieving the form answers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorsResponse"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"oAuthDefinitions","scopes":["read:jira-work"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}}},"components":{"schemas":{"FormSimplifiedAnswer":{"required":["answer","label"],"type":"object","properties":{"label":{"type":"string","description":"The label of the form question."},"fieldKey":{"type":"string","description":"The field key associated with the form question, if one has been set in the form builder.
If no field key is set but there is an associated Jira field then fieldKey will contain the Jira field key.
If neither field key nor Jira field is available then fieldKey will not be provided.
"},"answer":{"type":"string","description":"The answer to the form question, represented as a string."},"choice":{"type":"string","description":"The selected choice IDs on a choice question."}},"description":"The form answers on an issue or request in a simplified format."},"ApiError":{"required":["code","status","title"],"type":"object","properties":{"id":{"type":"string","description":"Id of the error response.","format":"uuid"},"status":{"type":"integer","description":"Status code of the response.","format":"int32"},"code":{"type":"string","description":"Error code of the response."},"title":{"type":"string","description":"Message describing the error that occurred."},"detail":{"type":"string","description":"Additional detail describing why the error occurred."},"context":{"type":"array","description":"The context that identifies what caused the error.","items":{"$ref":"#/components/schemas/Entity"}}},"description":"Response indicating an error occurred."},"ApiErrorsResponse":{"required":["errors"],"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}},"Entity":{"required":["id","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of the entity."},"id":{"type":"string","description":"The identifier for the entity."}},"description":"An entity."},"FormAttachmentMetadata":{"required":["attachmentId","creationDate","id","name","size"],"type":"object","properties":{"attachmentId":{"type":"integer","description":"The ID for the attachment which can be used to call Jira Service Management REST APIs to get attachment content or get attachments for request.","format":"int64"},"id":{"type":"string","description":"File ID."},"name":{"type":"string","description":"Name of the uploaded file."},"creationDate":{"type":"integer","description":"File creation date in unix time.","format":"int64"},"size":{"type":"integer","description":"File size in bytes.","format":"int64"},"type":{"type":"string","description":"File type."}},"description":"Attachment metadata.","format":"Map