Forms

Read or export one form submission including raw values for an authorized principal.

Pass format=json, yaml, or csv to download a bounded stable export for one submission. CSV is available only when submitted field values are tabular scalars or scalar arrays.

get/api/v1/forms/{formId}/submissions/{submissionId}

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/forms/{formId}/submissions/{submissionId}
  • Auth: HTTP bearer

Path parameters

formIdstring required

Form id or reference id.

submissionIdstring required

Form submission id.

Query parameters

format'json' | 'yaml' | 'csv'

Optional export format. Omit for the normal JSON API envelope.

kindstring

Source context kind when exporting a review-scoped embedded answer.

draftReviewSessionIdstring
webAppReviewIdstring
ownerstring
repostring
prNumberinteger
branchRefstring
filePathstring
documentVersionIdstring
formInstanceIdstring

Headers

X-Commentary-Workspace-Idstring

Must match the credential workspace. This header cannot widen grant authority.

X-Correlation-Idstring

Response

Successful response.

okunknown

Changes

No recorded changes to this operation across all 1 revision of this API.