Documentation

Class

Project

Project(data)

Project Model
Constructor

# new Project(data)

Model constructor
Parameters:
Name Type Description
data ProjectLike

View Source model/Project.js, line 9

Classes

Project

Members

String

# closedBy

The user who closed the project.

View Source model/Project.js, line 147

String

# closedOn

The date the project was set to closed.

View Source model/Project.js, line 139

Object

# company

company properties

View Source model/Project.js, line 244

String

# companyDescription

The description of the company.

View Source model/Project.js, line 260

Boolean

# companyHasImage

Whether the company has a profile image.

View Source model/Project.js, line 252

String

# companyId

uuid

View Source model/Project.js, line 274

String

# companyName

nullable

View Source model/Project.js, line 267

Array.<{id: String, name: String, entityId: String}>

# companyTags

The Tags of the company.

View Source model/Project.js, line 282

String

# createdBy

The id of the user who created this entity.

View Source model/Project.js, line 115

String

# createdByProjectTemplateId

The id of the template the project was created from.

View Source model/Project.js, line 155

String

# createdOn

The date this entity was created.

View Source model/Project.js, line 107

String

# description

The project description.

View Source model/Project.js, line 34

String

# dueDate

The due date of the project

View Source model/Project.js, line 51

Boolean

# hasImage

Whether the project has an image.

View Source model/Project.js, line 91

String

# id

Id of the project. Required.

View Source model/Project.js, line 83

Boolean

# isBillableByDefault

Whether the project times should be billable by default.

View Source model/Project.js, line 67

String

# key

The unique key of the project. Required.

View Source model/Project.js, line 99

Array.<MemberProperties>

# members

The members of this project.

View Source model/Project.js, line 348

String

# name

The name of the Project. Required.

View Source model/Project.js, line 26

Number

# plannedDuration

The total planned time of the project, in seconds. The time is calculated of the planned duration by all project tasks.

View Source model/Project.js, line 310

Object

# projectStatus

projectStatus

View Source model/Project.js, line 194

String

# projectStatusDescription

nullable

View Source model/Project.js, line 216

String

# projectStatusId

uuid

View Source model/Project.js, line 237

Boolean

# projectStatusIsArchived

View Source model/Project.js, line 209

String

# projectStatusName

nullable

View Source model/Project.js, line 230

String

# projectStatusType

nullable

View Source model/Project.js, line 223

Number

# projectStatusTypeOrder

The order of the status type.

View Source model/Project.js, line 202

Icon

# projectTypeIcon

nullable

View Source model/Project.js, line 173

String

# projectTypeId

uuid

View Source model/Project.js, line 187

Boolean

# projectTypeIsArchived

View Source model/Project.js, line 166

String

# projectTypeName

nullable

View Source model/Project.js, line 180

Number

# resourceVersion

The version of the entity continuously incremented.

View Source model/Project.js, line 364

String

# startDate

The start date of the project

View Source model/Project.js, line 42

Array.<TagObject>

# tags

The tags for this project.

View Source model/Project.js, line 302

Number

# tasksCount

The number of all tasks related to the project.

View Source model/Project.js, line 318

Number

# tasksDoneCount

The number of all tasks in status 'done' related to the project.

View Source model/Project.js, line 326

Array.<{id: String, name: String, color: Color, icon:Icon}>

# teams

The teams the project is associated to.

View Source model/Project.js, line 372

Number

# timeBudget

The time budget the project has in seconds.

View Source model/Project.js, line 59

Number

# trackedDuration

The summed up duration of all time trackings for this project.

View Source model/Project.js, line 356

String

# updatedBy

The id of the user who last modified this entity.

View Source model/Project.js, line 131

String

# updatedOn

The date this entity was last modified.

View Source model/Project.js, line 123

String

# workspaceId

The workspace id of the project

View Source model/Project.js, line 75