GraphQL RepositoriesprojectSharingClientRelation

`entities.projectSharingClientRelation`

Read project sharing client relation records with the projectSharingClientRelation repository, and change them with the project sharing client relation mutations. Same records as the REST ProjectSharingClientRelations entity.

Example: first three project sharing client relation recordsGraphQLcURL

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

Queries

Fields of entities { projectSharingClientRelation { … } }.

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.	ProjectSharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ProjectSharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ProjectSharingClientRelationFilterInput, orderBy: [ProjectSharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ProjectSharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: ProjectSharingClientRelationFilterInput, orderBy: [ProjectSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ProjectSharingClientRelationEntityConnection
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	`createProjectSharingClientRelation`(input: CreateProjectSharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateProjectSharingClientRelationPayload
MUTATION	`updateProjectSharingClientRelation`(input: UpdateProjectSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateProjectSharingClientRelationPayload
MUTATION	`bulkUpdateProjectSharingClientRelation`(input: [CreateOrUpdateProjectSharingClientRelationInput!]!, deleteInput: [DeleteProjectSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateProjectSharingClientRelationPayload
MUTATION	`deleteProjectSharingClientRelation`(input: DeleteProjectSharingClientRelationInput!)	Soft-delete	DeleteProjectSharingClientRelationPayload

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.

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

Share of a project 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 project is shared with.
`project`	ProjectEntity	Project being shared.
`clientId`	ID!	Id of the user.
`projectId`	ID!	Id of the shared project.
`role`	SharingRoleEnum	Access the sharing gives the user on the project: 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.

ProjectSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [ProjectSharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of ProjectSharingClientRelation records.

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

ProjectSharingClientRelationEntityEdge object node: ProjectSharingClientRelationEntity, cursor: String!

A Relay edge containing a ProjectSharingClientRelationEntity and its cursor.

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

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

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

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

ProjectSharingClientRelationOrderByInput input Asc or Desc per field

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

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

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

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

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

DeleteProjectSharingClientRelationInput input clientMutationId: String, id: ID!

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

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

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

BulkUpdateProjectSharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateProjectSharingClientRelation mutation.

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

CreateProjectSharingClientRelationPayload object projectSharingClientRelation: ProjectSharingClientRelationEntity, clientMutationId: String

Result of the createProjectSharingClientRelation mutation.

Field	Type	Description
`projectSharingClientRelation`	ProjectSharingClientRelationEntity	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).

DeleteProjectSharingClientRelationPayload object projectSharingClientRelation: ProjectSharingClientRelationEntity, clientMutationId: String

Result of the deleteProjectSharingClientRelation mutation.

Field	Type	Description
`projectSharingClientRelation`	ProjectSharingClientRelationEntity	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).

UpdateProjectSharingClientRelationPayload object projectSharingClientRelation: ProjectSharingClientRelationEntity, clientMutationId: String

Result of the updateProjectSharingClientRelation mutation.

Field	Type	Description
`projectSharingClientRelation`	ProjectSharingClientRelationEntity	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).