GraphQL RepositoriescontactSharingClientRelation

`entities.contactSharingClientRelation`

Read contact sharing client relation records with the contactSharingClientRelation repository, and change them with the contact sharing client relation mutations. Same records as the REST ContactSharingClientRelations entity.

Example: first three contact sharing client relation recordsGraphQLcURL

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

Queries

Fields of entities { contactSharingClientRelation { … } }.

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.	ContactSharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ContactSharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ContactSharingClientRelationFilterInput, orderBy: [ContactSharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ContactSharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: ContactSharingClientRelationFilterInput, orderBy: [ContactSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ContactSharingClientRelationEntityConnection
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	`createContactSharingClientRelation`(input: CreateContactSharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateContactSharingClientRelationPayload
MUTATION	`updateContactSharingClientRelation`(input: UpdateContactSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateContactSharingClientRelationPayload
MUTATION	`bulkUpdateContactSharingClientRelation`(input: [CreateOrUpdateContactSharingClientRelationInput!]!, deleteInput: [DeleteContactSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateContactSharingClientRelationPayload
MUTATION	`deleteContactSharingClientRelation`(input: DeleteContactSharingClientRelationInput!)	Soft-delete	DeleteContactSharingClientRelationPayload

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.

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

Sharing of a contact 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 contact is shared with.
`contact`	ContactEntity	Contact being shared.
`clientId`	ID!	Id of the user.
`contactId`	ID!	Id of the shared contact.
`role`	SharingRoleEnum	Access the sharing gives the user on the contact: 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.

ContactSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [ContactSharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of ContactSharingClientRelation records.

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

ContactSharingClientRelationEntityEdge object node: ContactSharingClientRelationEntity, cursor: String!

A Relay edge containing a ContactSharingClientRelationEntity and its cursor.

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

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

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

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

ContactSharingClientRelationOrderByInput input Asc or Desc per field

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

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

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

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

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

DeleteContactSharingClientRelationInput input clientMutationId: String, id: ID!

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

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

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

BulkUpdateContactSharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateContactSharingClientRelation mutation.

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

CreateContactSharingClientRelationPayload object contactSharingClientRelation: ContactSharingClientRelationEntity, clientMutationId: String

Result of the createContactSharingClientRelation mutation.

Field	Type	Description
`contactSharingClientRelation`	ContactSharingClientRelationEntity	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).

DeleteContactSharingClientRelationPayload object contactSharingClientRelation: ContactSharingClientRelationEntity, clientMutationId: String

Result of the deleteContactSharingClientRelation mutation.

Field	Type	Description
`contactSharingClientRelation`	ContactSharingClientRelationEntity	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).

UpdateContactSharingClientRelationPayload object contactSharingClientRelation: ContactSharingClientRelationEntity, clientMutationId: String

Result of the updateContactSharingClientRelation mutation.

Field	Type	Description
`contactSharingClientRelation`	ContactSharingClientRelationEntity	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).