OBJECT
CustomEntityEntity

GraphQL Schema definition

type CustomEntityEntity {
# Arguments
#   apiNames: Api names of custom fields to retrieve. All are 
#   returned if not set.
customFields(apiNames: [String!]): JSONString! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
pendingScheduledActions: Int 
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
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 record owner.
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.entity_api_name 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 share_mode 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 share_mode 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 
#   True when the current authenticated user has marked this record as favorite. 
#   Per-user.
isFavorite: Boolean! 
#   Revision when entity was lastly changed.
revision: Int 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
viewerIdsPerSalesUnit: [UUID!]! 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
}
CustomEntityEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
