GraphQL RepositoriesformView

`entities.formView`

Read form view records with the formView repository, and change them with the form view mutations. Same records as the REST FormViews entity.

Example: first three form view recordsGraphQLcURL

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

Queries

Fields of entities { formView { … } }.

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.	FormViewEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[FormViewEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: FormViewFilterInput, orderBy: [FormViewOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[FormViewEntity!]!
QUERY	`getByCriteria`(filter: FormViewFilterInput, orderBy: [FormViewOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	FormViewEntityConnection
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	`createFormView`(input: CreateFormViewInput!, validationLevel: [ValidationLevel!])	Create one record	CreateFormViewPayload
MUTATION	`updateFormView`(input: UpdateFormViewInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateFormViewPayload
MUTATION	`bulkUpdateFormView`(input: [CreateOrUpdateFormViewInput!]!, deleteInput: [DeleteFormViewInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateFormViewPayload
MUTATION	`deleteFormView`(input: DeleteFormViewInput!)	Soft-delete	DeleteFormViewPayload

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.

FormViewEntity object 25 fields: isDeleteProtected, id, isDeleted, …

Variant of the form of an account, contact, lead or opportunity type that hides or colors selected fields; owned by a user and can be shared.

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.
`accountType`	AccountTypeEntity	Account type the form view applies to. Set when the form view targets accounts.
`contactType`	ContactTypeEntity	Contact type the form view applies to. Set when the form view targets contacts.
`leadType`	LeadTypeEntity	Lead type the form view applies to. Set when the form view targets leads.
`opptyType`	OpportunityTypeEntity	Opportunity type the form view applies to. Set when the form view targets opportunities.
`owner`	ClientEntity	User who owns the form view.
`accountTypeId`	ID	Id of the account type the form view applies to. Set when the form view targets accounts.
`contactTypeId`	ID	Id of the contact type the form view applies to. Set when the form view targets contacts.
`hiddenItemIds`	[UUID!]!	Ids of fields and webresources hidden from the form for this view.
`itemColors`	[FormViewItemColor!]!	Per-item color overrides for fields and webresources in the form, keyed by item id.
`leadTypeId`	ID	Id of the lead type the form view applies to. Set when the form view targets leads.
`name`	String!	Name of the entity and its default text representation.
`opptyTypeId`	ID	Id of the opportunity type.
`ownerId`	ID!	Id of the owning user.
`shareMode`	ShareModeEnum	Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit).
`useLang`	Boolean	When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.
`entityTypeId`	UUID!	Id of the type the form view is configured for, derived from whichever of the per-entity-type relations is set.
`sharingUnits`	FormViewSharingSalesUnitRelationEntityConnection (8 args)	Sales units that have been granted shared access to this form view (custom share mode).
`sharingClients`	FormViewSharingClientRelationEntityConnection (8 args)	Users that have been granted shared access to this form view (custom share mode).
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

FormViewEntityConnection object pageInfo: PageInfo!, edges: [FormViewEntityEdge]!, totalCount: Int

Paginated list of FormView records.

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

FormViewEntityEdge object node: FormViewEntity, cursor: String!

A Relay edge containing a FormViewEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[FormViewFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[FormViewFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	FormViewFilterInput	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.
`accountTypeId`	EntityFilterStringField	Id of the account type the form view applies to. Set when the form view targets accounts.
`contactTypeId`	EntityFilterStringField	Id of the contact type the form view applies to. Set when the form view targets contacts.
`leadTypeId`	EntityFilterStringField	Id of the lead type the form view applies to. Set when the form view targets leads.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`opptyTypeId`	EntityFilterStringField	Id of the opportunity type.
`ownerId`	EntityFilterStringField	Id of the owning user.
`shareMode`	ShareModeEnumFilterInput	Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit).
`useLang`	Boolean	When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`accountType`	AccountTypeFilterInput	Account type the form view applies to. Set when the form view targets accounts. Matches records where a related record meets these conditions.
`contactType`	ContactTypeFilterInput	Contact type the form view applies to. Set when the form view targets contacts. Matches records where a related record meets these conditions.
`leadType`	LeadTypeFilterInput	Lead type the form view applies to. Set when the form view targets leads. Matches records where a related record meets these conditions.
`opptyType`	OpportunityTypeFilterInput	Opportunity type the form view applies to. Set when the form view targets opportunities. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	User who owns the form view. Matches records where a related record meets these conditions.
`sharingUnits`	FormViewSharingSalesUnitRelationFilterInput	Sales units that have been granted shared access to this form view (custom share mode). Matches records where a related record meets these conditions.
`sharingClients`	FormViewSharingClientRelationFilterInput	Users that have been granted shared access to this form view (custom share mode). Matches records where a related record meets these conditions.

FormViewOrderByInput input Asc or Desc per field

Sorting of FormView 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.
`accountType`	[AccountTypeOrderByNestedInput!]	Account type the form view applies to. Set when the form view targets accounts. Sorts by fields of the related record, listed in order of priority.
`contactType`	[ContactTypeOrderByNestedInput!]	Contact type the form view applies to. Set when the form view targets contacts. Sorts by fields of the related record, listed in order of priority.
`leadType`	[LeadTypeOrderByNestedInput!]	Lead type the form view applies to. Set when the form view targets leads. Sorts by fields of the related record, listed in order of priority.
`opptyType`	[OpportunityTypeOrderByNestedInput!]	Opportunity type the form view applies to. Set when the form view targets opportunities. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	User who owns the form view. Sorts by fields of the related record, listed in order of priority.
`accountTypeId`	OrderByEnum	Id of the account type the form view applies to. Set when the form view targets accounts.
`contactTypeId`	OrderByEnum	Id of the contact type the form view applies to. Set when the form view targets contacts.
`leadTypeId`	OrderByEnum	Id of the lead type the form view applies to. Set when the form view targets leads.
`name`	OrderByEnum	Name of the entity and its default text representation.
`opptyTypeId`	OrderByEnum	Id of the opportunity type.
`ownerId`	OrderByEnum	Id of the owning user.
`shareMode`	OrderByEnum	Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit).
`useLang`	OrderByEnum	When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateFormViewInput input 16 fields: clientMutationId, modified, created, …

Field values of a new FormView 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.
`accountTypeId`	ID	Id of the account type the form view applies to. Set when the form view targets accounts.
`contactTypeId`	ID	Id of the contact type the form view applies to. Set when the form view targets contacts.
`hiddenItemIds`	[UUID!]!	Ids of fields and webresources hidden from the form for this view.
`itemColors`	[FormViewItemColorInput!]!	Per-item color overrides for fields and webresources in the form, keyed by item id.
`leadTypeId`	ID	Id of the lead type the form view applies to. Set when the form view targets leads.
`name`	String!	Name of the entity and its default text representation.
`opptyTypeId`	ID	Id of the opportunity type.
`ownerId`	ID!	Id of the owning user.
`shareMode`	ShareModeEnum	Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit).
`useLang`	Boolean	When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.
`sharingUnits`	[CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput!]	Sales units that have been granted shared access to this form view (custom share mode).
`sharingClients`	[CreateFormViewSharingClientRelationNoFormViewBackrefInput!]	Users that have been granted shared access to this form view (custom share mode).

CreateFormViewSharingClientRelationNoFormViewBackrefInput input 5 fields: modified, created, clientId, …

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

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`clientId`	ID!	Id of the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it.
`revision`	Int	Revision when entity was lastly changed.

CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput input 5 fields: modified, created, role, …

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

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`role`	SharingRoleEnum	Access the sharing gives members and managers of the sales unit on the form view: Watcher can view it, Editor can also edit it.
`unitId`	ID!	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateFormViewInput input 17 fields: clientMutationId, id, modified, …

Field values of a FormView 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.
`accountTypeId`	ID	Id of the account type the form view applies to. Set when the form view targets accounts.
`contactTypeId`	ID	Id of the contact type the form view applies to. Set when the form view targets contacts.
`hiddenItemIds`	[UUID!]	Ids of fields and webresources hidden from the form for this view.
`itemColors`	[FormViewItemColorInput!]	Per-item color overrides for fields and webresources in the form, keyed by item id.
`leadTypeId`	ID	Id of the lead type the form view applies to. Set when the form view targets leads.
`name`	String	Name of the entity and its default text representation.
`opptyTypeId`	ID	Id of the opportunity type.
`ownerId`	ID	Id of the owning user.
`shareMode`	ShareModeEnum	Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit).
`useLang`	Boolean	When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.
`sharingUnits`	[CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput!]	Sales units that have been granted shared access to this form view (custom share mode).
`sharingClients`	[CreateFormViewSharingClientRelationNoFormViewBackrefInput!]	Users that have been granted shared access to this form view (custom share mode).

DeleteFormViewInput input clientMutationId: String, id: ID!

Id of the FormView 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.

FormViewItemColorInput input id: UUID!, color: Int!

Color of one field or web resource on a form view.

Input field	Type	Description
`id`	UUID!	Id of the form item (field or web resource) the color applies to.
`color`	Int!	Color of the item, as a packed RGB integer.

UpdateFormViewInput input 17 fields: clientMutationId, id, modified, …

Id of a FormView 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.
`accountTypeId`	ID	Id of the account type the form view applies to. Set when the form view targets accounts.
`contactTypeId`	ID	Id of the contact type the form view applies to. Set when the form view targets contacts.
`hiddenItemIds`	[UUID!]	Ids of fields and webresources hidden from the form for this view.
`itemColors`	[FormViewItemColorInput!]	Per-item color overrides for fields and webresources in the form, keyed by item id.
`leadTypeId`	ID	Id of the lead type the form view applies to. Set when the form view targets leads.
`name`	String	Name of the entity and its default text representation.
`opptyTypeId`	ID	Id of the opportunity type.
`ownerId`	ID	Id of the owning user.
`shareMode`	ShareModeEnum	Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit).
`useLang`	Boolean	When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
`revision`	Int	Revision when entity was lastly changed.
`sharingUnits`	[CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput!]	Sales units that have been granted shared access to this form view (custom share mode).
`sharingClients`	[CreateFormViewSharingClientRelationNoFormViewBackrefInput!]	Users that have been granted shared access to this form view (custom share mode).

BulkUpdateFormViewPayload object result: BulkUpdateResults!

Result of the bulkUpdateFormView mutation.

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

CreateFormViewPayload object formView: FormViewEntity, clientMutationId: String

Result of the createFormView mutation.

Field	Type	Description
`formView`	FormViewEntity	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).

DeleteFormViewPayload object formView: FormViewEntity, clientMutationId: String

Result of the deleteFormView mutation.

Field	Type	Description
`formView`	FormViewEntity	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).

UpdateFormViewPayload object formView: FormViewEntity, clientMutationId: String

Result of the updateFormView mutation.

Field	Type	Description
`formView`	FormViewEntity	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).

FormViewItemColor object id: ID!, color: Int!

Color of one field or web resource on a form view.

Field	Type	Description
`id`	ID!	Id of the form item (field or web resource) the color applies to.
`color`	Int!	Color of the item, as a packed RGB integer.