README.md

TeamDynamixLib

Library of TeamDynamix function calls to make my life easier. I will continue to update this project as time permits. https://github.com/clstr/TeamDynamixLib

Dependencies

• DotNet Core 2.1
• RestSharp
• Newtonsoft Json.NET
• TeamDynamix.API

This project does not come with the TeamDynamix API DLL, you will need the TeamDynamix API Library for these functions to work. You can obtain these in TDNext > Downloads > TeamDynamix API .DLL (.NET 4.5.2) .

To build the project

dotnet build

You can always add the project sln to your existing solution

To install as a Nuget package

Install from nuget.org https://www.nuget.org/packages/TeamDynamixLib/

Example Usage

public static async Task Main(string[] args) {
    Console.WriteLine("Hello World!");

    TDXEnvironment tDXEnvironment = new TDXEnvironment {
        ClientUrl = "https://yourSchool.teamDynamix.com/",
        IsSandboxEnvironment = true
    };

    AdminTokenParameters adminTokenParameters = new AdminTokenParameters {
        BEID = Guid.Parse("00000000-0000-0000-0000-000000000000"),
        WebServicesKey = Guid.Parse("00000000-0000-0000-0000-000000000000")
    };

    AuthenticationLib authenticationLib = new AuthenticationLib();
    var JWT = await authenticationLib.GetAuthHeaderAsync(adminTokenParameters, tDXEnvironment);

    TicketLib ticketLib = new TicketLib();
    var ticketDetailsExample1 = await ticketLib.GetTicketAsync(9280401, 431, JWT, tDXEnvironment);
    var ticketDetailsExample2 = await ticketLib.GetTicketAsync(696969, 500, JWT, tDXEnvironment);
    
    PeopleLib peopleLib = new PeopleLib();
    var personDetailsExample1 = await peopleLib.GetPersonByUIDAsync(
        Guid.Parse("00000000-0000-0000-0000-000000000000"), 
        JWT, tDXEnvironment
    );
    
    Ticket ticket = new Ticket() {
        TypeID = 20999,
        Title = "(TEST API IGNORE) Install IIS Latest Version",
        AccountID = 48319,
        StatusID = 17950,
        PriorityID = 3371,
        RequestorUid = Guid.Parse("00000000-0000-0000-0000-000000000000")
    };

    TicketCreateOptions ticketCreateOptions = new TicketCreateOptions() {
        EnableNotifyReviewer = false,
        NotifyRequestor = false,
        NotifyResponsible = false,
        AllowRequestorCreation = false
    };

    var myTicket = await ticketLib.CreateTicketAsync(
        ticket, 431, ticketCreateOptions,
        JWT, tDXEnvironment
    );
}

Note: To run the example above you will need to set your project to use C# version 7.1+ since I am using async in the main function. http://techxposer.com/2017/11/18/enable-c-7-1-projects/

You only need to call GetAuthHeaderAsync() once to get the Json Web Token (JWT), which can be used until it expires. This means you can use the same JWT for all other TDX requests using the same token. https://jwt.io/

What is implemented?

So far i have the following tdx endpoints implemented according to the API Documentation https://solutions.teamdynamix.com/TDWebApi/

Auth

• POST https://solutions.teamdynamix.com/TDWebApi/api/auth/loginadmin
  • Logs in the current session using a special key-based administrative account.

People

• GET https://solutions.teamdynamix.com/TDWebApi/api/people/{uid}
  • Gets a person from the system.
• POST https://solutions.teamdynamix.com/TDWebApi/api/people
  • Creates a user in the system and returns an object representing that person.
• POST https://solutions.teamdynamix.com/TDWebApi/api/people/{uid}
  • Updates a person entry for the user with the specified identifier with a set of new values.
• GET https://solutions.teamdynamix.com/TDWebApi/api/people/{uid}/functionalroles
  • Gets all functional roles for a particular user.
• GET https://solutions.teamdynamix.com/TDWebApi/api/people/lookup?searchText={searchText}&maxResults={maxResults}
  • Performs a restricted lookup of TeamDynamix people. Will not return full user information for each matching user.

Tickets

• GET https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets/impacts
  • Gets all active ticket impacts.
• GET https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets/priorities
  • Gets all active ticket priorities.
• GET https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets/sources
  • Gets all active ticket sources.
• GET https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets/{id}
  • Gets a ticket.
• POST https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets?EnableNotifyReviewer={EnableNotifyReviewer}&NotifyRequestor={NotifyRequestor}&NotifyResponsible={NotifyResponsible}&AllowRequestorCreation={AllowRequestorCreation}
  • Creates a ticket.