--- title: entities.formViewSharingClientRelation description: Read form view sharing client relation records with the formViewSharingClientRelation repository, and change them with the form view sharing client relation mutations. Same records as the REST FormViewSharingClientRelations entity. canonical: https://developers.coevera.com/reference/graphql/form-view-sharing-client-relation/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.formViewSharingClientRelation Read form view sharing client relation records with the formViewSharingClientRelation repository, and change them with the form view sharing client relation mutations. Same records as the REST FormViewSharingClientRelations entity. REST: [FormViewSharingClientRelations](https://developers.coevera.com/reference/rest/form-view-sharing-client-relations.md). ## Queries - `getById(entityId: ID!): FormViewSharingClientRelationEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [FormViewSharingClientRelationEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. - `getAll(limit: Int, offset: Int, filter: FormViewSharingClientRelationFilterInput, orderBy: [FormViewSharingClientRelationOrderByInput!], includeDeleted: Boolean): [FormViewSharingClientRelationEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: FormViewSharingClientRelationFilterInput, orderBy: [FormViewSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): FormViewSharingClientRelationEntityConnection` Returns the records that match the filter as a cursor-paginated connection. - `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. ## Mutations - `createFormViewSharingClientRelation(input: CreateFormViewSharingClientRelationInput!, validationLevel: [ValidationLevel!]): CreateFormViewSharingClientRelationPayload` Create one record. - `updateFormViewSharingClientRelation(input: UpdateFormViewSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateFormViewSharingClientRelationPayload` Update fields. - `bulkUpdateFormViewSharingClientRelation(input: [CreateOrUpdateFormViewSharingClientRelationInput!]!, deleteInput: [DeleteFormViewSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateFormViewSharingClientRelationPayload` Create or update many; per-item results. - `deleteFormViewSharingClientRelation(input: DeleteFormViewSharingClientRelationInput!): DeleteFormViewSharingClientRelationPayload` Soft-delete. ## Types ### FormViewSharingClientRelationEntity (object) Sharing of a form view with a user, as a watcher or an editor. - `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. - `client: ClientEntity` User granted shared access to the form view. - `formView: FormViewEntity` Form view being shared. - `clientId: ID!` Id of the user. - `formViewId: ID!` Id of the shared form view. - `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. - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. ### FormViewSharingClientRelationEntityConnection (object) Paginated list of FormViewSharingClientRelation records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [FormViewSharingClientRelationEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### FormViewSharingClientRelationEntityEdge (object) A Relay edge containing a `FormViewSharingClientRelationEntity` and its cursor. - `node: FormViewSharingClientRelationEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### FormViewSharingClientRelationFilterInput (input) Filter conditions for FormViewSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [FormViewSharingClientRelationFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [FormViewSharingClientRelationFilterInput!]` Matches records that meet all of the listed filters. - `NOT: FormViewSharingClientRelationFilterInput` 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. - `clientId: EntityFilterStringField` Id of the user. - `formViewId: EntityFilterStringField` Id of the shared form view. - `role: SharingRoleEnumFilterInput` Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `client: ClientFilterInput` User granted shared access to the form view. Matches records where a related record meets these conditions. - `formView: FormViewFilterInput` Form view being shared. Matches records where a related record meets these conditions. ### FormViewSharingClientRelationOrderByInput (input) Sorting of FormViewSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. - `id: OrderByEnum` Unique identifier of entity. - `isDeleted: OrderByEnum` Specifies if the entity is considered deleted. - `modified: OrderByEnum` Last modification time. - `created: OrderByEnum` Creation time. - `client: [ClientOrderByNestedInput!]` User granted shared access to the form view. Sorts by fields of the related record, listed in order of priority. - `formView: [FormViewOrderByNestedInput!]` Form view being shared. Sorts by fields of the related record, listed in order of priority. - `clientId: OrderByEnum` Id of the user. - `formViewId: OrderByEnum` Id of the shared form view. - `role: OrderByEnum` Access the sharing gives the user on the form view: Watcher can view it, Editor can also edit it. - `revision: OrderByEnum` Revision when entity was lastly changed. ### CreateFormViewSharingClientRelationInput (input) Field values of a new FormViewSharingClientRelation 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). - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `clientId: ID!` Id of the user. - `formViewId: ID!` Id of the shared form view. - `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. ### CreateOrUpdateFormViewSharingClientRelationInput (input) Field values of a FormViewSharingClientRelation record to create, or to update when its id is set. - `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. - `clientId: ID` Id of the user. - `formViewId: ID` Id of the shared form view. - `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. ### DeleteFormViewSharingClientRelationInput (input) Id of the FormViewSharingClientRelation record to delete. - `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. ### UpdateFormViewSharingClientRelationInput (input) Id of a FormViewSharingClientRelation record and the field values to change. - `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. - `clientId: ID` Id of the user. - `formViewId: ID` Id of the shared form view. - `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. ### BulkUpdateFormViewSharingClientRelationPayload (object) Result of the bulkUpdateFormViewSharingClientRelation mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateFormViewSharingClientRelationPayload (object) Result of the createFormViewSharingClientRelation mutation. - `formViewSharingClientRelation: FormViewSharingClientRelationEntity` 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). ### DeleteFormViewSharingClientRelationPayload (object) Result of the deleteFormViewSharingClientRelation mutation. - `formViewSharingClientRelation: FormViewSharingClientRelationEntity` 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). ### UpdateFormViewSharingClientRelationPayload (object) Result of the updateFormViewSharingClientRelation mutation. - `formViewSharingClientRelation: FormViewSharingClientRelationEntity` 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). Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file. ## Example ```graphql query FirstFormViewSharingClientRelations { entities { formViewSharingClientRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } } ``` ```bash 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 FirstFormViewSharingClientRelations { entities { formViewSharingClientRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```