Skip to main content

FormMutations

No description

type FormMutations {
createForm(
name: String!
description: String!
schema: String!
): Form
updateForm(
formId: Long!
name: String!
description: String!
schema: String!
): Form
deleteForm(
formId: Long!
): Boolean
}

Fields

FormMutations.createForm ● Form object

Create a reusable form definition (SurveyJS JSON). The schema is validated against an allowlist of safe question types. Requires canManageForms.

FormMutations.createForm.name ● String! non-null scalar
FormMutations.createForm.description ● String! non-null scalar
FormMutations.createForm.schema ● String! non-null scalar

FormMutations.updateForm ● Form object

Update a form definition (bumps its version). Requires canManageForms.

FormMutations.updateForm.formId ● Long! non-null scalar
FormMutations.updateForm.name ● String! non-null scalar
FormMutations.updateForm.description ● String! non-null scalar
FormMutations.updateForm.schema ● String! non-null scalar

FormMutations.deleteForm ● Boolean scalar

Soft-delete a form definition. Already-attached tasks keep their snapshot. Requires canManageForms.

FormMutations.deleteForm.formId ● Long! non-null scalar

Returned By

forms mutation