From e316854ef880610e85e646d599cf5cc2e20db5b7 Mon Sep 17 00:00:00 2001 From: Serg <1195526+clstr@users.noreply.github.com> Date: Fri, 6 Sep 2019 14:37:03 -0400 Subject: [PATCH] Update README.md --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 627ad38..a3c4994 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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 +### Dependencies - DotNet Core 2.1 - RestSharp - Newtonsoft Json.NET @@ -11,12 +11,12 @@ https://github.com/clstr/TeamDynamixLib 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 +### To build the project > dotnet build You can always add the project sln to your existing solution too or as a nuget package. -#### To install as a Nuget package +### To install as a Nuget package Install from nuget.org https://www.nuget.org/packages/TeamDynamixLib/ Create the package yourself: Set the project to Release and publish it. After it's published (Framework Dep, Portable) you will get a nupkg in your bin\Release\netcoreapp2.x\publish\ folder. Install the nupkg file to your project. @@ -25,7 +25,7 @@ https://stackoverflow.com/questions/10240029/how-do-i-install-a-nuget-package-nu After it installs you can verify by looking at your project's dependencies in the solution explorer. -#### Example Usage +### Example Usage ```csharp public static async Task Main(string[] args) { Console.WriteLine("Hello World!"); @@ -87,29 +87,29 @@ https://jwt.io/ 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 +#### Auth +- POST https://solutions.teamdynamix.com/TDWebApi/api/auth/loginadmin -##### 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. +#### 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.