Contents

Summary

Contains methods for working with groups within the TeamDynamix people database.

API Methods

POST https://services.dartmouth.edu/TDWebApi/api/groups Copy URL

Creates a new group.

Parameters

Returns

A newly created group.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 45 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/groups/{id} Copy URL

Gets a group.

Parameters

Returns

Access Restrictions

This action requires access to the TDPeople application.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://services.dartmouth.edu/TDWebApi/api/groups/{id} Copy URL

Edits an existing group.

Parameters

Returns

The updated group, if the operation was successful. (TeamDynamix.Api.Users.Group)

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 45 calls per IP address every 60 seconds.

DELETE https://services.dartmouth.edu/TDWebApi/api/groups/{id}/applications Copy URL

Unassociates a collection of platform applications from a group.

Parameters

Returns

A response message indicating if the operation was successful or not.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 45 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/groups/{id}/applications Copy URL

Gets the applications associated with the specified group.

Parameters

Returns

A list of group-application associations for the specified group. (TeamDynamix.Api.Users.GroupApplication[])

Access Restrictions

This action requires access to the TDPeople application.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://services.dartmouth.edu/TDWebApi/api/groups/{id}/applications Copy URL

Associates a collection of platform applications with a group. Existing application associations will not be affected.

Parameters

Returns

A response message indicating if the operation was successful or not.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 45 calls per IP address every 60 seconds.

Remarks

Only ticketing applications are able to be associated with a group. Any applications that do not correspond to a ticketing application will be skipped.

DELETE https://services.dartmouth.edu/TDWebApi/api/groups/{id}/members Copy URL

Removes a collection of users from a group.

Parameters

Returns

A response message indicating if the operation was successful or not.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 45 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/groups/{id}/members Copy URL

Gets the users belonging to a group.

Parameters

Returns

The list of users belonging to the group. (TeamDynamix.Api.Users.GroupMember[])

Access Restrictions

This action requires access to the TDPeople application.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://services.dartmouth.edu/TDWebApi/api/groups/{id}/members?isPrimary={isPrimary}&isNotified={isNotified}&isManager={isManager} Copy URL

Adds a collection of users to a group. Users that did not exist in the group beforehand will have their settings set to the specified values. Existing users will not have their settings overwritten.

Parameters

Returns

A response message indicating if the operation was successful or not.

Access Restrictions

This action can only be performed by special key-based administrative service accounts and not standard TeamDynamix users.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 45 calls per IP address every 60 seconds.

Remarks

Only full users are able to be assigned to a group. Any UIDs that do not correspond to a full user will be skipped.

POST https://services.dartmouth.edu/TDWebApi/api/groups/search Copy URL

Gets a list of groups.

Parameters

Returns

A collection of groups. (TeamDynamix.Api.Users.Group[])

Access Restrictions

This action requires access to the TDPeople application.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.