GraphQL RepositoriestaskSharingClientRelation

`entities.taskSharingClientRelation`

Read task sharing client relation records with the taskSharingClientRelation repository, and change them with the task sharing client relation mutations. Same records as the REST TaskSharingClientRelations entity.

Example: first three task sharing client relation recordsGraphQLcURL

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

Queries

Fields of entities { taskSharingClientRelation { … } }.

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.	TaskSharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[TaskSharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: TaskSharingClientRelationFilterInput, orderBy: [TaskSharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[TaskSharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: TaskSharingClientRelationFilterInput, orderBy: [TaskSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	TaskSharingClientRelationEntityConnection
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	`createTaskSharingClientRelation`(input: CreateTaskSharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateTaskSharingClientRelationPayload
MUTATION	`updateTaskSharingClientRelation`(input: UpdateTaskSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateTaskSharingClientRelationPayload
MUTATION	`bulkUpdateTaskSharingClientRelation`(input: [CreateOrUpdateTaskSharingClientRelationInput!]!, deleteInput: [DeleteTaskSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateTaskSharingClientRelationPayload
MUTATION	`deleteTaskSharingClientRelation`(input: DeleteTaskSharingClientRelationInput!)	Soft-delete	DeleteTaskSharingClientRelationPayload

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.

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

Share of a task with an individual user, with the access level granted.

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 task is shared with.
`task`	TaskEntity	Task being shared.
`clientId`	ID!	Id of the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it.
`taskId`	ID!	Id of the shared task.
`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.

TaskSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [TaskSharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of TaskSharingClientRelation records.

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

TaskSharingClientRelationEntityEdge object node: TaskSharingClientRelationEntity, cursor: String!

A Relay edge containing a TaskSharingClientRelationEntity and its cursor.

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

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

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

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

TaskSharingClientRelationOrderByInput input Asc or Desc per field

Sorting of TaskSharingClientRelation 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 task is shared with. Sorts by fields of the related record, listed in order of priority.
`task`	[TaskOrderByNestedInput!]	Task being shared. Sorts by fields of the related record, listed in order of priority.
`clientId`	OrderByEnum	Id of the user.
`role`	OrderByEnum	Access the sharing gives the user on the task: Watcher can view it, Editor can view and edit it.
`taskId`	OrderByEnum	Id of the shared task.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

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

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

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

DeleteTaskSharingClientRelationInput input clientMutationId: String, id: ID!

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

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

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

BulkUpdateTaskSharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateTaskSharingClientRelation mutation.

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

CreateTaskSharingClientRelationPayload object taskSharingClientRelation: TaskSharingClientRelationEntity, clientMutationId: String

Result of the createTaskSharingClientRelation mutation.

Field	Type	Description
`taskSharingClientRelation`	TaskSharingClientRelationEntity	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).

DeleteTaskSharingClientRelationPayload object taskSharingClientRelation: TaskSharingClientRelationEntity, clientMutationId: String

Result of the deleteTaskSharingClientRelation mutation.

Field	Type	Description
`taskSharingClientRelation`	TaskSharingClientRelationEntity	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).

UpdateTaskSharingClientRelationPayload object taskSharingClientRelation: TaskSharingClientRelationEntity, clientMutationId: String

Result of the updateTaskSharingClientRelation mutation.

Field	Type	Description
`taskSharingClientRelation`	TaskSharingClientRelationEntity	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).