GraphQL RepositoriessalesUnit

`entities.salesUnit`

Read sales unit records with the salesUnit repository, and change them with the sales unit mutations. Same records as the REST SalesUnits entity.

Example: first three sales unit recordsGraphQLcURL

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

Queries

Fields of entities { salesUnit { … } }.

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.	SalesUnitEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[SalesUnitEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: SalesUnitFilterInput, orderBy: [SalesUnitOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[SalesUnitEntity!]!
QUERY	`getByCriteria`(filter: SalesUnitFilterInput, orderBy: [SalesUnitOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	SalesUnitEntityConnection
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!]!
QUERY	`getRoot` Returns the top-level sales unit of the space, the root of the sales unit hierarchy.	SalesUnitEntity!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createSalesUnit`(input: CreateSalesUnitInput!, validationLevel: [ValidationLevel!])	Create one record	CreateSalesUnitPayload
MUTATION	`updateSalesUnit`(input: UpdateSalesUnitInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateSalesUnitPayload
MUTATION	`bulkUpdateSalesUnit`(input: [CreateOrUpdateSalesUnitInput!]!, deleteInput: [DeleteSalesUnitInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateSalesUnitPayload
MUTATION	`deleteSalesUnit`(input: DeleteSalesUnitInput!)	Soft-delete	DeleteSalesUnitPayload

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.

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

Sales unit (team) in the organization hierarchy that users belong to.

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.
`parent`	SalesUnitEntity	Parent sales unit, when this unit is nested. Empty for the root unit.
`picture`	CloudObjectEntity	Profile picture (logo) of the sales unit.
`name`	String!	Name of the entity and its default text representation.
`parentId`	ID	Id of the parent unit, or empty for the root unit.
`pictureId`	ID	Id of the picture cloud object.
`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.

SalesUnitEntityConnection object pageInfo: PageInfo!, edges: [SalesUnitEntityEdge]!, totalCount: Int

Paginated list of SalesUnit records.

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

SalesUnitEntityEdge object node: SalesUnitEntity, cursor: String!

A Relay edge containing a SalesUnitEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[SalesUnitFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[SalesUnitFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	SalesUnitFilterInput	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.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`parentId`	EntityFilterStringField	Id of the parent unit, or empty for the root unit.
`pictureId`	EntityFilterStringField	Id of the picture cloud object.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`parent`	SalesUnitFilterInput	Parent sales unit, when this unit is nested. Empty for the root unit. Matches records where a related record meets these conditions.
`picture`	CloudObjectFilterInput	Profile picture (logo) of the sales unit. Matches records where a related record meets these conditions.

SalesUnitOrderByInput input Asc or Desc per field

Sorting of SalesUnit 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.
`parent`	[SalesUnitOrderByNestedInput!]	Parent sales unit, when this unit is nested. Empty for the root unit. Sorts by fields of the related record, listed in order of priority.
`name`	OrderByEnum	Name of the entity and its default text representation.
`parentId`	OrderByEnum	Id of the parent unit, or empty for the root unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOrUpdateSalesUnitInput input 9 fields: clientMutationId, id, modified, …

Field values of a SalesUnit 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.
`picture`	CreateCloudObjectInput	Profile picture (logo) of the sales unit.
`name`	String	Name of the entity and its default text representation.
`parentId`	ID	Id of the parent unit, or empty for the root unit.
`pictureId`	ID	Id of the picture cloud object.
`revision`	Int	Revision when entity was lastly changed.

CreateSalesUnitInput input 8 fields: clientMutationId, modified, created, …

Field values of a new SalesUnit 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.
`picture`	CreateCloudObjectInput	Profile picture (logo) of the sales unit.
`name`	String!	Name of the entity and its default text representation.
`parentId`	ID	Id of the parent unit, or empty for the root unit.
`pictureId`	ID	Id of the picture cloud object.
`revision`	Int	Revision when entity was lastly changed.

DeleteSalesUnitInput input clientMutationId: String, id: ID!

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

UpdateSalesUnitInput input 9 fields: clientMutationId, id, modified, …

Id of a SalesUnit 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.
`picture`	CreateCloudObjectInput	Profile picture (logo) of the sales unit.
`name`	String	Name of the entity and its default text representation.
`parentId`	ID	Id of the parent unit, or empty for the root unit.
`pictureId`	ID	Id of the picture cloud object.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateSalesUnitPayload object result: BulkUpdateResults!

Result of the bulkUpdateSalesUnit mutation.

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

CreateSalesUnitPayload object salesUnit: SalesUnitEntity, clientMutationId: String

Result of the createSalesUnit mutation.

Field	Type	Description
`salesUnit`	SalesUnitEntity	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).

DeleteSalesUnitPayload object salesUnit: SalesUnitEntity, clientMutationId: String

Result of the deleteSalesUnit mutation.

Field	Type	Description
`salesUnit`	SalesUnitEntity	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).

UpdateSalesUnitPayload object salesUnit: SalesUnitEntity, clientMutationId: String

Result of the updateSalesUnit mutation.

Field	Type	Description
`salesUnit`	SalesUnitEntity	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).