Unless explicitly stated on the documentation for a method, the accepted Web API call content types are:
Calls using any other content type (ex: text/plain) are not supported.
-
APIs
-
Projects
Contents
Summary
Contains methods for working with
projects.
API Methods
GET
https://helpdesk.grps.org/TDWebApi/api/projects/{id}
Copy URL
Gets a project.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
PATCH
https://helpdesk.grps.org/TDWebApi/api/projects/{id}
Copy URL
Patches an existing project.
This only supports patching the project itself and custom attributes. Other collections on
the asset are not supported.
About PATCH Support
For information on how to structure HTTP PATCH calls, see the
HTTP PATCH Support page.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
Request Body
(Validated as "patch")
-
Type
-
PatchDocument<TeamDynamix.Api.Projects.Project>
-
Source
-
Request Body
-
Description
-
The patch document containing changes to apply to the project.
Access Restrictions
This action requires access to one of the following applications:
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
The following requirements must be met by the caller to edit a project:
- The caller must have TDNext access, as well as Analysis or Projects access.
- The caller must be an admin service account, the project manager, an alternate manager,
or a program/portfolio manager with permissions to manage projects in their program/portfolio.
POST
https://helpdesk.grps.org/TDWebApi/api/projects/{id}
Copy URL
Edits an existing project, saving custom attribute changes, and basic properties as needed.
For best results, call GetProject, modify fields as needed, and then call this method.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
Request Body
(Validated as "project")
-
Type
-
TeamDynamix.Api.Projects.Project
-
Source
-
Request Body
-
Description
-
The project with updated values.
Access Restrictions
This action requires access to one of the following applications:
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
GET
https://helpdesk.grps.org/TDWebApi/api/projects/{id}/feed
Copy URL
Gets the feed entries for a project.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
Access Restrictions
This action requires access to one of the following applications:
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
The replies and
likes collections will
not be returned by this endpoint.
However, replies count,
likes count, and
"liked by me" flag values will be loaded.
To retrieve replies and likes, query the single feed entry retrieval endpoint
using the individual entry's URI.
POST
https://helpdesk.grps.org/TDWebApi/api/projects/{id}/feed
Copy URL
Adds a feed entry to a project.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
Request Body
(Validated as "update")
-
Type
-
TeamDynamix.Api.Feed.ItemUpdate
-
Source
-
Request Body
-
Description
-
No documentation found.
Access Restrictions
This action requires access to one of the following applications:
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
GET
https://helpdesk.grps.org/TDWebApi/api/projects/{id}/resources
Copy URL
Gets the resources for a project.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project id
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
POST
https://helpdesk.grps.org/TDWebApi/api/projects/{id}/resources/{resourceUid}?notifyManagers={notifyManagers}¬ifyResource={notifyResource}
Copy URL
Adds a resource to a project.
Parameters
-
-
Parameter Name
-
id
-
Type
-
Int32
-
Source
-
URI
-
Description
-
The project ID.
-
-
Parameter Name
-
resourceUid
-
Type
-
Guid
-
Source
-
URI
-
Description
-
The UID of the resource to add.
-
-
Parameter Name
-
notifyManagers
-
Type
-
Boolean
-
Source
-
URI
-
Default
-
This parameter is optional, with a default value of
False.
-
Description
-
Whether or not to notify the project manager, alternate managers
and any relevant resource pool managers about the new project resource.
-
-
Parameter Name
-
notifyResource
-
Type
-
Boolean
-
Source
-
URI
-
Default
-
This parameter is optional, with a default value of
False.
-
Description
-
Whether or not to notify the project resource that they have been
added to the project.
Access Restrictions
This action requires access to one of the following applications:
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
This endpoint emulates the behavior to add resources to projects as seen in TDNext with a few notable exceptions:
- No schedules will be set via this endpoint.
- Resource requests will not be generated even if they normally would in the UI.
- Resource employee status and capacity date requirements will be ignored.
The following requirements must be met by the caller to add resources to a project:
- The project must be open (though active is not a requirement).
- The project cannot be the private team or a template project.
- The caller must have TDNext access, as well as Analysis or Projects access.
- The caller must be an admin service account, the project manager, an alternate manager,
or a program/portfolio manager with permissions to manage projects in their program/portfolio.
The specified resource to add to the project must meet the following requirements:
- Be an active user of type User or
Resource Placeholder
- Have access to TDNext and Projects, or have Client Portal View Projects permissions in at
least one Client Portal.
- Have a primary functional role.
- Not be on the project already.
GET
https://helpdesk.grps.org/TDWebApi/api/projects/feed?DateFrom={DateFrom}&DateTo={DateTo}&ReplyCount={ReplyCount}&ReturnCount={ReturnCount}
Copy URL
Gets the feed items for the Projects application matching
the specified criteria.
Access Restrictions
This action requires access to the TDProjects application.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
GET
https://helpdesk.grps.org/TDWebApi/api/projects/list
Copy URL
Gets a list of plans that the user is on the project of.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
POST
https://helpdesk.grps.org/TDWebApi/api/projects/search
Copy URL
Gets a list of projects. Will not return full project information.
Access Restrictions
This action requires access to the TDAnalysis application.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
The following properties will not be included in the results:
- Attributes
- CustomColumns
- NonWorkingDays
To retrieve such information, you must load a project individually.
POST
https://helpdesk.grps.org/TDWebApi/api/projects?notifyNewManager={notifyNewManager}¬ifyNewAltManagers={notifyNewAltManagers}
Copy URL
Creates a project.
Parameters
-
-
Parameter Name
-
notifyNewManager
-
Type
-
Boolean
-
Source
-
URI
-
Default
-
This parameter is optional, with a default value of
False.
-
Description
-
Whether or not to notify the new project manager
about the new project. Notifications to self will not be sent if the caller (creator) is set
as the new project's manager.
-
-
Parameter Name
-
notifyNewAltManagers
-
Type
-
Boolean
-
Source
-
URI
-
Default
-
This parameter is optional, with a default value of
False.
-
Description
-
Whether or not to notify the new alternate managers
about the new project. Notifications to self will be sent if the caller (creator) is set
as one of the new project's alternate managers.
-
-
Parameter Name
-
Request Body
(Validated as "project")
-
Type
-
TeamDynamix.Api.Projects.NewProject
-
Source
-
Request Body
-
Description
-
The project to create.
Returns
The created project if the operation was successful.
Access Restrictions
This action requires access to the TDProjects application.
This action requires the "Project: Add Projects" permission.
Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of
60 calls
per IP address
every 60 seconds.
Remarks
This endpoint emulates the project creation process in TDNext with a few notable exceptions:
- The project manager and alternate managers may be explicitly set differently from the calling user.
- No resource requests will be generated for project or alternate managers.
- Project/alternate manager employee status and capacity date requirements will be ignored.
- Adding a project to a portfolio or program is not supported.
The following requirements must be met by the caller to create a project:
- The caller must have TDNext access, as well as full TDProjects access.
- The caller must have the global security role permission to Add Projects.
The specified new project manager/alternate managers must meet the following requirements:
- Be an active user of type User
(neither service accounts nor resource placeholders of any kind can be project managers).
- Have access to both the TDNext and TDProjects applications
(access to view projects in a Client Portal is insufficient).
- Have a primary functional role.