GraphQL RepositoriesonlineFormRelation

`entities.onlineFormRelation`

Read online form relation records with the onlineFormRelation repository, and change them with the online form relation mutations. Same records as the REST OnlineFormRelations entity.

Example: first three online form relation recordsGraphQLcURL

query FirstOnlineFormRelations {
  entities {
    onlineFormRelation {
      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 FirstOnlineFormRelations { entities { onlineFormRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { onlineFormRelation { … } }.

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.	OnlineFormRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[OnlineFormRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: OnlineFormRelationFilterInput, orderBy: [OnlineFormRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[OnlineFormRelationEntity!]!
QUERY	`getByCriteria`(filter: OnlineFormRelationFilterInput, orderBy: [OnlineFormRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	OnlineFormRelationEntityConnection
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!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createOnlineFormRelation`(input: CreateOnlineFormRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateOnlineFormRelationPayload
MUTATION	`updateOnlineFormRelation`(input: UpdateOnlineFormRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateOnlineFormRelationPayload
MUTATION	`bulkUpdateOnlineFormRelation`(input: [CreateOrUpdateOnlineFormRelationInput!]!, deleteInput: [DeleteOnlineFormRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateOnlineFormRelationPayload
MUTATION	`deleteOnlineFormRelation`(input: DeleteOnlineFormRelationInput!)	Soft-delete	DeleteOnlineFormRelationPayload

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.

OnlineFormRelationEntity object 23 fields: isDeleteProtected, id, isDeleted, …

Link between an online form submission and a record it created or updated.

Field	Type	Description
`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.
`account`	AccountEntity	Account the submission is linked to, when applicable.
`contact`	ContactEntity	Contact the submission is linked to, when applicable.
`customEntity`	CustomEntityEntity	Custom entity record the submission is linked to, when applicable.
`lead`	LeadEntity	Lead the submission is linked to. Set when leadOpptyId resolves to a Lead.
`oppty`	OpportunityEntity	Opportunity the submission is linked to. Set when leadOpptyId resolves to an Opportunity.
`onlineForm`	OnlineFormEntity	Online form submission being linked.
`project`	ProjectEntity	Project the submission is linked to, when applicable.
`quote`	QuoteEntity	Quote the submission is linked to, when applicable.
`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.
`onlineFormId`	ID!	Id of the submission.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

OnlineFormRelationEntityConnection object pageInfo: PageInfo!, edges: [OnlineFormRelationEntityEdge]!, totalCount: Int

Paginated list of OnlineFormRelation records.

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

OnlineFormRelationEntityEdge object node: OnlineFormRelationEntity, cursor: String!

A Relay edge containing a OnlineFormRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[OnlineFormRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[OnlineFormRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	OnlineFormRelationFilterInput	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.
`accountId`	EntityFilterStringField	Id of the linked account.
`contactId`	EntityFilterStringField	Id of the linked contact.
`customEntityId`	EntityFilterStringField	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`	EntityFilterStringField	Id of the linked lead or opportunity, or empty when not linked.
`onlineFormId`	EntityFilterStringField	Id of the submission.
`projectId`	EntityFilterStringField	Id of the linked project.
`quoteId`	EntityFilterStringField	Id of the linked quote.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`account`	AccountFilterInput	Account the submission is linked to, when applicable. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Contact the submission is linked to, when applicable. Matches records where a related record meets these conditions.
`customEntity`	CustomEntityFilterInput	Custom entity record the submission is linked to, when applicable. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead the submission is linked to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity the submission is linked to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions.
`onlineForm`	OnlineFormFilterInput	Online form submission being linked. Matches records where a related record meets these conditions.
`project`	ProjectFilterInput	Project the submission is linked to, when applicable. Matches records where a related record meets these conditions.
`quote`	QuoteFilterInput	Quote the submission is linked to, when applicable. Matches records where a related record meets these conditions.

OnlineFormRelationOrderByInput input Asc or Desc per field

Sorting of OnlineFormRelation 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.
`account`	[AccountOrderByNestedInput!]	Account the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Contact the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`customEntity`	[CustomEntityOrderByNestedInput!]	Custom entity record the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead the submission is linked to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity the submission is linked to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority.
`onlineForm`	[OnlineFormOrderByNestedInput!]	Online form submission being linked. Sorts by fields of the related record, listed in order of priority.
`project`	[ProjectOrderByNestedInput!]	Project the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`quote`	[QuoteOrderByNestedInput!]	Quote the submission is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`accountId`	OrderByEnum	Id of the linked account.
`contactId`	OrderByEnum	Id of the linked contact.
`customEntityId`	OrderByEnum	Id of the linked custom entity record.
`isPrimary`	OrderByEnum	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`	OrderByEnum	Id of the linked lead or opportunity, or empty when not linked.
`onlineFormId`	OrderByEnum	Id of the submission.
`projectId`	OrderByEnum	Id of the linked project.
`quoteId`	OrderByEnum	Id of the linked quote.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOnlineFormRelationInput input 12 fields: clientMutationId, modified, created, …

Field values of a new OnlineFormRelation 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.
`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.
`onlineFormId`	ID!	Id of the submission.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateOnlineFormRelationInput input 13 fields: clientMutationId, id, modified, …

Field values of an OnlineFormRelation 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.
`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.
`onlineFormId`	ID	Id of the submission.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.

DeleteOnlineFormRelationInput input clientMutationId: String, id: ID!, leadOpptyId: ID

Id of the OnlineFormRelation 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.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not linked.

UpdateOnlineFormRelationInput input 13 fields: clientMutationId, id, modified, …

Id of an OnlineFormRelation 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.
`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.
`onlineFormId`	ID	Id of the submission.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateOnlineFormRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateOnlineFormRelation mutation.

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

CreateOnlineFormRelationPayload object onlineFormRelation: OnlineFormRelationEntity, clientMutationId: String

Result of the createOnlineFormRelation mutation.

Field	Type	Description
`onlineFormRelation`	OnlineFormRelationEntity	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).

DeleteOnlineFormRelationPayload object onlineFormRelation: OnlineFormRelationEntity, clientMutationId: String

Result of the deleteOnlineFormRelation mutation.

Field	Type	Description
`onlineFormRelation`	OnlineFormRelationEntity	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).

UpdateOnlineFormRelationPayload object onlineFormRelation: OnlineFormRelationEntity, clientMutationId: String

Result of the updateOnlineFormRelation mutation.

Field	Type	Description
`onlineFormRelation`	OnlineFormRelationEntity	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).