GraphQL RepositoriescustomEntitySharingClientRelation

`entities.customEntitySharingClientRelation`

Read custom entity sharing client relation records with the customEntitySharingClientRelation repository, and change them with the custom entity sharing client relation mutations.

5 queries
4 mutations

Example: first three custom entity sharing client relation recordsGraphQLcURL

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

Queries

Fields of entities { customEntitySharingClientRelation { … } }.

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.	CustomEntitySharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CustomEntitySharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CustomEntitySharingClientRelationFilterInput, orderBy: [CustomEntitySharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CustomEntitySharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: CustomEntitySharingClientRelationFilterInput, orderBy: [CustomEntitySharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CustomEntitySharingClientRelationEntityConnection
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	`createCustomEntitySharingClientRelation`(input: CreateCustomEntitySharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCustomEntitySharingClientRelationPayload
MUTATION	`updateCustomEntitySharingClientRelation`(input: UpdateCustomEntitySharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCustomEntitySharingClientRelationPayload
MUTATION	`bulkUpdateCustomEntitySharingClientRelation`(input: [CreateOrUpdateCustomEntitySharingClientRelationInput!]!, deleteInput: [DeleteCustomEntitySharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCustomEntitySharingClientRelationPayload
MUTATION	`deleteCustomEntitySharingClientRelation`(input: DeleteCustomEntitySharingClientRelationInput!)	Soft-delete	DeleteCustomEntitySharingClientRelationPayload

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.

CustomEntitySharingClientRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Sharing of a custom entity record with a user, as a watcher or an editor.

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.
`client`	ClientEntity	User the custom entity record is shared with.
`customEntity`	CustomEntityEntity	Custom entity record being shared.
`clientId`	ID!	Id of the user.
`customEntityId`	ID!	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and 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.

CustomEntitySharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [CustomEntitySharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of CustomEntitySharingClientRelation records.

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

CustomEntitySharingClientRelationEntityEdge object node: CustomEntitySharingClientRelationEntity, cursor: String!

A Relay edge containing a CustomEntitySharingClientRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CustomEntitySharingClientRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CustomEntitySharingClientRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CustomEntitySharingClientRelationFilterInput	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.
`customEntityId`	EntityFilterStringField	Id of the shared custom entity record.
`role`	SharingRoleEnumFilterInput	Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`client`	ClientFilterInput	User the custom entity record is shared with. Matches records where a related record meets these conditions.
`customEntity`	CustomEntityFilterInput	Custom entity record being shared. Matches records where a related record meets these conditions.

CustomEntitySharingClientRelationOrderByInput input Asc or Desc per field

Sorting of CustomEntitySharingClientRelation 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.
`client`	[ClientOrderByNestedInput!]	User the custom entity record is shared with. Sorts by fields of the related record, listed in order of priority.
`customEntity`	[CustomEntityOrderByNestedInput!]	Custom entity record being shared. Sorts by fields of the related record, listed in order of priority.
`clientId`	OrderByEnum	Id of the user.
`customEntityId`	OrderByEnum	Id of the shared custom entity record.
`role`	OrderByEnum	Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateCustomEntitySharingClientRelationInput input 7 fields: clientMutationId, modified, created, …

Field values of a new CustomEntitySharingClientRelation 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.
`clientId`	ID!	Id of the user.
`customEntityId`	ID!	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateCustomEntitySharingClientRelationInput input 8 fields: clientMutationId, id, modified, …

Field values of a CustomEntitySharingClientRelation 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.
`clientId`	ID	Id of the user.
`customEntityId`	ID	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

DeleteCustomEntitySharingClientRelationInput input clientMutationId: String, id: ID!

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

UpdateCustomEntitySharingClientRelationInput input 8 fields: clientMutationId, id, modified, …

Id of a CustomEntitySharingClientRelation 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.
`clientId`	ID	Id of the user.
`customEntityId`	ID	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateCustomEntitySharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateCustomEntitySharingClientRelation mutation.

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

CreateCustomEntitySharingClientRelationPayload object customEntitySharingClientRelation: CustomEntitySharingClientRelationEntity, clientMutationId: String

Result of the createCustomEntitySharingClientRelation mutation.

Field	Type	Description
`customEntitySharingClientRelation`	CustomEntitySharingClientRelationEntity	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).

DeleteCustomEntitySharingClientRelationPayload object customEntitySharingClientRelation: CustomEntitySharingClientRelationEntity, clientMutationId: String

Result of the deleteCustomEntitySharingClientRelation mutation.

Field	Type	Description
`customEntitySharingClientRelation`	CustomEntitySharingClientRelationEntity	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).

UpdateCustomEntitySharingClientRelationPayload object customEntitySharingClientRelation: CustomEntitySharingClientRelationEntity, clientMutationId: String

Result of the updateCustomEntitySharingClientRelation mutation.

Field	Type	Description
`customEntitySharingClientRelation`	CustomEntitySharingClientRelationEntity	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).