GraphQL RepositoriesaccountSharingClientRelation

`entities.accountSharingClientRelation`

Read account sharing client relation records with the accountSharingClientRelation repository, and change them with the account sharing client relation mutations. Same records as the REST AccountSharingClientRelations entity.

Example: first three account sharing client relation recordsGraphQLcURL

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

Queries

Fields of entities { accountSharingClientRelation { … } }.

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.	AccountSharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AccountSharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AccountSharingClientRelationFilterInput, orderBy: [AccountSharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AccountSharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: AccountSharingClientRelationFilterInput, orderBy: [AccountSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AccountSharingClientRelationEntityConnection
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	`createAccountSharingClientRelation`(input: CreateAccountSharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAccountSharingClientRelationPayload
MUTATION	`updateAccountSharingClientRelation`(input: UpdateAccountSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAccountSharingClientRelationPayload
MUTATION	`bulkUpdateAccountSharingClientRelation`(input: [CreateOrUpdateAccountSharingClientRelationInput!]!, deleteInput: [DeleteAccountSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAccountSharingClientRelationPayload
MUTATION	`deleteAccountSharingClientRelation`(input: DeleteAccountSharingClientRelationInput!)	Soft-delete	DeleteAccountSharingClientRelationPayload

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.

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

Sharing of an account 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.
`account`	AccountEntity	Account being shared.
`client`	ClientEntity	User the account is shared with.
`accountId`	ID!	Id of the shared account.
`clientId`	ID!	Id of the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the account: 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.

AccountSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [AccountSharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of AccountSharingClientRelation records.

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

AccountSharingClientRelationEntityEdge object node: AccountSharingClientRelationEntity, cursor: String!

A Relay edge containing a AccountSharingClientRelationEntity and its cursor.

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

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

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

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

AccountSharingClientRelationOrderByInput input Asc or Desc per field

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

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

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

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

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

DeleteAccountSharingClientRelationInput input clientMutationId: String, id: ID!

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

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

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

BulkUpdateAccountSharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateAccountSharingClientRelation mutation.

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

CreateAccountSharingClientRelationPayload object accountSharingClientRelation: AccountSharingClientRelationEntity, clientMutationId: String

Result of the createAccountSharingClientRelation mutation.

Field	Type	Description
`accountSharingClientRelation`	AccountSharingClientRelationEntity	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).

DeleteAccountSharingClientRelationPayload object accountSharingClientRelation: AccountSharingClientRelationEntity, clientMutationId: String

Result of the deleteAccountSharingClientRelation mutation.

Field	Type	Description
`accountSharingClientRelation`	AccountSharingClientRelationEntity	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).

UpdateAccountSharingClientRelationPayload object accountSharingClientRelation: AccountSharingClientRelationEntity, clientMutationId: String

Result of the updateAccountSharingClientRelation mutation.

Field	Type	Description
`accountSharingClientRelation`	AccountSharingClientRelationEntity	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).