OBJECT

Form

A single form's definition

link GraphQL Schema definition

  • type Form {
  • # Unique form ID.
  • id: Int!
  • # The form's display name.
  • title: String!
  • # Long description of the form.
  • description: String
  • # Display metadata for the form's fields.
  • display_meta: UntypedValue
  • # List of emails to send the form results to on submission.
  • notification: [String]
  • # List of tags that are allowed to see the form.
  • user_tags_permission: [Tag]
  • # True if submitted form results should be able to be edited.
  • results_editable: Boolean!
  • # True if the header client field is required in submitted form results.
  • require_client: Boolean!
  • # True if the project client field is required in submitted form results.
  • require_project: Boolean!
  • # True if the asset client field is required in submitted form results.
  • require_asset: Boolean!
  • # True if the worker client field is required in submitted form results.
  • require_worker: Boolean!
  • # True if the supplier client field is required in submitted form results.
  • require_supplier: Boolean!
  • # True if the user's geolocation should be collected on form result submission.
  • require_geolocation: Boolean!
  • # When this form is attached to an order task, user will be required to fill it in
  • # before they can submit a timesheet for their allocation.
  • require_for_timesheets: Boolean!
  • # True if the form is archived, and no longer active.
  • is_active: Boolean!
  • # True if the form is logically deleted.
  • is_archived: Boolean!
  • # The date the form was last updated in UTC+0.
  • modified_time: DateTime
  • # The date the form was created in UTC+0.
  • created_time: DateTime!
  • # The user that the form result will be assigned to on submission.
  • assign_on_submit: User
  • # The default status to set the form result to on submission.
  • default_status: FormStatus
  • # The printing template path. Null if no template has been uploaded.
  • print_template: String @deprecated( reason: "Use the merge_template instead - this field will stop returning anything soon." )
  • # The merge template information. Null if no template has been uploaded.
  • merge_template: MergeTemplate
  • # The position in form lists that the form will appear.
  • sort_order: Int
  • # True if there are results logged against this form. False otherwise.
  • has_results: Boolean!
  • # Whether a form can be shared amongst users to complete.
  • is_shareable: Boolean!
  • # The settings for displaying a form result
  • display_settings: FormDisplaySetting
  • }