GraphQL RepositoriescustomEntitySharingSalesUnitRelation

`entities.customEntitySharingSalesUnitRelation`

Read custom entity sharing sales unit relation records with the customEntitySharingSalesUnitRelation repository, and change them with the custom entity sharing sales unit relation mutations.

5 queries
4 mutations

Example: first three custom entity sharing sales unit relation recordsGraphQLcURL

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

Queries

Fields of entities { customEntitySharingSalesUnitRelation { … } }.

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.	CustomEntitySharingSalesUnitRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CustomEntitySharingSalesUnitRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CustomEntitySharingSalesUnitRelationFilterInput, orderBy: [CustomEntitySharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CustomEntitySharingSalesUnitRelationEntity!]!
QUERY	`getByCriteria`(filter: CustomEntitySharingSalesUnitRelationFilterInput, orderBy: [CustomEntitySharingSalesUnitRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CustomEntitySharingSalesUnitRelationEntityConnection
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	`createCustomEntitySharingSalesUnitRelation`(input: CreateCustomEntitySharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCustomEntitySharingSalesUnitRelationPayload
MUTATION	`updateCustomEntitySharingSalesUnitRelation`(input: UpdateCustomEntitySharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCustomEntitySharingSalesUnitRelationPayload
MUTATION	`bulkUpdateCustomEntitySharingSalesUnitRelation`(input: [CreateOrUpdateCustomEntitySharingSalesUnitRelationInput!]!, deleteInput: [DeleteCustomEntitySharingSalesUnitRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCustomEntitySharingSalesUnitRelationPayload
MUTATION	`deleteCustomEntitySharingSalesUnitRelation`(input: DeleteCustomEntitySharingSalesUnitRelationInput!)	Soft-delete	DeleteCustomEntitySharingSalesUnitRelationPayload

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.

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

Sharing of a custom entity record with a sales unit, 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.
`customEntity`	CustomEntityEntity	Custom entity record being shared.
`unit`	SalesUnitEntity	Sales unit the custom entity record is shared with.
`customEntityId`	ID!	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
`unitId`	ID!	Id of the sales 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.

CustomEntitySharingSalesUnitRelationEntityConnection object pageInfo: PageInfo!, edges: [CustomEntitySharingSalesUnitRelationEntityEdge]!, totalCount: Int

Paginated list of CustomEntitySharingSalesUnitRelation records.

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

CustomEntitySharingSalesUnitRelationEntityEdge object node: CustomEntitySharingSalesUnitRelationEntity, cursor: String!

A Relay edge containing a CustomEntitySharingSalesUnitRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CustomEntitySharingSalesUnitRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CustomEntitySharingSalesUnitRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CustomEntitySharingSalesUnitRelationFilterInput	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.
`customEntityId`	EntityFilterStringField	Id of the shared custom entity record.
`role`	SharingRoleEnumFilterInput	Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
`unitId`	EntityFilterStringField	Id of the sales unit.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`customEntity`	CustomEntityFilterInput	Custom entity record being shared. Matches records where a related record meets these conditions.
`unit`	SalesUnitFilterInput	Sales unit the custom entity record is shared with. Matches records where a related record meets these conditions.

CustomEntitySharingSalesUnitRelationOrderByInput input Asc or Desc per field

Sorting of CustomEntitySharingSalesUnitRelation 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.
`customEntity`	[CustomEntityOrderByNestedInput!]	Custom entity record being shared. Sorts by fields of the related record, listed in order of priority.
`unit`	[SalesUnitOrderByNestedInput!]	Sales unit the custom entity record is shared with. Sorts by fields of the related record, listed in order of priority.
`customEntityId`	OrderByEnum	Id of the shared custom entity record.
`role`	OrderByEnum	Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
`unitId`	OrderByEnum	Id of the sales unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new CustomEntitySharingSalesUnitRelation 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.
`customEntityId`	ID!	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
`unitId`	ID!	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a CustomEntitySharingSalesUnitRelation 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.
`customEntityId`	ID	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

DeleteCustomEntitySharingSalesUnitRelationInput input clientMutationId: String, id: ID!

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

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

Id of a CustomEntitySharingSalesUnitRelation 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.
`customEntityId`	ID	Id of the shared custom entity record.
`role`	SharingRoleEnum	Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateCustomEntitySharingSalesUnitRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateCustomEntitySharingSalesUnitRelation mutation.

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

CreateCustomEntitySharingSalesUnitRelationPayload object customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity, clientMutationId: String

Result of the createCustomEntitySharingSalesUnitRelation mutation.

Field	Type	Description
`customEntitySharingSalesUnitRelation`	CustomEntitySharingSalesUnitRelationEntity	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).

DeleteCustomEntitySharingSalesUnitRelationPayload object customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity, clientMutationId: String

Result of the deleteCustomEntitySharingSalesUnitRelation mutation.

Field	Type	Description
`customEntitySharingSalesUnitRelation`	CustomEntitySharingSalesUnitRelationEntity	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).

UpdateCustomEntitySharingSalesUnitRelationPayload object customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity, clientMutationId: String

Result of the updateCustomEntitySharingSalesUnitRelation mutation.

Field	Type	Description
`customEntitySharingSalesUnitRelation`	CustomEntitySharingSalesUnitRelationEntity	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).