GraphQL RepositoriessalesUnitClientRelation

`entities.salesUnitClientRelation`

Read sales unit client relation records with the salesUnitClientRelation repository, and change them with the sales unit client relation mutations. Same records as the REST SalesUnitClientRelations entity.

Example: first three sales unit client relation recordsGraphQLcURL

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

Queries

Fields of entities { salesUnitClientRelation { … } }.

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.	SalesUnitClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[SalesUnitClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: SalesUnitClientRelationFilterInput, orderBy: [SalesUnitClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[SalesUnitClientRelationEntity!]!
QUERY	`getByCriteria`(filter: SalesUnitClientRelationFilterInput, orderBy: [SalesUnitClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	SalesUnitClientRelationEntityConnection
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!]!

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.

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

Membership of a user in a sales unit, as a member or manager.

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 belonging to the sales unit.
`unit`	SalesUnitEntity	Sales unit the user belongs to.
`clientId`	ID!	Id of the user.
`unitId`	ID!	Id of the sales unit.
`unitRole`	UnitRoleEnum	Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit.
`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.

SalesUnitClientRelationEntityConnection object pageInfo: PageInfo!, edges: [SalesUnitClientRelationEntityEdge]!, totalCount: Int

Paginated list of SalesUnitClientRelation records.

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

SalesUnitClientRelationEntityEdge object node: SalesUnitClientRelationEntity, cursor: String!

A Relay edge containing a SalesUnitClientRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[SalesUnitClientRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[SalesUnitClientRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	SalesUnitClientRelationFilterInput	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.
`unitId`	EntityFilterStringField	Id of the sales unit.
`unitRole`	UnitRoleEnumFilterInput	Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`client`	ClientFilterInput	User belonging to the sales unit. Matches records where a related record meets these conditions.
`unit`	SalesUnitFilterInput	Sales unit the user belongs to. Matches records where a related record meets these conditions.

SalesUnitClientRelationOrderByInput input Asc or Desc per field

Sorting of SalesUnitClientRelation 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 belonging to the sales unit. Sorts by fields of the related record, listed in order of priority.
`unit`	[SalesUnitOrderByNestedInput!]	Sales unit the user belongs to. Sorts by fields of the related record, listed in order of priority.
`clientId`	OrderByEnum	Id of the user.
`unitId`	OrderByEnum	Id of the sales unit.
`unitRole`	OrderByEnum	Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.

UnitRoleEnumFilterInput input eq: [UnitRoleEnum!], NOT: UnitRoleEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[UnitRoleEnum!]	Matches any of the listed values.
`NOT`	UnitRoleEnumFilterInput	Matches values that do not meet this condition.

UnitRoleEnum enum Member, Manager

Role of a user within a sales unit.

Value	Description
`Member`	Regular member of the sales unit.
`Manager`	Manager of the sales unit.