OBJECT
CustomEntityEntity

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

type CustomEntityEntity {
# Values of the record's custom fields as a JSON object keyed by custom field 
# apiName (camelCase).
# 
# Arguments
# apiNames: Api names of custom fields to retrieve. All are 
# returned if not set.
customFields(apiNames: [String!]): JSONString! 
# Filled only when a single record is read by its id; otherwise null or an empty 
# list.
pendingScheduledActions: Int 
# 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.
isDeleteProtected: Boolean! 
# Unique identifier of entity.
id: ID! 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# Currency exchange rate list used to convert monetary fields linked to this 
# record. Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
# Sales user who owns this custom entity record.
owner: ClientEntity 
# 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.
type: CustomEntityTypeEntity 
# Sales unit this record is assigned to. Determines which team members can see the 
# record under unit-based sharing.
unit: SalesUnitEntity 
# Id of the currency exchange rate list applied to this record.
currencyExchangeRatesListId: ID 
# Name of the entity and its default text representation.
name: String 
# Id of the sales user who owns the custom entity record.
ownerId: ID! 
# Sharing model applied on top of the owner/unit visibility (e.g. shared with 
# selected sales units or selected users).
shareMode: ShareModeEnum 
# 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.
tableName: String! 
# Id of the custom entity type.
typeId: ID 
# Id of the sales unit.
unitId: ID 
# Sales units that have been granted shared access to this custom entity record. 
# Editable only when shareMode allows unit sharing.
# 
# Arguments
# filter: Filter SalesUnit relations by target SalesUnit 
# attributes.
# filterEdge: Filter CustomEntitySharingSalesUnitRelation 
# relations by edge (relation) CustomEntitySharingSalesUnitRelation attributes.
# orderBy: Order SalesUnit relations by target SalesUnit 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingUnits(
filter: SalesUnitFilterInput,
filterEdge: CustomEntitySharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CustomEntitySharingSalesUnitRelationEntityConnection 
# Users that have been granted shared access to this custom entity record. 
# Editable only when shareMode allows user sharing.
# 
# Arguments
# filter: Filter Client relations by target Client attributes.
# filterEdge: Filter CustomEntitySharingClientRelation relations 
# by edge (relation) CustomEntitySharingClientRelation attributes.
# orderBy: Order Client relations by target Client attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingClients(
filter: ClientFilterInput,
filterEdge: CustomEntitySharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CustomEntitySharingClientRelationEntityConnection 
# Documents linked to this custom entity record.
# 
# Arguments
# filter: Filter CloudObject relations by target CloudObject 
# attributes.
# filterEdge: Filter CloudObjectRelation relations by edge 
# (relation) CloudObjectRelation attributes.
# orderBy: Order CloudObject relations by target CloudObject 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
documents(
filter: CloudObjectFilterInput,
filterEdge: CloudObjectRelationFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectRelationEntityConnection 
# Saved view profiles this custom entity record currently matches.
# 
# Arguments
# filter: Filter Profile relations by target Profile attributes.
# filterEdge: Filter ProfileRelation relations by edge (relation) 
# ProfileRelation attributes.
# orderBy: Order Profile relations by target Profile attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
staticProfiles(
filter: ProfileFilterInput,
filterEdge: ProfileRelationFilterInput,
orderBy: [ProfileOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProfileRelationEntityConnection 
# Tag labels applied to this custom entity record.
# 
# Arguments
# filter: Filter Tag relations by target Tag attributes.
# filterEdge: Filter TagRelation relations by edge (relation) 
# TagRelation attributes.
# orderBy: Order Tag relations by target Tag attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
tags(
filter: TagFilterInput,
filterEdge: TagRelationFilterInput,
orderBy: [TagOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TagRelationEntityConnection 
# True when the current authenticated user has marked this record as favorite. 
# Per-user.
isFavorite: Boolean! 
# Revision when entity was lastly changed.
revision: Int 
# Filled only when a single record is read by its id; otherwise null or an empty 
# list.
viewerIdsPerSalesUnit: [UUID!]! 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
}
CustomEntityEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
