OBJECT
ProjectEntity

GraphQL Schema definition

type ProjectEntity {
# 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 
#   Account this project is delivered for, or empty for internal projects without an 
#   external account.
account: AccountEntity 
#   Currency exchange rate list used to convert monetary fields linked to this 
#   project. Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
#   Sales user who owns this project.
owner: ClientEntity 
#   Project type that classifies this project. Project types are configurable per 
#   team space and drive which form, fields and objectives apply.
projectType: ProjectTypeEntity 
#   Sales unit this project is assigned to. Determines which team members can see 
#   the record under unit-based sharing.
unit: SalesUnitEntity 
#   Id of the related account.
accountId: ID 
#   Id of the currency exchange rate list applied to this project.
currencyExchangeRatesListId: ID 
#   Free-form description of the project.
description: String 
#   Planned end date of the project. Must be on or after start_date when both are 
#   set.
endDate: Date! 
#   Name of the entity and its default text representation.
name: String! 
#   Id of the project owner.
ownerId: ID! 
#   Id of the project type.
projectTypeId: ID 
#   Sharing model applied on top of the owner/unit visibility (e.g. shared with 
#   selected sales units or selected users).
shareMode: ShareModeEnum 
#   Date when the project starts.
startDate: Date 
#   Id of the sales unit.
unitId: ID 
#   Revision when entity was lastly changed.
revision: Int 
#   Target revenue of the project, stored in the team space base currency with the 
#   foreign value and currency code preserved alongside.
revenueGoal: CurrencyForeignField 
#   Documents linked to this project.
# 
# 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 
#   Sales units that have been granted shared access to this project. Editable only 
#   when share_mode allows unit sharing.
# 
# Arguments
#   filter: Filter SalesUnit relations by target SalesUnit 
#   attributes.
#   filterEdge: Filter ProjectSharingSalesUnitRelation relations by 
#   edge (relation) ProjectSharingSalesUnitRelation 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: ProjectSharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProjectSharingSalesUnitRelationEntityConnection 
#   Users that have been granted shared access to this project. Editable only when 
#   share_mode allows user sharing.
# 
# Arguments
#   filter: Filter Client relations by target Client attributes.
#   filterEdge: Filter ProjectSharingClientRelation relations by 
#   edge (relation) ProjectSharingClientRelation 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: ProjectSharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProjectSharingClientRelationEntityConnection 
#   Primary contact of this project. Set automatically from the contact relation 
#   marked as primary.
primaryContact: ContactEntity 
#   Contacts linked to this project, including the primary-contact flag.
# 
# Arguments
#   filter: Filter Contact relations by target Contact attributes.
#   filterEdge: Filter ProjectContactRelation relations by edge 
#   (relation) ProjectContactRelation attributes.
#   orderBy: Order Contact relations by target Contact 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.
contactRelations(
filter: ContactFilterInput,
filterEdge: ProjectContactRelationFilterInput,
orderBy: [ContactOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProjectContactRelationEntityConnection 
#   Tag labels applied to this project.
# 
# 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 
#   Saved view profiles this project 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 
#   Number of email sequences this record is currently actively enrolled in 
#   (soft-deleted or ended enrollments are not counted).
enrolledEmailSequences: Int! 
#   Objectives defined for this project, sorted by display order.
objectives: [ProjectObjectiveEntity!] 
#   True when the current authenticated user has marked this project as favorite. 
#   Per-user.
isFavorite: Boolean! 
#   Current status of the project (NotStarted, InProgress, Completed). Read-only; 
#   derived from is_completed and the underlying activity progress.
status: ProjectStatusEnum! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
viewerIdsPerSalesUnit: [UUID!]! 
#   Percentage of activities (tasks and appointments) on this project that are 
#   completed. Read-only; computed by Coevera.
completionRate: Float 
#   Total number of activities (tasks and appointments) linked to this project. 
#   Read-only; computed by Coevera.
activitiesTotal: Float 
#   Number of completed activities on this project. Read-only; computed by Coevera.
activitiesCompleted: Float 
#   Display version of the project name, used in lists and references.
formattedName: String! 
#   Timestamp of the most recent modification made by an end user (excluding system 
#   changes). Read-only; computed by Coevera.
modifiedByUser: DateTime 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Arguments
#   entityType: [Not documented]
relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel! 
# Arguments
#   ids: [Not documented]
charts(ids: [UUID!]!): [DashboardChartData!] 
# Arguments
#   id: [Not documented]
#   seriesIndex: [Not documented]
#   itemIndex: [Not documented]
chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel! 
# Arguments
#   ids: Null to load all fields defined on InterfacePreview entity
#   first: [Not documented]
fields(ids: [UUID!], first: Int): [InterfaceFieldData]! 
# Arguments
#   projectObjectiveId: [Not documented]
projectObjectiveActivitiesDrilldown(
projectObjectiveId: UUID
): CompactViewDrilldownModel! 
}
ProjectEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
