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.
  • customFields(apiNames: [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.
  • isDeleteProtected: 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
  • # Currency exchange rate list applied to product line-items at submission time.
  • currencyExchangeRatesList: CurrencyExchangeRatesListEntity
  • # Email submitted with the response, used for identification or response
  • # notifications.
  • email: EmailEntity
  • # Online form definition this submission belongs to.
  • onlineFormType: OnlineFormTypeEntity
  • # Currency selected by the respondent for product line-items, when the form
  • # contains products.
  • productCurrency: CurrencyEntity
  • # Product price list selected by the respondent, when the form contains products.
  • productPriceList: ProductPriceListEntity
  • # Id of the currency exchange rate list applied to product line items at
  • # submission time.
  • currencyExchangeRatesListId: ID
  • # Id of the linked email record, when available.
  • emailId: ID
  • # Ids of the fields included in the form when this submission was captured, as a
  • # JSON array of field ids (UUIDs).
  • fieldIds: JSONString!
  • # Id of the online form definition.
  • onlineFormTypeId: ID!
  • # Id of the selected currency.
  • productCurrencyId: ID
  • # Id of the selected price list.
  • productPriceListId: ID
  • # Overall result of processing the submission: the most severe status among its
  • # activity log lines, Error when a step failed.
  • status: ProcessStatusEnum
  • # Revision when entity was lastly changed.
  • revision: 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.
  • accountRelations(
  • filter: AccountFilterInput,
  • filterEdge: OnlineFormRelationFilterInput,
  • orderBy: [AccountOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • contactRelations(
  • filter: ContactFilterInput,
  • filterEdge: OnlineFormRelationFilterInput,
  • orderBy: [ContactOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • leadRelations(
  • filter: LeadFilterInput,
  • filterEdge: OnlineFormRelationFilterInput,
  • orderBy: [LeadOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • opportunityRelations(
  • filter: OpportunityFilterInput,
  • filterEdge: OnlineFormRelationFilterInput,
  • orderBy: [OpportunityOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • quoteRelations(
  • filter: QuoteFilterInput,
  • filterEdge: OnlineFormRelationFilterInput,
  • orderBy: [QuoteOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • projectRelations(
  • filter: ProjectFilterInput,
  • filterEdge: OnlineFormRelationFilterInput,
  • orderBy: [ProjectOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • customEntityRelations(
  • filter: CustomEntityFilterInput,
  • filterEdge: OnlineFormRelationFilterInput,
  • orderBy: [CustomEntityOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • lines(
  • filter: OnlineFormActivityLogLineFilterInput,
  • orderBy: [OnlineFormActivityLogLineOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): OnlineFormActivityLogLineEntityConnection
  • # Display name of the primary record (account/contact/lead/...) the submission was
  • # linked to.
  • respondedBy: String!
  • # Timestamp the submission was received (the response was completed).
  • responseDate: 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.
  • recordName: 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.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Answers given in this submission, one item per form field, formatted.
  • answers: [OnlineFormFieldAnswer!]!
  • # Primary record of the submission when it is an account.
  • primaryAccount: AccountEntity
  • # Primary record of the submission when it is a contact.
  • primaryContact: ContactEntity
  • # Primary record of the submission when it is a lead.
  • primaryLead: LeadEntity
  • # Primary record of the submission when it is an opportunity.
  • primaryOpportunity: OpportunityEntity
  • # Primary record of the submission when it is a quote.
  • primaryQuote: QuoteEntity
  • # Primary record of the submission when it is a custom entity record.
  • primaryCustomEntity: CustomEntityEntity
  • # Id of the primary record of the submission when it is an account.
  • primaryAccountId: ID
  • # Id of the primary record of the submission when it is a contact.
  • primaryContactId: ID
  • # Id of the primary record of the submission when it is a lead or opportunity.
  • primaryLeadOpptyId: ID
  • # Id of the primary record of the submission when it is a quote.
  • primaryQuoteId: ID
  • # Id of the primary record of the submission when it is a custom entity record.
  • primaryCustomEntityId: ID
  • }