OBJECT
OnlineFormTypeEntity

GraphQL Schema definition

type OnlineFormTypeEntity {
hasDraft: Boolean 
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
isDeleteProtected: Boolean! 
formEditApi: OnlineForm 
#   Returns if user can change readonly flag on this entity_type.
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 entity_type is 
#   CustomEntity; otherwise empty.
entityApiName: String 
#   Field whose values are strictly defined with an enumeration of values.
entityType: BaseEntityTypeEnum! 
#   JSON definition of the form layout (fields, sections, settings) shown to 
#   respondents.
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 form_edit (form schema).
lastSchemaChange: DateTime 
#   Timestamp of the most recent change to is_enabled.
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 
#   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! 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
usedFieldIds: [ID!]! 
# Arguments
#   category: [Not documented]
#   sortBy: [Not documented]
#   sortOrder: [Not documented]
#   before: [Not documented]
#   after: [Not documented]
#   first: [Not documented]
#   last: [Not documented]
responseSummaries(
category: ResponseSummaryRelationCategory!,
sortBy: OnlineFormTypeDetailGridSortBy,
sortOrder: SortOrder,
before: String,
after: String,
first: Int,
last: Int
): OnlineFormResponseSummaryItemConnection 
# Arguments
#   filter: [Not documented]
#   sortBy: [Not documented]
#   sortByFieldId: [Not documented]
#   sortOrder: [Not documented]
#   before: [Not documented]
#   after: [Not documented]
#   first: [Not documented]
#   last: [Not documented]
responses(
filter: FieldFilterParams,
sortBy: OnlineFormTypeDetailResponseGridSortBy,
sortByFieldId: ID,
sortOrder: SortOrder,
before: String,
after: String,
first: Int,
last: Int
): OnlineFormResponseItemConnection 
# Arguments
#   filter: [Not documented]
#   fieldIds: [Not documented]
uploadedFiles(filter: OnlineFormFilterInput, fieldIds: [UUID!]): OnlineFormUploadedFiles! 
}
OnlineFormTypeEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
