OBJECT

OnlineFormSettings

link GraphQL Schema definition

  • type OnlineFormSettings {
  • # If true, submitting the form updates an existing record.
  • updateRecordEnabled: Boolean!
  • # Template describing how the existing record is updated on submission.
  • updateRecordForm: ProcessEntityTemplate
  • # If true, submitting the form creates a new record.
  • createRecordEnabled: Boolean!
  • # Template describing how the new record is created on submission.
  • createRecordForm: ProcessEntityTemplate
  • # If true, submitting the form links the response to an existing record.
  • linkRecordEnabled: Boolean!
  • # Settings for related records that are linked to existing records on submission.
  • linkRelatedRecords: [OnlineFormRelatedRecordSettings!]!
  • # Settings for related records that are either linked if found or created
  • # otherwise on submission.
  • linkOrCreateRelatedRecords: [OnlineFormRelatedRecordSettings!]!
  • # Settings for related records that are updated if found or created otherwise on
  • # submission.
  • updateOrCreateRelatedRecords: [OnlineFormRelatedRecordSettings!]!
  • # Settings for related records that are updated on submission.
  • updateRelatedRecords: [OnlineFormRelatedRecordSettings!]!
  • # Settings for related records that are created on submission.
  • createRelatedRecords: [OnlineFormRelatedRecordSettings!]!
  • # If true, a PDF copy of the response is attached to the created or updated
  • # record.
  • attachResponseAsPdf: Boolean!
  • # If true, each respondent may submit the form only once.
  • limitToSingleResponse: Boolean!
  • # If true, the form checks for a previous response from the same respondent before
  • # accepting a submission.
  • checkForExistingResponse: Boolean!
  • # If true, an email notification is sent when the form is submitted.
  • notificationEnabled: Boolean!
  • # Who receives the submission notification: the form Owner, the
  • # PrimaryRecordOwner, and/or Custom email addresses.
  • notificationRecipientType: [OnlineFormNotificationRecipientType!]!
  • # Custom email addresses that receive the submission notification.
  • notificationEmails: [String!]!
  • # If true, an email notification is sent when the form stops accepting responses.
  • notificationLimitEnabled: Boolean!
  • # Who receives the limit-reached notification: the form Owner, the
  • # PrimaryRecordOwner, and/or Custom email addresses.
  • notificationLimitRecipientType: [OnlineFormNotificationRecipientType!]!
  • # Custom email addresses that receive the limit-reached notification.
  • notificationLimitEmails: [String!]!
  • # What the respondent sees after submitting: a ConfirmationPage or a redirect to
  • # an ExternalUrl.
  • confirmationPageType: OnlineFormConfirmationPageType!
  • # Heading shown on the confirmation page after submission.
  • confirmationPageTitle: String
  • # Message shown on the confirmation page after submission.
  • confirmationPageMessage: String
  • # External URL the respondent is redirected to after submission.
  • confirmationPageUrl: String
  • # Identify by Field on the Record
  • autolinkEnabled: Boolean!
  • # Identifier of the form field whose value is matched against records to auto-link
  • # a response.
  • autolinkFormFieldId: ID
  • # Identifier of the record field matched against the form field value to auto-link
  • # a response.
  • autolinkRecordFieldId: ID
  • # If true, all form content is shown on a single page rather than split across
  • # pages.
  • singlePageContent: Boolean!
  • # If true, the form stops accepting responses after a set date and time.
  • responseAcceptanceDateLimitEnabled: Boolean!
  • # Date and time after which the form no longer accepts responses.
  • responseAcceptanceDateLimitDate: DateTime
  • # Message shown to respondents after the date limit has passed.
  • responseAcceptanceDateLimitMessage: String
  • # Heading shown to respondents after the date limit has passed.
  • responseAcceptanceDateLimitTitle: String
  • # If true, the form stops accepting responses once a threshold is reached.
  • responseAcceptanceThresholdEnabled: Boolean!
  • # How the threshold is measured: TotalResponses, CustomCondition, or
  • # ProductsLimits.
  • responseAcceptanceThresholdType: ResponseAcceptanceThresholdType!
  • # Maximum number of responses accepted when the threshold type is TotalResponses.
  • responseAcceptanceThresholdNoOfResponses: Int
  • # Formula-based threshold configuration used when the threshold type is
  • # CustomCondition.
  • responseAcceptanceThresholdCustomCondition: ResponseAcceptanceThresholdCustomCondition
  • # Message shown to respondents after the threshold has been reached.
  • responseAcceptanceThresholdMessage: String
  • # Heading shown to respondents after the threshold has been reached.
  • responseAcceptanceThresholdTitle: String
  • # Per-product quantity threshold configuration used when the threshold type is
  • # ProductsLimits.
  • responseAcceptanceThresholdProductsLimits: ResponseAcceptanceThresholdProductsLimits
  • # Require Record Identification
  • recordIdentificationEnabled: Boolean!
  • # Message shown to respondents asking them to identify their record.
  • recordIdentificationMessage: String
  • # Heading shown to respondents asking them to identify their record.
  • recordIdentificationTitle: String
  • # How record identification is presented: an in-form ConfirmationPage or a
  • # redirect to an ExternalUrl.
  • recordIdentificationType: OnlineFormConfirmationPageType!
  • # External URL used for record identification when the identification type is
  • # ExternalUrl.
  • recordIdentificationUrl: String
  • # MB
  • maxTotalUploadedFilesSize: Int!
  • # If true, files uploaded via the form are attached to the created or updated
  • # record.
  • attachFiles: Boolean!
  • # Identifier of the price list used to price products shown on the form; defaults
  • # to the current price list when not set.
  • productsPriceListId: ID
  • # Identifier of the currency in which product prices are shown.
  • productsCurrencyId: ID!
  • # If true, the grand total of all selected products is shown on the form.
  • productsShowGrandTotal: Boolean!
  • # If true, per-product quantity limits are enforced for each response.
  • productsResponseLimitsEnabled: Boolean!
  • # Per-product quantity limits applied to a single response.
  • productsResponseLimits: [OnlineFormProductsResponseLimit!]!
  • # If true, per-product quantity limits are enforced across all responses combined.
  • productsTotalResponseLimitsEnabled: Boolean!
  • # Per-product quantity limits applied across all responses combined.
  • productsTotalResponseLimits: [OnlineFormProductsResponseLimit!]!
  • # If true, each question is numbered on the form.
  • showQuestionNumbers: Boolean!
  • }

link Require by