Forms

Download a generated document

GET/submissions/{submission_id}/documents/{id}/download
forms:readget_submission_document_downloadRead-only

Streams the generated document's file, named after the document, with the stored file's extension added when the name lacks it; /, \ and control characters in the name become -, and a non-ASCII name also gets an ASCII fallback in Content-Disposition. A document of another submission, or one whose stored file is missing, is 404. GET /submissions/{submission_id}/documents/{id} reads its details. It changes nothing.

Path parameters

  • submission_idstring (uuid)Required#

    The submission's id, a uuid. An unknown id, or a submission you cannot see, returns 404.

  • idstring (uuid)Required#

    The generated document's id, a uuid. An unknown id, or a document of another submission, returns 404.

Responses

200

The generated document's file.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/submissions/{submission_id}/documents/{id}/download\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"