OBJECT
OnlineFormTypeEntity

Online form definition: the fields and settings of a web form whose submissions create or update records.
GraphQL Schema definition

type OnlineFormTypeEntity {
# True when the record has unpublished draft changes, including pending 
# translation changes, that can be published.
hasDraft: Boolean 
# True when the record is protected against deletion because it must always exist 
# in the space. Deleting a record that is not protected can still fail on other 
# checks. Read-only.
isDeleteProtected: Boolean! 
# Typed, read-only view of the online form definition (formEdit): its fields, 
# layout and settings.
formEditApi: OnlineForm 
# False for types whose read-only setting is fixed, such as the recurrent 
# appointment type; true otherwise.
canChangeReadonly: Boolean 
# Unique identifier of entity.
id: ID! 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# User who owns the online form.
owner: ClientEntity 
# Visual style applied to the form when rendered.
style: OnlineFormStyleEntity 
# When true, the embedded form JavaScript pre-fills fields from URL query 
# parameters on load.
autoPrefillWithJavascript: Boolean 
# Free-text description shown alongside the form definition in the UI.
description: String 
# API name of the custom entity the form targets. Set only when entityType is 
# CustomEntity; otherwise empty.
entityApiName: String 
# Entity the form is built for: its fields can be placed on the form and each 
# submission is linked to a record of this entity. For custom entities, 
# entityApiName identifies the custom entity.
entityType: BaseEntityTypeEnum! 
# Definition of the form layout (fields, sections, settings) shown to respondents, 
# as a JSON object conforming to the online-form layout schema. Validated on 
# write. This payload conforms to the `OnlineForm` JSON Schema: 
# https://api-doc.coevera.com/schemas/OnlineForm.json
formEdit: JSONString! 
# When true, the form is published and accepts new submissions; when false, the 
# form returns an error to respondents.
isEnabled: Boolean! 
# True when the form is system-managed and its schema cannot be edited by users.
isReadonly: Boolean! 
# Timestamp of the most recent change to formEdit (form schema).
lastSchemaChange: DateTime 
# Timestamp of the most recent change to isEnabled.
lastStatusChange: DateTime 
# Name of the entity and its default text representation.
name: String! 
# Tracks which threshold-reached notifications have already been sent for the 
# current form configuration. Reset when the configuration changes.
notificationsStatus: JSONString 
# Id of the owning user.
ownerId: ID! 
# Id of the form style.
styleId: ID! 
# Revision when entity was lastly changed.
revision: Int 
# Minimum response count required for the form to be considered "responsive" in 
# reports and notifications. Empty when no threshold is configured.
responseAcceptanceThreshold: Int 
# Total number of times the form link has been delivered to recipients.
sentCount: Int 
# Number of distinct recipients the form link has been delivered to.
sentUniqueCount: Int 
# Total number of submissions (responses) recorded for the form.
responseCount: Int 
# Fraction (0–1) of unique recipients who submitted a response.
responseRate: Float 
# Timestamp of the most recent submission. Empty when the form has no responses.
lastResponseDate: DateTime 
# Name or email address of the respondent on the most recent submission. Empty 
# when the form has no responses or the respondent could not be identified.
lastResponseBy: String 
# Solutions whose canvas contains this record. Deleted solutions are not included.
# 
# Arguments
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
solutions(before: String, after: String, first: Int, last: Int): SolutionEntityConnection 
# Submissions (one per response) recorded for this form.
# 
# Arguments
# filter: Filter OnlineForm relations by target OnlineForm 
# attributes.
# orderBy: Order OnlineForm relations by target OnlineForm 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
activityLogs(
filter: OnlineFormFilterInput,
orderBy: [OnlineFormOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): OnlineFormEntityConnection 
# Short identifier used in the public form URL (see link). Stable across the 
# lifetime of the form.
linkId: String! 
# Sum of response values used to evaluate the response acceptance threshold (e.g. 
# total responses, or evaluated value of the custom acceptance condition). Empty 
# when no threshold is configured.
summarizedResponseValues: Int 
# Public URL for accessing the form (suitable for sharing with respondents).
link: String 
# Overall state of the form: Inactive while it has no active configuration, Active 
# while accepting responses, Completed once the configured end condition is met.
status: ProcessStatusEnum 
# True when the form is configured with custom reCAPTCHA credentials; false when 
# using the platform default reCAPTCHA setup.
hasCustomRecaptcha: Boolean! 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Ids of all fields that appear in at least one submission of this form.
usedFieldIds: [ID!]! 
# Records the form was sent to or that responded to it, one item per record with 
# its send and response dates and number of responses.
# 
# Arguments
# category: Which records to list: those that responded, those 
# the form was sent to, those sent the form without responding, or responses not 
# linked to any record.
# sortBy: Column to sort by; the response or send date by 
# default, per category.
# sortOrder: Sort direction; descending by default.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
responseSummaries(
category: ResponseSummaryRelationCategory!,
sortBy: OnlineFormTypeDetailGridSortBy,
sortOrder: SortOrder,
before: String,
after: String,
first: Int,
last: Int
): OnlineFormResponseSummaryItemConnection 
# Submissions of this form with their answers.
# 
# Arguments
# filter: Conditions the submissions must match.
# sortBy: Column to sort by; the response date by default.
# sortByFieldId: Form field whose answers the submissions are 
# sorted by; required when `sortBy` is ResponseValue.
# sortOrder: Sort direction; descending by default.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
responses(
filter: FieldFilterParams,
sortBy: OnlineFormTypeDetailResponseGridSortBy,
sortByFieldId: ID,
sortOrder: SortOrder,
before: String,
after: String,
first: Int,
last: Int
): OnlineFormResponseItemConnection 
# Files uploaded through the submissions of this form.
# 
# Arguments
# filter: Conditions selecting the submissions whose files are 
# returned.
# fieldIds: Limits the files to those uploaded through these form 
# fields; all fields when omitted.
uploadedFiles(filter: OnlineFormFilterInput, fieldIds: [UUID!]): OnlineFormUploadedFiles! 
}
OnlineFormTypeEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
