Classes
Methods
# async addTaskBundle(projectId, taskBundelToBeAdded) → {Promise.<void>}
Adds the task bundle to the project with the specified id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project to add the task bundle. |
taskBundelToBeAdded |
TaskBundleAddToProjectModel
|
The model to add the task bundle to the project. |
Promise.<void>
# automations(projectId) → {ProjectAutomations}
Returns the ProjectAutomations Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# autopilots(projectId) → {Autopilots}
Returns the Autopilots Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# async create(project) → {Promise.<Project>}
Creates a new project.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
ProjectCreateModel
|
The project creation object |
Promise.<Project>
# async delete(projectId, optionsopt) → {Promise.<void>}
Deletes the project with the specified id. In the default case the related tasks of this project will also be deleted and the related time trackings of this project and all tasks loose the relation to the deleted project and tasks. To delete the time trackings as well, it is necessary to set the 'DeleteTimeTrackings' property of the post model to true.
The user can delete a project if he is the owner or he needs 'write' permissions of the feature 'project-master-data
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
String
|
The id of the project. | |
options |
DeleteProjectOptions
|
<optional> |
Promise.<void>
# entityTags(projectId)
Returns the EntityTags Endpoint with the specified project Id and name.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
- Deprecated:
- Yes
# files(projectId) → {EntityFiles}
Returns the EntityFiles Endpoint with the specified project Id and entityType 'projects'.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# async get(projectId) → {Promise.<Project>}
Returns the project with the specified id if the user has 'read' permissions of feature 'project-master-data'.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
Promise.<Project>
# images(projectId) → {EntityImages}
Returns the EntityImages Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# async list(optionsopt) → {Promise.<Array.<Project>>}
Returns all projects the user has 'read' permissions of feature 'project-master-data' for.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
ListOptions
|
<optional> |
Pagination and filtering options |
Promise.<Array.<Project>>
# members(projectId) → {ProjectMembers}
Returns the ProjectMembers Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# async milestoneList(projectId) → {Promise.<Array.<ProjectMilestone>>}
Returns all project milestones of the specified project. The user needs 'read' permissions of feature 'project-planning-data' to get the data.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
Promise.<Array.<ProjectMilestone>>
# projectStatuses(projectId) → {ProjectProjectStatus}
Returns the ProjectProjectStatuses Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
ProjectProjectStatus
# projectSubtasks(projectId) → {ProjectsSubtasks}
Returns the ProjectsSubtasks Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
ProjectsSubtasks
# tags(projectId)
Returns the EntityTags Endpoint with the specified project Id and name.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# async taskDependencyList(projectId) → {Promise.<Array.<TaskDependency>>}
Returns all task dependencies for a specific project. To get all dependencies of a project, the user needs project planning permissions on that project.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
Promise.<Array.<TaskDependency>>
# taskLists(projectId) → {TaskLists}
Returns the TaskLists Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# tasks(projectId) → {ProjectTasks}
Returns the ProjectTasks Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# taskStatuses(projectId) → {ProjectTaskStatuses}
Returns the ProjectTaskStatuses Endpoint with the specified project Id.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
# async update(projectId, project) → {Promise.<Project>}
Updates the project with the specified id.
The user can update a project if he is the owner or he needs 'write' permissions of the feature 'project-master-data'.
Parameters:
| Name | Type | Description |
|---|---|---|
projectId |
String
|
The id of the project. |
project |
ProjectUpdateModel
|
The project update object |
Promise.<Project>