GraphQL RepositoriesonlineForm

`entities.onlineForm`

Read online form records with the onlineForm repository, and change them with the online form mutations. Same records as the REST OnlineForms entity.

Example: first three online form recordsGraphQLcURL

query FirstOnlineForms {
  entities {
    onlineForm {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstOnlineForms { entities { onlineForm { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { onlineForm { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	OnlineFormEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[OnlineFormEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: OnlineFormFilterInput, orderBy: [OnlineFormOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[OnlineFormEntity!]!
QUERY	`getByCriteria`(filter: OnlineFormFilterInput, orderBy: [OnlineFormOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	OnlineFormEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!
QUERY	`getBySession`(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int) Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.	OnlineFormEntityConnection
QUERY	`getByIdFormatted`(id: UUID!, fieldIds: [UUID!]) Returns the values of a record's fields formatted for display, keyed by field id.	JSONString
QUERY	`getDownloadUrl`(onlineFormType: UUID!, name: String!, filter: OnlineFormFilterInput, days: Int) Exports the submission log of an online form to a zipped text file and returns a URL to download it.	String!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createOnlineForm`(input: CreateOnlineFormInput!, validationLevel: [ValidationLevel!])	Create one record	CreateOnlineFormPayload
MUTATION	`updateOnlineForm`(input: UpdateOnlineFormInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateOnlineFormPayload
MUTATION	`bulkUpdateOnlineForm`(input: [CreateOrUpdateOnlineFormInput!]!, deleteInput: [DeleteOnlineFormInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateOnlineFormPayload
MUTATION	`deleteOnlineForm`(input: DeleteOnlineFormInput!)	Soft-delete	DeleteOnlineFormPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

OnlineFormEntity object 43 fields: customFields, isDeleteProtected, id, …

Submission (response) of an online form, with the answers and the records it created or updated.

Field	Type	Description
`customFields`	JSONString! (1 args)	Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
`isDeleteProtected`	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.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`currencyExchangeRatesList`	CurrencyExchangeRatesListEntity	Currency exchange rate list applied to product line-items at submission time.
`email`	EmailEntity	Email submitted with the response, used for identification or response notifications.
`onlineFormType`	OnlineFormTypeEntity	Online form definition this submission belongs to.
`productCurrency`	CurrencyEntity	Currency selected by the respondent for product line-items, when the form contains products.
`productPriceList`	ProductPriceListEntity	Product price list selected by the respondent, when the form contains products.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to product line items at submission time.
`emailId`	ID	Id of the linked email record, when available.
`fieldIds`	JSONString!	Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs).
`onlineFormTypeId`	ID!	Id of the online form definition.
`productCurrencyId`	ID	Id of the selected currency.
`productPriceListId`	ID	Id of the selected price list.
`status`	ProcessStatusEnum	Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.
`revision`	Int	Revision when entity was lastly changed.
`accountRelations`	OnlineFormRelationEntityConnection (8 args)	Accounts the submission was linked to.
`contactRelations`	OnlineFormRelationEntityConnection (8 args)	Contacts the submission was linked to.
`leadRelations`	OnlineFormRelationEntityConnection (8 args)	Leads the submission was linked to.
`opportunityRelations`	OnlineFormRelationEntityConnection (8 args)	Opportunities the submission was linked to.
`quoteRelations`	OnlineFormRelationEntityConnection (8 args)	Quotes the submission was linked to.
`projectRelations`	OnlineFormRelationEntityConnection (8 args)	Projects the submission was linked to.
`customEntityRelations`	OnlineFormRelationEntityConnection (8 args)	Custom entity records the submission was linked to.
`lines`	OnlineFormActivityLogLineEntityConnection (7 args)	Activity log lines describing what was done with this submission (visible only).
`respondedBy`	String!	Display name of the primary record (account/contact/lead/...) the submission was linked to.
`responseDate`	DateTime	Timestamp the submission was received (the response was completed).
`recordName`	String	Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.
`answers`	[OnlineFormFieldAnswer!]!	Answers given in this submission, one item per form field, formatted.
`primaryAccount`	AccountEntity	Primary record of the submission when it is an account.
`primaryContact`	ContactEntity	Primary record of the submission when it is a contact.
`primaryLead`	LeadEntity	Primary record of the submission when it is a lead.
`primaryOpportunity`	OpportunityEntity	Primary record of the submission when it is an opportunity.
`primaryQuote`	QuoteEntity	Primary record of the submission when it is a quote.
`primaryCustomEntity`	CustomEntityEntity	Primary record of the submission when it is a custom entity record.
`primaryAccountId`	ID	Id of the primary record of the submission when it is an account.
`primaryContactId`	ID	Id of the primary record of the submission when it is a contact.
`primaryLeadOpptyId`	ID	Id of the primary record of the submission when it is a lead or opportunity.
`primaryQuoteId`	ID	Id of the primary record of the submission when it is a quote.
`primaryCustomEntityId`	ID	Id of the primary record of the submission when it is a custom entity record.

OnlineFormEntityConnection object pageInfo: PageInfo!, edges: [OnlineFormEntityEdge]!, totalCount: Int

Paginated list of OnlineForm records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[OnlineFormEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

OnlineFormEntityEdge object node: OnlineFormEntity, cursor: String!

A Relay edge containing a OnlineFormEntity and its cursor.

Field	Type	Description
`node`	OnlineFormEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

OnlineFormFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for OnlineForm records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[OnlineFormFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[OnlineFormFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	OnlineFormFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`currencyExchangeRatesListId`	EntityFilterStringField	Id of the currency exchange rate list applied to product line items at submission time.
`emailId`	EntityFilterStringField	Id of the linked email record, when available.
`onlineFormTypeId`	EntityFilterStringField	Id of the online form definition.
`productCurrencyId`	EntityFilterStringField	Id of the selected currency.
`productPriceListId`	EntityFilterStringField	Id of the selected price list.
`status`	ProcessStatusEnumFilterInput	Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`recordName`	EntityFilterStringField	Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format.
`withCustom`	[CustomField!]	Conditions on custom fields, each identified by its api name. All listed conditions must match.
`currencyExchangeRatesList`	CurrencyExchangeRatesListFilterInput	Currency exchange rate list applied to product line-items at submission time. Matches records where a related record meets these conditions.
`email`	EmailFilterInput	Email submitted with the response, used for identification or response notifications. Matches records where a related record meets these conditions.
`onlineFormType`	OnlineFormTypeFilterInput	Online form definition this submission belongs to. Matches records where a related record meets these conditions.
`productCurrency`	CurrencyFilterInput	Currency selected by the respondent for product line-items, when the form contains products. Matches records where a related record meets these conditions.
`productPriceList`	ProductPriceListFilterInput	Product price list selected by the respondent, when the form contains products. Matches records where a related record meets these conditions.
`accountRelations`	OnlineFormRelationFilterInput	Accounts the submission was linked to. Matches records where a related record meets these conditions.
`contactRelations`	OnlineFormRelationFilterInput	Contacts the submission was linked to. Matches records where a related record meets these conditions.
`leadRelations`	OnlineFormRelationFilterInput	Leads the submission was linked to. Matches records where a related record meets these conditions.
`opportunityRelations`	OnlineFormRelationFilterInput	Opportunities the submission was linked to. Matches records where a related record meets these conditions.
`quoteRelations`	OnlineFormRelationFilterInput	Quotes the submission was linked to. Matches records where a related record meets these conditions.
`projectRelations`	OnlineFormRelationFilterInput	Projects the submission was linked to. Matches records where a related record meets these conditions.
`customEntityRelations`	OnlineFormRelationFilterInput	Custom entity records the submission was linked to. Matches records where a related record meets these conditions.
`lines`	OnlineFormActivityLogLineFilterInput	Activity log lines describing what was done with this submission (visible only). Matches records where a related record meets these conditions.

OnlineFormOrderByInput input Asc or Desc per field

Sorting of OnlineForm records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`currencyExchangeRatesList`	[CurrencyExchangeRatesListOrderByNestedInput!]	Currency exchange rate list applied to product line-items at submission time. Sorts by fields of the related record, listed in order of priority.
`email`	[EmailOrderByNestedInput!]	Email submitted with the response, used for identification or response notifications. Sorts by fields of the related record, listed in order of priority.
`onlineFormType`	[OnlineFormTypeOrderByNestedInput!]	Online form definition this submission belongs to. Sorts by fields of the related record, listed in order of priority.
`productPriceList`	[ProductPriceListOrderByNestedInput!]	Product price list selected by the respondent, when the form contains products. Sorts by fields of the related record, listed in order of priority.
`currencyExchangeRatesListId`	OrderByEnum	Id of the currency exchange rate list applied to product line items at submission time.
`emailId`	OrderByEnum	Id of the linked email record, when available.
`onlineFormTypeId`	OrderByEnum	Id of the online form definition.
`productPriceListId`	OrderByEnum	Id of the selected price list.
`status`	OrderByEnum	Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.
`revision`	OrderByEnum	Revision when entity was lastly changed.
`recordName`	OrderByEnum	Display name of the record that submitted (or is associated with) this form response, formatted according to the calling user's preferred name format.
`withCustom`	CommonEntityRepositoryOrderByCustomField	Sorts by a custom field.

CreateOnlineFormInput input 19 fields: clientMutationId, modified, created, …

Field values of a new OnlineForm record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to product line items at submission time.
`emailId`	ID	Id of the linked email record, when available.
`fieldIds`	JSONString!	Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs).
`onlineFormTypeId`	ID!	Id of the online form definition.
`productCurrencyId`	ID	Id of the selected currency.
`productPriceListId`	ID	Id of the selected price list.
`status`	ProcessStatusEnum	Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.
`customFields`	JSONString	Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
`revision`	Int	Revision when entity was lastly changed.
`accountRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Accounts the submission was linked to.
`contactRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Contacts the submission was linked to.
`leadRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Leads the submission was linked to.
`opportunityRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Opportunities the submission was linked to.
`quoteRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Quotes the submission was linked to.
`projectRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Projects the submission was linked to.
`customEntityRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Custom entity records the submission was linked to.

CreateOnlineFormRelationNoOnlineFormBackrefInput input 10 fields: modified, created, accountId, …

Field values of a new OnlineFormRelation record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`accountId`	ID	Id of the linked account.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`isPrimary`	Boolean!	True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entityType.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not linked.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateOnlineFormInput input 20 fields: clientMutationId, id, modified, …

Field values of an OnlineForm record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to product line items at submission time.
`emailId`	ID	Id of the linked email record, when available.
`fieldIds`	JSONString	Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs).
`onlineFormTypeId`	ID	Id of the online form definition.
`productCurrencyId`	ID	Id of the selected currency.
`productPriceListId`	ID	Id of the selected price list.
`status`	ProcessStatusEnum	Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.
`customFields`	JSONString	Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
`revision`	Int	Revision when entity was lastly changed.
`accountRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Accounts the submission was linked to.
`contactRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Contacts the submission was linked to.
`leadRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Leads the submission was linked to.
`opportunityRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Opportunities the submission was linked to.
`quoteRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Quotes the submission was linked to.
`projectRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Projects the submission was linked to.
`customEntityRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Custom entity records the submission was linked to.

DeleteOnlineFormInput input clientMutationId: String, id: ID!

Id of the OnlineForm record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateOnlineFormInput input 20 fields: clientMutationId, id, modified, …

Id of an OnlineForm record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to product line items at submission time.
`emailId`	ID	Id of the linked email record, when available.
`fieldIds`	JSONString	Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs).
`onlineFormTypeId`	ID	Id of the online form definition.
`productCurrencyId`	ID	Id of the selected currency.
`productPriceListId`	ID	Id of the selected price list.
`status`	ProcessStatusEnum	Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.
`customFields`	JSONString	Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
`revision`	Int	Revision when entity was lastly changed.
`accountRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Accounts the submission was linked to.
`contactRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Contacts the submission was linked to.
`leadRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Leads the submission was linked to.
`opportunityRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Opportunities the submission was linked to.
`quoteRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Quotes the submission was linked to.
`projectRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Projects the submission was linked to.
`customEntityRelations`	[CreateOnlineFormRelationNoOnlineFormBackrefInput!]	Custom entity records the submission was linked to.

BulkUpdateOnlineFormPayload object result: BulkUpdateResults!

Result of the bulkUpdateOnlineForm mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateOnlineFormPayload object onlineForm: OnlineFormEntity, clientMutationId: String

Result of the createOnlineForm mutation.

Field	Type	Description
`onlineForm`	OnlineFormEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteOnlineFormPayload object onlineForm: OnlineFormEntity, clientMutationId: String

Result of the deleteOnlineForm mutation.

Field	Type	Description
`onlineForm`	OnlineFormEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateOnlineFormPayload object onlineForm: OnlineFormEntity, clientMutationId: String

Result of the updateOnlineForm mutation.

Field	Type	Description
`onlineForm`	OnlineFormEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

OnlineFormFieldAnswer object id: String!, value: String

Answer to one question of an online form submission.

Field	Type	Description
`id`	String!	Id of the form field the answer belongs to.
`value`	String	Answer as text: option labels for choice fields, a download URL for uploaded files; null when not answered.