Contents

Summary

Contains methods for performing bulk operations upon users and other individuals within the TeamDynamix people database.

API Methods

POST https://services.dartmouth.edu/TDWebApi/api/people/bulk/applydesktop/{templateDesktopId}?linkDesktop={linkDesktop}&isDefault={isDefault} Copy URL

Bulk-applies a desktop template to a set of users.

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 1 call per organization every 120 seconds.

Remarks

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

POST https://services.dartmouth.edu/TDWebApi/api/people/bulk/changeacctdepts Copy URL

Bulk-adds a set of users to a set of accounts. Optionally, supports removing any accounts for the specified users that are not included in the set of accounts.

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 1 call per organization every 120 seconds.

Remarks

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

POST https://services.dartmouth.edu/TDWebApi/api/people/bulk/changeactivestatus?isActive={isActive} Copy URL

Bulk-updates the active status of the set of users.

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 1 call per organization every 120 seconds.

POST https://services.dartmouth.edu/TDWebApi/api/people/bulk/changeapplications Copy URL

Bulk-adds a set of users to a set of applications. Optionally, supports removing any application associations for users.

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 1 call per IP address every 120 seconds.

Remarks

Only full users are able to be granted application permission. Any UIDs that do not correspond to a full user will be skipped. In addition, organizationally defined applications like asset and ticketing applications are not available here. However, access to those applications can be managed through the changeorgapplications endpoint. All users have access to Client Portal automatically.

POST https://services.dartmouth.edu/TDWebApi/api/people/bulk/changeorgapplications Copy URL

Bulk-adds a set of users to a set of organizationally defined applications. Optionally, supports removing organizationally defined application associations for users.

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 1 call per IP address every 120 seconds.

Remarks

Only full users are able to be granted application permission. Any UIDs that do not correspond to a full user will be skipped. ReplaceExistingOrgApplications defaults to False. When ReplaceExistingOrgApplications is True applications that are omitted or paired with an invalid security role ID will be removed for each user provided. When ReplaceExistingOrgApplications is False, this method functions in an add-only manner. External apps are not associated with security roles, any security role ID provided with an external app will be ignored. Changing a user's primary client portal application is not supported through this endpoint. Any attempts to remove the user from their primary client portal application will be ignored, and the user will retain their current primary client portal application access. This end point does not support granting or changing a user's administrator status.

POST https://services.dartmouth.edu/TDWebApi/api/people/bulk/changesecurityrole/{securityRoleId} Copy URL

Bulk-changes the security role of a set of users.

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 1 call per organization every 120 seconds.

Remarks

Only full users are able to have their security role updated. Any UIDs that do not correspond to a full user will be skipped.

POST https://services.dartmouth.edu/TDWebApi/api/people/bulk/managegroups Copy URL

Bulk-adds a set of users to a set of groups. Optionally, supports removing any memberships for those users that are outside of those groups.

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 1 call per IP address every 120 seconds.

Remarks

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