GraphQL RepositoriescustomEntity

`entities.customEntity`

Read custom entity records with the customEntity repository, and change them with the custom entity mutations. Same records as the REST {custom_entity_api_name} entity.

Example: first three custom entity recordsGraphQLcURL

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

Queries

Fields of entities { customEntity { … } }.

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.	CustomEntityEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CustomEntityEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CustomEntityFilterInput, orderBy: [CustomEntityOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CustomEntityEntity!]!
QUERY	`getByCriteria`(filter: CustomEntityFilterInput, orderBy: [CustomEntityOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CustomEntityEntityConnection
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	`getBySession`(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int) Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.	CustomEntityEntityConnection
QUERY	`getByIdFormatted`(id: UUID!, fieldIds: [UUID!]) Returns the values of a record's fields formatted for display, keyed by field id.	JSONString
QUERY	`autoPrefill`(mappingId: UUID!, entityId: UUID!, targetEntityTypeId: UUID) Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create.	CustomEntityEntity!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`changeOwnershipCustomEntity`(input: ChangeOwnershipCustomEntityInput!)	Change owner GraphQL only	ChangeOwnershipCustomEntityPayload
MUTATION	`copyCustomEntity`(input: CopyCustomEntityInput!)	Copy a record GraphQL only	CopyCustomEntityPayload
MUTATION	`manageSharingCustomEntity`(input: ManageSharingCustomEntityInput!)	Change who it is shared with GraphQL only	ManageSharingCustomEntityPayload

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.

CustomEntityEntity object 27 fields: customFields, pendingScheduledActions, isDeleteProtected, …

Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities.

Field	Type	Description
`customFields`	JSONString! (1 args)	Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
`pendingScheduledActions`	Int	Filled only when a single record is read by its id; otherwise null or an empty list.
`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.
`currencyExchangeRatesList`	CurrencyExchangeRatesListEntity	Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default.
`owner`	ClientEntity	Sales user who owns this custom entity record.
`type`	CustomEntityTypeEntity	Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records.
`unit`	SalesUnitEntity	Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to this record.
`name`	String	Name of the entity and its default text representation.
`ownerId`	ID!	Id of the sales user who owns the custom entity record.
`shareMode`	ShareModeEnum	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
`tableName`	String!	Discriminator identifying which custom entity type this record belongs to. Read-only; matches CustomEntityType.entityApiName and is used as the entity name in REST and GraphQL queries.
`typeId`	ID	Id of the custom entity type.
`unitId`	ID	Id of the sales unit.
`sharingUnits`	CustomEntitySharingSalesUnitRelationEntityConnection (8 args)	Sales units that have been granted shared access to this custom entity record. Editable only when shareMode allows unit sharing.
`sharingClients`	CustomEntitySharingClientRelationEntityConnection (8 args)	Users that have been granted shared access to this custom entity record. Editable only when shareMode allows user sharing.
`documents`	CloudObjectRelationEntityConnection (8 args)	Documents linked to this custom entity record.
`staticProfiles`	ProfileRelationEntityConnection (8 args)	Saved view profiles this custom entity record currently matches.
`tags`	TagRelationEntityConnection (8 args)	Tag labels applied to this custom entity record.
`isFavorite`	Boolean!	True when the current authenticated user has marked this record as favorite. Per-user.
`revision`	Int	Revision when entity was lastly changed.
`viewerIdsPerSalesUnit`	[UUID!]!	Filled only when a single record is read by its id; otherwise null or an empty list.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CustomEntityEntityConnection object pageInfo: PageInfo!, edges: [CustomEntityEntityEdge]!, totalCount: Int

Paginated list of CustomEntity records.

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

CustomEntityEntityEdge object node: CustomEntityEntity, cursor: String!

A Relay edge containing a CustomEntityEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CustomEntityFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CustomEntityFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CustomEntityFilterInput	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.
`currencyExchangeRatesListId`	EntityFilterStringField	Id of the currency exchange rate list applied to this record.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`ownerId`	EntityFilterStringField	Id of the sales user who owns the custom entity record.
`shareMode`	ShareModeEnumFilterInput	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
`tableName`	EntityFilterStringField	Discriminator identifying which custom entity type this record belongs to. Read-only; matches CustomEntityType.entityApiName and is used as the entity name in REST and GraphQL queries.
`typeId`	EntityFilterStringField	Id of the custom entity type.
`unitId`	EntityFilterStringField	Id of the sales unit.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`withCustom`	[CustomField!]	Conditions on custom fields, each identified by its api name. All listed conditions must match.
`currencyExchangeRatesList`	CurrencyExchangeRatesListFilterInput	Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	Sales user who owns this custom entity record. Matches records where a related record meets these conditions.
`type`	CustomEntityTypeFilterInput	Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records. Matches records where a related record meets these conditions.
`unit`	SalesUnitFilterInput	Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions.
`sharingUnits`	CustomEntitySharingSalesUnitRelationFilterInput	Sales units that have been granted shared access to this custom entity record. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions.
`sharingClients`	CustomEntitySharingClientRelationFilterInput	Users that have been granted shared access to this custom entity record. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions.
`documents`	CloudObjectRelationFilterInput	Documents linked to this custom entity record. Matches records where a related record meets these conditions.
`staticProfiles`	ProfileRelationFilterInput	Saved view profiles this custom entity record currently matches. Matches records where a related record meets these conditions.
`tags`	TagRelationFilterInput	Tag labels applied to this custom entity record. Matches records where a related record meets these conditions.

CustomEntityOrderByInput input Asc or Desc per field

Sorting of CustomEntity 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.
`currencyExchangeRatesList`	[CurrencyExchangeRatesListOrderByNestedInput!]	Currency exchange rate list used to convert monetary fields linked to this record. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	Sales user who owns this custom entity record. Sorts by fields of the related record, listed in order of priority.
`type`	[CustomEntityTypeOrderByNestedInput!]	Custom entity type that classifies this record. Custom entity types are configurable per team space and define the schema (fields and form) of the records. Sorts by fields of the related record, listed in order of priority.
`unit`	[SalesUnitOrderByNestedInput!]	Sales unit this record is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority.
`currencyExchangeRatesListId`	OrderByEnum	Id of the currency exchange rate list applied to this record.
`name`	OrderByEnum	Name of the entity and its default text representation.
`ownerId`	OrderByEnum	Id of the sales user who owns the custom entity record.
`shareMode`	OrderByEnum	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
`typeId`	OrderByEnum	Id of the custom entity type.
`unitId`	OrderByEnum	Id of the sales unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.
`withCustom`	CommonEntityRepositoryOrderByCustomField	Sorts by a custom field.

ChangeOwnershipCustomEntityInput input 6 fields: ownerId, unitId, keepOwnerAsEditor, …

Parameters of the changeOwnershipCustomEntity mutation.

Input field	Type	Description
`ownerId`	ID!	User who becomes the new owner of the record.
`unitId`	ID!	Sales unit the record is assigned to.
`keepOwnerAsEditor`	Boolean!	When true, the previous owner (if still an active user) stays on the record as a shared user with the Editor role, and a Private sharing mode is switched to Standard.
`transferLinkedRecords`	Boolean!	When true, the new owner and sales unit are also applied to the record's open tasks and appointments and its notes. Linked records that cannot be transferred are skipped without failing the mutation.
`id`	ID!	Identifier of the CustomEntityEntity to perform the action on.
`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).

CopyCustomEntityInput input skipCopySuffix: Boolean, id: ID!, clientMutationId: String

Parameters of the copyCustomEntity mutation.

Input field	Type	Description
`skipCopySuffix`	Boolean	When true, the copy keeps the original name without the copy suffix. Defaults to false.
`id`	ID!	Identifier of the CustomEntityEntity to perform the action on.
`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).

CreateCustomEntitySharingClientRelationNoCustomEntityBackrefInput input 5 fields: modified, created, clientId, …

Field values of a new CustomEntitySharingClientRelation record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`clientId`	ID!	Id of the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the custom entity record: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

CreateCustomEntitySharingSalesUnitRelationNoCustomEntityBackrefInput input 5 fields: modified, created, role, …

Field values of a new CustomEntitySharingSalesUnitRelation record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`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.

ManageSharingCustomEntityInput input 5 fields: shareMode, sharingClients, sharingUnits, …

Parameters of the manageSharingCustomEntity mutation.

Input field	Type	Description
`shareMode`	ShareModeEnum!	Sharing mode of the record: Standard, Private, AllView or AllEdit.
`sharingClients`	[CreateCustomEntitySharingClientRelationNoCustomEntityBackrefInput!]	Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users.
`sharingUnits`	[CreateCustomEntitySharingSalesUnitRelationNoCustomEntityBackrefInput!]	Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units.
`id`	ID!	Identifier of the CustomEntityEntity to perform the action on.
`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).

ChangeOwnershipCustomEntityPayload object result: CustomEntityEntity, clientMutationId: String

Result of the changeOwnershipCustomEntity mutation.

Field	Type	Description
`result`	CustomEntityEntity	The record with its new owner.
`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).

CopyCustomEntityPayload object result: CustomEntityEntity, clientMutationId: String

Result of the copyCustomEntity mutation.

Field	Type	Description
`result`	CustomEntityEntity	The new 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).

ManageSharingCustomEntityPayload object result: CustomEntityEntity, clientMutationId: String

Result of the manageSharingCustomEntity mutation.

Field	Type	Description
`result`	CustomEntityEntity	The record with its updated sharing.
`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).