Skip to content
This repository has been archived by the owner on Dec 12, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clstr authored Sep 6, 2019
1 parent 5bdd5e1 commit e316854
Showing 1 changed file with 29 additions and 29 deletions.
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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!");
Expand Down Expand Up @@ -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.

0 comments on commit e316854

Please sign in to comment.