TeamDynamix API Guide: How to Connect and Use TDX Data

New guide shows how to use TeamDynamix APIs for better data connection. This helps users access and change information in the TDX system easily.
By Newsroom | Technology, Higher Education |

Recent developments and existing documentation highlight a significant push toward leveraging TeamDynamix (TDX)'s Application Programming Interfaces (APIs) for enhanced integration and service configuration. The core functionality revolves around accessing and manipulating data within the TDX platform, ranging from creating accounts and rooms to retrieving detailed group and user information.

Diving Into the Technical Underpinnings

Documentation published on the U-M TDX portal details the pathway to engaging with these APIs. Access to the 'API Directory', which lists available TDX APIs, requires a U-M login and a VPN connection. Within this directory, users can find the 'TDXTicketInfo API' and potentially subscribe to it after account activation.

  • The process for configuring web services within TDX involves navigating through TDAdmin > Workflow Web Services.

  • Users are guided to create 'Web Service Providers' and then 'Web Service Methods', specifying HTTP methods like GET, POST, PUT, and PATCH.

  • Essential components such as headers, parameters, and request bodies are part of this configuration.

A Python library, documented at tdxlib.readthedocs.io, offers a programmatic interface for interacting with these TDX features. This library includes functions for:

  • Creating user accounts (create_account), rooms (create_room), and associated attributes.

  • Retrieving data for groups (get_group_by_id, get_group_by_name), members (get_group_members_by_id, get_group_members_by_name), locations (get_location_by_id, get_location_by_name), and individual persons (get_person_by_name_email, get_person_by_uid).

  • Fetching account information (get_account_by_id, get_account_by_name, get_all_accounts) and custom attributes.

  • A generic make_get function for direct HTTP GET requests to the TDX API.

Authentication and Data Formatting

When interacting with the TDX Web API, specific formatting and authentication protocols are crucial. Requests must generally include a Content-Type: application/json header, and data is often structured using JSON Patch documents.

Read More: API Documentation Replaces Websites as New Storefronts for AI

  • Endpoints designed for file uploads will necessitate a Content-Type: multipart/form-data header.

  • Authentication is handled via JSON Web Tokens (JWTs), which can be obtained through standard authentication mechanisms and reused across multiple requests.

Community and Contribution

The GitHub repository TeamDynamix/tdx-quickstart-integrations serves as a hub for integration examples and documentation. This repository encourages contributions from users who wish to share their experiences and code related to TDX integrations. A 'Contributing Guide' and 'Code of Conduct' are provided for those interested in submitting pull requests to enhance the repository's content.

Additional guides, found on sites like help.unlv.edu, offer practical steps on creating web service authentication accounts, providers, and specific web service methods for tasks such as updating employee IDs, sending workflow reminders, and posting approval comments via the TDX API.

Frequently Asked Questions

Q: How can I access the TeamDynamix API Directory?
You need a U-M login and a VPN connection to access the API Directory on the U-M TDX portal. This directory lists all available TDX APIs.
Q: What steps are needed to configure web services in TDX?
In TDX, go to TDAdmin > Workflow Web Services. You will create 'Web Service Providers' and 'Web Service Methods', setting details like HTTP methods (GET, POST, PUT, PATCH), headers, and parameters.
Q: How does authentication work with the TDX Web API?
Authentication is done using JSON Web Tokens (JWTs). You can get these tokens through standard login methods and use them for many requests. A 'Content-Type: application/json' header is usually needed.
Q: Where can I find examples for TeamDynamix integrations?
The GitHub repository 'TeamDynamix/tdx-quickstart-integrations' has examples and guides. You can also contribute your own code and experiences there to help others.
Q: What can the Python tdxlib library do?
The tdxlib Python library lets you interact with TDX features. You can create accounts and rooms, get group and user details, find locations, and fetch account information programmatically.