OBJECT
OnlineFormEntity
Submission (response) of an online form, with the answers and the records it created or updated.
link GraphQL Schema definition
- type OnlineFormEntity {
- # Values of the record's custom fields as a JSON object keyed by custom field
- # apiName (camelCase).
- #
- # Arguments
- # apiNames: Api names of custom fields to retrieve. All are
- # returned if not set.
- (: [String!]): JSONString!
- # 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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # Currency exchange rate list applied to product line-items at submission time.
- : CurrencyExchangeRatesListEntity
- # Email submitted with the response, used for identification or response
- # notifications.
- : EmailEntity
- # Online form definition this submission belongs to.
- : OnlineFormTypeEntity
- # Currency selected by the respondent for product line-items, when the form
- # contains products.
- : CurrencyEntity
- # Product price list selected by the respondent, when the form contains products.
- : ProductPriceListEntity
- # Id of the currency exchange rate list applied to product line items at
- # submission time.
- : ID
- # Id of the linked email record, when available.
- : ID
- # Ids of the fields included in the form when this submission was captured, as a
- # JSON array of field ids (UUIDs).
- : JSONString!
- # Id of the online form definition.
- : ID!
- # Id of the selected currency.
- : ID
- # Id of the selected price list.
- : ID
- # Overall result of processing the submission: the most severe status among its
- # activity log lines, Error when a step failed.
- : ProcessStatusEnum
- # Revision when entity was lastly changed.
- : Int
- # Accounts the submission was linked to.
- #
- # Arguments
- # filter: Filter Account relations by target Account attributes.
- # filterEdge: Filter OnlineFormRelation relations by edge
- # (relation) OnlineFormRelation attributes.
- # orderBy: Order Account relations by target Account 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.
- (
- : AccountFilterInput,
- : OnlineFormRelationFilterInput,
- : [AccountOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormRelationEntityConnection
- # Contacts the submission was linked to.
- #
- # Arguments
- # filter: Filter Contact relations by target Contact attributes.
- # filterEdge: Filter OnlineFormRelation relations by edge
- # (relation) OnlineFormRelation attributes.
- # orderBy: Order Contact relations by target Contact 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.
- (
- : ContactFilterInput,
- : OnlineFormRelationFilterInput,
- : [ContactOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormRelationEntityConnection
- # Leads the submission was linked to.
- #
- # Arguments
- # filter: Filter Lead relations by target Lead attributes.
- # filterEdge: Filter OnlineFormRelation relations by edge
- # (relation) OnlineFormRelation attributes.
- # orderBy: Order Lead relations by target Lead 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.
- (
- : LeadFilterInput,
- : OnlineFormRelationFilterInput,
- : [LeadOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormRelationEntityConnection
- # Opportunities the submission was linked to.
- #
- # Arguments
- # filter: Filter Opportunity relations by target Opportunity
- # attributes.
- # filterEdge: Filter OnlineFormRelation relations by edge
- # (relation) OnlineFormRelation attributes.
- # orderBy: Order Opportunity relations by target Opportunity
- # 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.
- (
- : OpportunityFilterInput,
- : OnlineFormRelationFilterInput,
- : [OpportunityOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormRelationEntityConnection
- # Quotes the submission was linked to.
- #
- # Arguments
- # filter: Filter Quote relations by target Quote attributes.
- # filterEdge: Filter OnlineFormRelation relations by edge
- # (relation) OnlineFormRelation attributes.
- # orderBy: Order Quote relations by target Quote 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.
- (
- : QuoteFilterInput,
- : OnlineFormRelationFilterInput,
- : [QuoteOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormRelationEntityConnection
- # Projects the submission was linked to.
- #
- # Arguments
- # filter: Filter Project relations by target Project attributes.
- # filterEdge: Filter OnlineFormRelation relations by edge
- # (relation) OnlineFormRelation attributes.
- # orderBy: Order Project relations by target Project 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.
- (
- : ProjectFilterInput,
- : OnlineFormRelationFilterInput,
- : [ProjectOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormRelationEntityConnection
- # Custom entity records the submission was linked to.
- #
- # Arguments
- # filter: Filter CustomEntity relations by target CustomEntity
- # attributes.
- # filterEdge: Filter OnlineFormRelation relations by edge
- # (relation) OnlineFormRelation attributes.
- # orderBy: Order CustomEntity relations by target CustomEntity
- # 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.
- (
- : CustomEntityFilterInput,
- : OnlineFormRelationFilterInput,
- : [CustomEntityOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormRelationEntityConnection
- # Activity log lines describing what was done with this submission (visible only).
- #
- # Arguments
- # filter: Filter OnlineFormActivityLogLine relations by target
- # OnlineFormActivityLogLine attributes.
- # orderBy: Order OnlineFormActivityLogLine relations by target
- # OnlineFormActivityLogLine 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.
- (
- : OnlineFormActivityLogLineFilterInput,
- : [OnlineFormActivityLogLineOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): OnlineFormActivityLogLineEntityConnection
- # Display name of the primary record (account/contact/lead/...) the submission was
- # linked to.
- : String!
- # Timestamp the submission was received (the response was completed).
- : DateTime
- # Display name of the record that submitted (or is associated with) this form
- # response, formatted according to the calling user's preferred name format.
- : String
- # 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.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- # Answers given in this submission, one item per form field, formatted.
- : [OnlineFormFieldAnswer!]!
- # Primary record of the submission when it is an account.
- : AccountEntity
- # Primary record of the submission when it is a contact.
- : ContactEntity
- # Primary record of the submission when it is a lead.
- : LeadEntity
- # Primary record of the submission when it is an opportunity.
- : OpportunityEntity
- # Primary record of the submission when it is a quote.
- : QuoteEntity
- # Primary record of the submission when it is a custom entity record.
- : CustomEntityEntity
- # Id of the primary record of the submission when it is an account.
- : ID
- # Id of the primary record of the submission when it is a contact.
- : ID
- # Id of the primary record of the submission when it is a lead or opportunity.
- : ID
- # Id of the primary record of the submission when it is a quote.
- : ID
- # Id of the primary record of the submission when it is a custom entity record.
- : ID
- }
link Require by
- CloudObjectRelationEntityAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
- CreateOnlineFormPayloadResult of the createOnlineForm mutation.
- DeleteOnlineFormPayloadResult of the deleteOnlineForm mutation.
- OnlineFormActivityLogLineEntityOne step logged while processing an online form submission.
- OnlineFormDataExRelationEntityOption selected in a multi-select checkbox field of an online form submission.
- OnlineFormEntityEdgeA Relay edge containing a `OnlineFormEntity` and its cursor.
- OnlineFormRelationEntityLink between an online form submission and a record it created or updated.
- OnlineFormRepositoryRead operations for OnlineForm records.
- OpptyProductRelationEntityProduct line item on an opportunity or quote, with its quantity, price and discount.
- SolutionActivityLogEntityOne entry in a solution's activity log: an Automatizer process run, an email-sequence run or an online-form submission.
- UpdateOnlineFormPayloadResult of the updateOnlineForm mutation.