TeamDynamix Web API

https://solutions.teamdynamix.com/TDWebApi
Admin
TeamDynamix Web API provides RESTful web services for integrating with TeamDynamix solution modules...
Tokens:202,579
Snippets:935
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /api/projects/list

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Projects

Retrieves a list of plans that the user is associated with on projects.

```APIDOC
## GET /api/projects/list

### Description
Gets a list of plans that the user is on the project of.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/list

### Response
#### Success Response (200)
- **plans** (Array of objects) - A list of project plans.

#### Response Example
[
  {
    "id": 1,
    "name": "Project Plan Alpha"
  }
]

#### Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/people/getuid/{username}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/People

Retrieves the unique identifier (GUID) of a person from the system using their username.

```APIDOC
## GET /api/people/getuid/{username}

### Description
Gets the GUID of a person from the system by their username.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/people/getuid/{username}

### Parameters
#### Path Parameters
- **username** (String) - Required - The username of the person.

### Response
#### Success Response (200 OK)
- **uid** (Guid) - The unique identifier (GUID) of the person.

#### Response Example
```json
"a1b2c3d4-e5f6-7890-1234-567890abcdef"
```
```

--------------------------------

### GET /api/{appId}/cmdb/{id}/articles

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItems

Retrieves a list of knowledge base articles associated with a configuration item. Rate limited to 60 calls per IP address every 60 seconds.

```APIDOC
## GET /api/{appId}/cmdb/{id}/articles

### Description
Gets a list of the knowledge base articles associated with the specified configuration item.

### Method
GET

### Endpoint
`https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/{id}/articles`

### Parameters
#### Path Parameters
- **appId** (string) - Required - The application ID.
- **id** (Int32) - Required - The configuration item ID.

### Response
#### Success Response (200)
- **TeamDynamix.Api.KnowledgeBase.Article[]** - The associated knowledge base articles.

### Rate Limiting
60 calls per IP address every 60 seconds.
```

--------------------------------

### POST /api/{appId}/cmdb/search

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItems

Retrieves a list of configuration items based on specified search parameters. Does not return full CI details and is rate-limited.

```APIDOC
## POST /api/{appId}/cmdb/search

### Description
Gets a list of configuration items. Will not return full configuration item information.

### Method
POST

### Endpoint
/api/{appId}/cmdb/search

### Parameters
#### Request Body
- **search** (TeamDynamix.Api.Cmdb.ConfigurationItemSearch) - Required - The searching parameters to use.

### Request Example
(Example not provided in source)

### Response
#### Success Response (200)
A list of configuration items. (TeamDynamix.Api.Cmdb.ConfigurationItem[])

#### Error Response
(Details not provided in source)

### Rate Limitations
60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/people/getuid/{username}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/People

Retrieves the unique identifier (GUID) of a person from the system using their username. Requires access to the TDPeople application.

```APIDOC
## GET /api/people/getuid/{username}

### Description
Gets the GUID of a person from the system by their username.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/people/getuid/{username}

### Parameters
#### Path Parameters
- **username** (String) - Required - The username of the person.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **guid** (String) - The GUID of the person if found.

#### Response Example
```json
{
  "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Rate/Submission Limitations
180 calls per IP address every 60 seconds.
```

--------------------------------

### POST /api/{appId}/knowledgebase

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/KnowledgeBase

Creates a new Knowledge Base article. Rate-limited to 60 calls per IP address per 60 seconds. Permissions are inherited from the parent category or defaulted to public for root-level articles.

```APIDOC
## POST /api/{appId}/knowledgebase

### Description
Creates a Knowledge Base article.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/knowledgebase

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **article** (TeamDynamix.Api.KnowledgeBase.Article) - Required - The article object to be created.

### Request Example
```json
{
  "title": "Example Article Title",
  "content": "This is the content of the example article.",
  "categoryId": 123
}
```

### Response
#### Success Response (200)
- **article** (TeamDynamix.Api.KnowledgeBase.Article) - The created article object.

#### Response Example
```json
{
  "id": 456,
  "title": "Example Article Title",
  "content": "This is the content of the example article.",
  "categoryId": 123,
  "createdDate": "2023-10-27T10:00:00Z",
  "modifiedDate": "2023-10-27T10:00:00Z"
}
```

### Rate Limiting
60 calls per IP address every 60 seconds.

### Remarks
Permissions are inherited from the parent category or defaulted to public for root-level articles. Public status and other permissions cannot be changed via this method.
```

--------------------------------

### Manage User Application Access - Examples

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/People

Examples demonstrating how to manage user access to standard and organizationally-defined applications. These examples show full replacement of application lists and how to clear all access or make no changes.

```json
{
  "Applications": ["TDNext","MyWork"]
}
```

```json
{
  "Applications": []
}
```

```json
{
  "Applications": null
}
```

```json
{
  "OrgApplications": [{"id":1,"securityroleid":"role1here"},{"id":2,"securityroleid":"role2here"}]
}
```

```json
{
  "OrgApplications": []
}
```

```json
{
  "OrgApplications": null
}
```

--------------------------------

### POST /projects/{projectId}/plans/search

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Plans

Searches for and retrieves a list of project plans based on specified criteria.

```APIDOC
## POST /projects/{projectId}/plans/search

### Description
Gets a list of plans.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/plans/search

### Parameters
#### Path Parameters
- **projectId** (Int32) - Required - The project ID.
```

--------------------------------

### GET /api/{appId}/tickets/responseTemplates

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Tickets

Gets a list of eligible assignments for the ticketing application.

```APIDOC
## GET /api/{appId}/tickets/responseTemplates

### Description
Gets a list of eligible assignments for the ticketing application.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets/responseTemplates?categoryId={categoryId}&searchText={searchText}

### Parameters
#### Query Parameters
- **categoryId** (Int32) - Optional - The category ID to filter assignments.
- **searchText** (String) - Optional - Text to search for within assignment names.

### Request Example
```
GET https://solutions.teamdynamix.com/TDWebApi/api/123/tickets/responseTemplates?categoryId=456&searchText=example
```

### Response
#### Success Response (200)
- **assignments** (Array) - A list of eligible assignments.
```

--------------------------------

### POST /api/{appId}/cmdb/maintenancewindows

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/MaintenanceSchedules

Creates a new maintenance window. This endpoint is rate-limited.

```APIDOC
## POST /api/{appId}/cmdb/maintenancewindows

### Description
Creates a maintenance window.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/maintenancewindows

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **window** (TeamDynamix.Api.Cmdb.MaintenanceSchedule) - Required - The maintenance window details.

### Request Example
```json
{
  "window": {
    "ExampleField": "ExampleValue"
  }
}
```

### Response
#### Success Response (200)
- **TeamDynamix.Api.Cmdb.MaintenanceSchedule** - The created maintenance window if the operation was successful.

### Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of **60 calls** per **IP address** every **60 seconds**.
```

--------------------------------

### GET /api/{appId}/services/{id}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ServiceCatalog

Gets a specific Service Catalog service by its ID.

```APIDOC
## GET /api/{appId}/services/{id}

### Description
Gets a specific Service Catalog service by its ID.

### Method
GET

### Endpoint
/api/{appId}/services/{id}

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.
- **id** (Int32) - Required - The ID of the service to retrieve.
```

--------------------------------

### GET /api/{appId}/services

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ServiceCatalog

Gets all services that are visible to the user. This endpoint will not return all service information.

```APIDOC
## GET /api/{appId}/services

### Description
Gets all services that are visible to the user. This endpoint will not return all service information.

### Method
GET

### Endpoint
/api/{appId}/services

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Remarks
Properties like ServiceOfferings, Attachments, Attributes, and LongDescription will not be included in the results. Load services individually to retrieve this information.
```

--------------------------------

### POST /api/{appId}/cmdb/search

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItems

Searches for configuration items. This endpoint does not return full configuration item details.

```APIDOC
## POST /api/{appId}/cmdb/search

### Description
Gets a list of configuration items. Will not return full configuration item information.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/search

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **searchCriteria** (object) - Required - The criteria to use for searching.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **Array of partial configuration item data**

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### POST /api/{appId}/assets/vendors

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Vendors

Creates a new vendor in the system.

```APIDOC
## POST /api/{appId}/assets/vendors

### Description
Creates a new vendor.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/assets/vendors

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **vendor** (TeamDynamix.Api.Assets.Vendor) - Required - The vendor object to be created.

### Request Example
```json
{
  "Name": "New Vendor Inc.",
  "IsActive": true
  // ... other vendor properties
}
```

### Response
#### Success Response (200)
- **TeamDynamix.Api.Assets.Vendor** - The created vendor object.

#### Response Example
```json
{
  "Id": 101,
  "Name": "New Vendor Inc.",
  "IsActive": true
  // ... other vendor properties
}
```
```

--------------------------------

### GET /api/{appId}/services/categories

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ServiceCatalog

Gets the categories for the service catalog. You can filter by the active status of the categories.

```APIDOC
## GET /api/{appId}/services/categories

### Description
Gets the categories for the service catalog. You can filter by the active status of the categories.

### Method
GET

### Endpoint
/api/{appId}/services/categories

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Query Parameters
- **isActive** (Boolean) - Optional - Filters categories to only return active ones if true, or inactive ones if false.
```

--------------------------------

### GET /api/{appId}/services/icons

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ServiceCatalog

Gets the valid Font-Awesome icons, and their associated integer codes, to use with service catalog items (such as categories and service offerings).

```APIDOC
## GET /api/{appId}/services/icons

### Description
Gets the valid Font-Awesome icons, and their associated integer codes, to use with service catalog items (such as categories and service offerings).

### Method
GET

### Endpoint
/api/{appId}/services/icons

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.
```

--------------------------------

### POST /api/{appId}/cmdb

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItems

Creates a new configuration item within a specified application.

```APIDOC
## POST /api/{appId}/cmdb

### Description
Creates a configuration item.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **item** (TeamDynamix.Api.Cmdb.ConfigurationItem) - Required - The configuration item details.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **TeamDynamix.Api.Cmdb.ConfigurationItem** - The created configuration item.

#### Response Example
```json
{
  "example": "response body"
}
```

### Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of 240 calls per IP address every 60 seconds.
```

--------------------------------

### POST /api/{appId}/assets/models

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ProductModels

Creates a new product model. Requires a request body containing the product model details and is subject to specific rate limits.

```APIDOC
## POST /api/{appId}/assets/models

### Description
Creates a new product model.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/assets/models

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Query Parameters
None

#### Request Body
- **productModel** (TeamDynamix.Api.Assets.ProductModel) - Required - The product model to be created.

### Request Example
```json
{
  "Name": "New Model",
  "Description": "Details of the new model."
  // ... other properties
}
```

### Response
#### Success Response (200)
- **TeamDynamix.Api.Assets.ProductModel** - The newly created product model.

#### Response Example
```json
{
  "Id": 2,
  "Name": "New Model",
  "Description": "Details of the new model."
  // ... other properties
}
```

#### Rate/Submission Limitations
240 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/projects/{projectId}/plans/{planId}/tasks

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Plans

Retrieves all tasks associated with a specific plan. This endpoint is useful for getting a comprehensive list of tasks within a plan.

```APIDOC
## GET /api/projects/{projectId}/plans/{planId}/tasks

### Description
Gets the tasks for a plan. This endpoint is useful for getting a comprehensive list of tasks within a plan.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/plans/{planId}/tasks

### Parameters
#### Path Parameters
- **projectId** (Int32) - Required - The project ID.
- **planId** (Int32) - Required - The plan ID.

### Response
#### Success Response (200)
- **TeamDynamix.Api.Plans.Task[]** - The plan's tasks.

#### Response Example
```json
[
  {
    "id": 789,
    "title": "Task 1",
    "description": "Details of Task 1."
  }
]
```

#### Rate/Submission Limitations
- 90 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/{appId}/cmdb/{id}/articles

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItems

Retrieves a list of knowledge base articles associated with a specific configuration item.

```APIDOC
## GET /api/{appId}/cmdb/{id}/articles

### Description
Gets a list of the knowledge base articles associated with the specified configuration item.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/{id}/articles

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.
- **id** (Int32) - Required - The configuration item ID.

### Response
#### Success Response (200)
- **Array of knowledge base articles**

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Tickets SLA Assignment Options - Start Basis

Source: https://solutions.teamdynamix.com/TDWebApi/Home/member/TeamDynamix.Api.Tickets.SlaAssignmentOptions

Explains the SLA deadline start basis for TeamDynamix tickets. The default is SlaStartBasis.CurrentDateTime. Other options are available and detailed in the property's documentation.

```APIDOC
## TeamDynamix.Api.Tickets.SlaAssignmentOptions.StartBasis

### Description
The SLA deadline start basis defines when the SLA timer begins for a ticket. The default value for this property is `SlaStartBasis.CurrentDateTime`. Refer to the specific property documentation for a complete list of available SLA start basis options.

### Data Type and Notes
**Type:** TeamDynamix.Api.Tickets.SlaStartBasis

**Options:**
*   `SlaStartBasis.CurrentDateTime`: The SLA timer starts at the current date and time.

```

--------------------------------

### Example File Submission using HTTP

Source: https://solutions.teamdynamix.com/TDWebApi/Home/AboutFileSubmission

Demonstrates the structure of an HTTP POST request for submitting files to the TeamDynamix Web API. It specifies the `multipart/form-data` content type with a custom boundary and includes example headers for content disposition and type, followed by file content.

```http
POST /api/items/1/attachments HTTP/1.1
Content-Type: multipart/form-data; boundary=CHANGEME

--CHANGEME
Content-Disposition: form-data; name="aeneid.txt"; filename="aeneid.txt"
Content-Type: application/octet-stream

FORSAN ET HAEC OLIM MEMINISSE IUVABIT
--CHANGEME--
```

--------------------------------

### POST /api/{appId}/tickets/blackoutwindows

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/BlackoutWindows

Creates a new blackout window. The request body must contain the blackout window details. This endpoint is rate-limited.

```APIDOC
## POST /api/{appId}/tickets/blackoutwindows

### Description
Creates a blackout window.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets/blackoutwindows

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **window** (TeamDynamix.Api.Cmdb.BlackoutWindow) - Required - The blackout window object to create.
  - **name** (string) - Required - The name of the blackout window.
  - **description** (string) - Optional - A description for the blackout window.
  - **startTime** (string) - Required - The start time of the blackout window (ISO 8601 format).
  - **endTime** (string) - Required - The end time of the blackout window (ISO 8601 format).
  - **appId** (Int32) - Required - The application identifier.

### Request Example
```json
{
  "name": "Emergency Maintenance",
  "description": "Urgent system update",
  "startTime": "2023-10-27T14:00:00Z",
  "endTime": "2023-10-27T16:00:00Z",
  "appId": 123
}
```

### Response
#### Success Response (200)
- **createdBlackoutWindow** (TeamDynamix.Api.Cmdb.BlackoutWindow) - The newly created blackout window object.

#### Response Example
```json
{
  "id": 2,
  "name": "Emergency Maintenance",
  "description": "Urgent system update",
  "startTime": "2023-10-27T14:00:00Z",
  "endTime": "2023-10-27T16:00:00Z",
  "appId": 123
}
```
```

--------------------------------

### POST /api/projects/{id}/resources

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Projects

Adds a specified resource to a project. This endpoint allows administrators to assign users or placeholders to projects, with options to notify relevant parties.

```APIDOC
## POST /api/projects/{id}/resources

### Description
Adds a resource to a project. This endpoint allows the assignment of users or resource placeholders to a project, with optional notifications to managers and the resource itself.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/{id}/resources/{resourceUid}?notifyManagers={notifyManagers}&notifyResource={notifyResource}

### Parameters
#### Path Parameters
- **id** (Int32) - Required - The project ID.
- **resourceUid** (Guid) - Required - The UID of the resource to add.

#### Query Parameters
- **notifyManagers** (Boolean) - Optional - Defaults to `False`. Whether or not to notify project managers, alternate managers, and resource pool managers.
- **notifyResource** (Boolean) - Optional - Defaults to `False`. Whether or not to notify the resource that they have been added to the project.

#### Request Body
None

### Request Example
```
POST https://solutions.teamdynamix.com/TDWebApi/api/projects/456/resources/a1b2c3d4-e5f6-7890-1234-567890abcdef?notifyManagers=true&notifyResource=true
```

### Response
#### Success Response (200)
- **TeamDynamix.Api.Projects.Resource** - The full project user information for the newly added resource.

#### Response Example
```json
{
  "Id": 988,
  "UserId": 101,
  "User": {
    "Id": 101,
    "Name": "Jane Smith",
    "EmployeeID": "JS456",
    "Email": "jane.smith@example.com"
  },
  "Role": {
    "Id": 2,
    "Name": "Analyst"
  },
  "StartDate": "2023-10-27T00:00:00Z",
  "EndDate": null
}
```
```

--------------------------------

### POST /api/{appId}/cmdb/{id}/articles/{articleId}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItems

Adds an association between a configuration item and a knowledge base article. Rate limited to 60 calls per IP address every 60 seconds.

```APIDOC
## POST /api/{appId}/cmdb/{id}/articles/{articleId}

### Description
Adds an article relationship to the specified configuration item.

### Method
POST

### Endpoint
`https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/{id}/articles/{articleId}`

### Parameters
#### Path Parameters
- **appId** (string) - Required - The application ID.
- **id** (Int32) - Required - The configuration item ID.
- **articleId** (Int32) - Required - The ID of the article to associate.

### Response
#### Success Response (200)
- **string** - A response message indicating if the operation was successful or not.

### Rate Limiting
60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/securityroles/{id}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/SecurityRoles

Retrieves a specific security role by its ID.

```APIDOC
## GET /api/securityroles/{id}

### Description
Gets a security role.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/securityroles/{id}

### Parameters
#### Path Parameters
- **id** (Guid) - Required - The security role ID.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **TeamDynamix.Api.Roles.SecurityRole** - The security role if it was found.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.
```

--------------------------------

### POST /api/{appId}/services/offerings/search

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ServiceCatalog

Gets a list of Service Catalog service offerings. Will not return full service offering information.

```APIDOC
## POST /api/{appId}/services/offerings/search

### Description
Gets a list of Service Catalog service offerings. Will not return full service offering information.

### Method
POST

### Endpoint
/api/{appId}/services/offerings/search

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **(Object)** - Required - Search criteria for service offerings.
```

--------------------------------

### GET /api/projects/issues/statuses

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Issues

Retrieves the available issue statuses for the backend system.

```APIDOC
## GET /api/projects/issues/statuses

### Description
Gets the issue statuses for the BE.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/issues/statuses

### Parameters
No parameters required.

#### Response
#### Success Response (200)
- **issue statuses** - A list of available issue statuses.

#### Response Example
{
  "example": "list of issue statuses"
}
```

--------------------------------

### GET /api/projects/issues/priorities

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Issues

Retrieves a list of available risk priorities for issues.

```APIDOC
## GET /api/projects/issues/priorities

### Description
Gets the risk priorities.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/issues/priorities

### Parameters
No parameters required.

#### Response
#### Success Response (200)
- **risk priorities** - A list of available risk priorities.

#### Response Example
{
  "example": "list of risk priorities"
}
```

--------------------------------

### POST /api/{appId}/assets/models/types/search

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ProductTypes

Retrieves a list of asset product types based on specified search criteria.

```APIDOC
## POST /api/{appId}/assets/models/types/search

### Description
Gets a list of product types based on search criteria.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/assets/models/types/search

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **search** (TeamDynamix.Api.Assets.ProductTypeSearch) - Required - The searching parameters to use.
  - **Name** (String) - Optional - Filters by product type name.
  - **IsActive** (Boolean) - Optional - Filters by active status.
  - **ParentId** (Int32) - Optional - Filters by parent product type ID.

### Request Example
```json
{
  "Name": "Specific Name",
  "IsActive": true
}
```

### Response
#### Success Response (200)
- **value** (TeamDynamix.Api.Assets.ProductType[]) - A list of product types matching the specified criteria.

#### Response Example
```json
[
  {
    "Id": 12,
    "Name": "Specific Name",
    "IsActive": true,
    "ParentId": null
  }
]
```

#### Rate/Submission Limitations
- 60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/{appId}/tickets/{id}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Tickets

Retrieves a specific ticket by its ID.

```APIDOC
## GET /api/{appId}/tickets/{id}

### Description
Gets a ticket.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/tickets/{id}

### Parameters
#### Path Parameters
- **id** (Int32) - Required - The ticket ID.

### Response
#### Success Response (200)
- **ticket** (TeamDynamix.Api.Tickets.Ticket) - The ticket if it was found.

#### Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of **60 calls** per **IP address** every **60 seconds**.
```

--------------------------------

### POST /api/projects

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Projects

Emulates the project creation process in TDNext. This endpoint allows for explicit setting of project and alternate managers, and bypasses certain standard validations for these roles. It does not support adding projects to portfolios or programs.

```APIDOC
## POST /api/projects

### Description
Emulates the project creation process in TDNext with specific exceptions regarding project managers, resource requests, and portfolio/program additions. The project manager and alternate managers can be set explicitly and do not need to meet the same capacity or status requirements as other users. Adding a project to a portfolio or program is not supported.

### Method
POST

### Endpoint
/api/projects

### Parameters
#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the project.
- **projectManager** (object) - Optional - The project manager for the new project. Must be an active user of type 'User' with TDNext and TDProjects access, and a primary functional role.
  - **id** (integer) - The ID of the user.
- **alternateManagers** (array) - Optional - An array of alternate project managers. Each object must meet the same requirements as the 'projectManager'.
  - **id** (integer) - The ID of the user.

### Request Example
```json
{
  "name": "New Project Name",
  "projectManager": {
    "id": 123
  },
  "alternateManagers": [
    {
      "id": 456
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the newly created project.
- **name** (string) - The name of the created project.

#### Response Example
```json
{
  "id": 789,
  "name": "New Project Name"
}
```

### Remarks
**Caller Requirements:**
1. Must have TDNext and full TDProjects access.
2. Must have the global security role permission to Add Projects.

**Project/Alternate Manager Requirements:**
1. Must be an active user of type 'User' (not service accounts or resource placeholders).
2. Must have access to both TDNext and TDProjects applications.
3. Must have a primary functional role.
```

--------------------------------

### GET /api/{appId}/assets/models/types

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ProductTypes

Retrieves a list of all available product types within a specified application.

```APIDOC
## GET /api/{appId}/assets/models/types

### Description
Gets a list of all product types.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/assets/models/types

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

### Response
#### Success Response (200)
- **value** (TeamDynamix.Api.Assets.ProductType[]) - A hierarchical list of product types.

#### Response Example
```json
[
  {
    "Id": 1,
    "Name": "Example Product Type",
    "IsActive": true,
    "ParentId": null
  }
]
```

#### Rate/Submission Limitations
- 60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/time/types/{id}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Time

Retrieves details for a specific time type by its ID.

```APIDOC
## GET /api/time/types/{id}

### Description
Gets details on a specific time type.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/time/types/{id}

### Parameters
#### Path Parameters
- **id** (Int32) - Required - The time type ID.

#### Returns
#### Success Response (200)
- **TeamDynamix.Api.Time.TimeType** - The time type or null if one could not be found.

#### Response Example
{
  "example": "{\"id\": 1, \"name\": \"Default Time Type\", \"isActive\": true}"
}

#### Rate Limiting
60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/people/{uid}/groups

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/People

Retrieves all groups associated with a specific user.

```APIDOC
## GET /api/people/{uid}/groups

### Description
Gets all groups for a particular user.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/people/{uid}/groups

### Parameters
#### Path Parameters
- **uid** (Guid) - Required - The unique identifier of the user.

### Response
#### Success Response (200 OK)
- **Groups** (Array<TeamDynamix.Api.Groups.Group>) - A list of groups the user belongs to.

#### Response Example
```json
[
  {
    "id": 101,
    "name": "IT Support"
  }
]
```
```

--------------------------------

### POST /api/{appId}/cmdb/types

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItemTypes

Creates a new configuration item type.

```APIDOC
## POST /api/{appId}/cmdb/types

### Description
Creates a configuration item type.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/types

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Query Parameters
None

#### Request Body
- **itemType** (TeamDynamix.Api.Cmdb.ConfigurationItemType) - Required - The configuration item type object to create.

### Request Example
```json
{
  "itemType": {
    "Name": "New Device Type",
    "Description": "A new type of device being tracked.",
    "IsActive": true
  }
}
```

### Response
#### Success Response (200)
- **ConfigurationItemType object** - The created configuration item type.

#### Response Example
```json
{
  "Id": 10,
  "Name": "New Device Type",
  "Description": "A new type of device being tracked.",
  "IsActive": true,
  "GUID": "f1e2d3c4-b5a6-0987-6543-210fedcba987"
}
```

#### Rate/Submission Limitations
60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/{appId}/assets/vendors/{id}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Vendors

Retrieves a specific vendor by its ID.

```APIDOC
## GET /api/{appId}/assets/vendors/{id}

### Description
Gets a vendor by its unique identifier.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/assets/vendors/{id}

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.
- **id** (Int32) - Required - The ID of the vendor to retrieve.

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **TeamDynamix.Api.Assets.Vendor** - The vendor object if found.

#### Response Example
```json
{
  "Id": 1,
  "Name": "Example Vendor",
  "IsActive": true,
  "AssetsSuppliedCount": 5,
  "Attributes": [],
  "ContractsCount": 2,
  "ProductModelsCount": 3
  // ... other vendor properties
}
```
```

--------------------------------

### POST /api/projects

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Projects

Creates a new project within the TeamDynamix system. Options to notify the new project manager and alternate managers are available.

```APIDOC
## POST /api/projects

### Description
Creates a project.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects?notifyNewManager={notifyNewManager}&notifyNewAltManagers={notifyNewAltManagers}

### Parameters
#### Query Parameters
- **notifyNewManager** (Boolean) - Optional (Default: False) - Whether or not to notify the new project manager about the new project. Notifications to self will not be sent if the caller (creator) is set as the new project's manager.
- **notifyNewAltManagers** (Boolean) - Optional (Default: False) - Whether or not to notify the new alternate managers about the new project. Notifications to self will be sent if the caller (creator) is set as one of the new project's alternate managers.

#### Request Body
- **project** (TeamDynamix.Api.Projects.NewProject) - Required - The project to create.

### Request Example
{
  "project": {
    "name": "New Initiative",
    "description": "This is a new project initiative.",
    "projectManagerUserId": 123
  }
}

### Response
#### Success Response (200)
- **createdProject** (Object) - The created project object.

#### Response Example
{
  "id": 201,
  "name": "New Initiative",
  "status": "Open",
  "projectManagerUserId": 123
}

#### Access Restrictions
This action requires access to the TDProjects application.
This action requires the "Project: Add Projects" permission.

#### Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/projects/risks/statuses

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Risks

Retrieves a list of available risk statuses for the backend system.

```APIDOC
## GET /api/projects/risks/statuses

### Description
Gets the risk statuses for the BE.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/risks/statuses

### Parameters
#### Path Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **A list of available risk statuses.**

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### POST /api/{appId}/cmdb/maintenancewindows/search

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/MaintenanceSchedules

Searches for maintenance windows based on provided criteria. This endpoint is rate-limited.

```APIDOC
## POST /api/{appId}/cmdb/maintenancewindows/search

### Description
Gets a list of maintenance windows based on search criteria.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/maintenancewindows/search

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Request Body
- **search** (TeamDynamix.Api.Cmdb.MaintenanceScheduleSearch) - Required - The searching parameters to use.

### Request Example
```json
{
  "search": {
    "ExampleField": "ExampleValue"
  }
}
```

### Response
#### Success Response (200)
- **TeamDynamix.Api.Cmdb.MaintenanceSchedule[]** - A list of maintenance windows.

### Rate/Submission Limitations
Invocations of this method are rate-limited, with a restriction of **60 calls** per **IP address** every **60 seconds**.
```

--------------------------------

### GET /TDWebApi/api/{appId}/assets/{id}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Assets

Retrieves the details of a specific asset.

```APIDOC
## GET /TDWebApi/api/{appId}/assets/{id}

### Description
Gets an asset.

### Method
GET

### Endpoint
`https://solutions.teamdynamix.com/TDWebApi/api/{appId}/assets/{id}`

### Parameters
#### Path Parameters
- **appId** (string) - Required - The application ID.
- **id** (Int32) - Required - The asset ID.

#### Returns
The asset. (TeamDynamix.Api.Assets.Asset)

#### Rate/Submission Limitations
60 calls per IP address every 60 seconds.
```

--------------------------------

### POST /api/{appId}/cmdb/types/search

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/ConfigurationItemTypes

Retrieves a list of configuration item types based on specified search criteria.

```APIDOC
## POST /api/{appId}/cmdb/types/search

### Description
Gets a list of configuration item types.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/cmdb/types/search

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

#### Query Parameters
None

#### Request Body
- **search** (TeamDynamix.Api.Cmdb.ConfigurationItemTypeSearch) - Required - The search parameters.

### Request Example
```json
{
  "search": {
    "Name": "Server",
    "IsActive": true
  }
}
```

### Response
#### Success Response (200)
- **Array of ConfigurationItemType objects** - A list of item types matching the specified criteria.

#### Response Example
```json
[
  {
    "Id": 1,
    "Name": "Server",
    "Description": "Represents a physical or virtual server.",
    "IsActive": true,
    "GUID": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  }
]
```

#### Rate/Submission Limitations
60 calls per IP address every 60 seconds.
```

--------------------------------

### Create Knowledge Base Category

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/KnowledgeBase

Creates a new knowledge base category. Permissions are inherited from the parent category.

```APIDOC
## POST /api/{appId}/knowledgebase/categories

### Description
Creates a new knowledge base category. Permissions are inherited from the parent category.

### Method
POST

### Endpoint
/api/{appId}/knowledgebase/categories

### Parameters
#### Request Body
- **category** (TeamDynamix.Api.KnowledgeBase.ArticleCategory) - Required - The category object to create.

### Request Example
```json
{
  "name": "New Category",
  "parentId": 123
}
```

### Response
#### Success Response (200)
- **category** (TeamDynamix.Api.KnowledgeBase.ArticleCategory) - The created category object.

#### Response Example
```json
{
  "id": 456,
  "name": "New Category",
  "parentId": 123,
  "isPublic": true
}
```
```

--------------------------------

### GET /api/{appId}/assets/{id}

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Assets

Retrieves details of a specific asset.

```APIDOC
## GET /api/{appId}/assets/{id}

### Description
Gets an asset.

### Method
GET

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/{appId}/assets/{id}

### Parameters
#### Path Parameters
- **appId** (integer) - Required - The application identifier.
- **id** (integer) - Required - The ID of the asset to retrieve.

### Response
#### Success Response (200)
- **Asset Object** (TeamDynamix.Api.Assets.Asset) - The details of the requested asset.

#### Response Example
```json
{
  "example": "asset object details"
}
```
```

--------------------------------

### POST /projects/{projectId}/plans

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/Plans

Creates a new waterfall project plan or card wall. Newly created plans or boards are not automatically checked out.

```APIDOC
## POST /projects/{projectId}/plans

### Description
Creates a waterfall project plan or board (card wall). Plans/boards will not be checked out after creation.

### Method
POST

### Endpoint
https://solutions.teamdynamix.com/TDWebApi/api/projects/{projectId}/plans

### Parameters
#### Path Parameters
- **projectId** (Int32) - Required - The project ID.

#### Request Body
- **plan** (TeamDynamix.Api.Plans.PlanOrBoardCreate) - Required - The plan or board creation model.

### Response
#### Success Response (200)
- **[Created Plan or Board Object]** - The created plan or board if the operation was successful.

### Rate/Submission Limitations
- 60 calls per IP address every 60 seconds.
```

--------------------------------

### GET /api/{appId}/tickets/statuses

Source: https://solutions.teamdynamix.com/TDWebApi/Home/section/TicketStatuses

Retrieves a list of all active ticket statuses.

```APIDOC
## GET /api/{appId}/tickets/statuses

### Description
Gets all active ticket statuses.

### Method
GET

### Endpoint
/api/{appId}/tickets/statuses

### Parameters
#### Path Parameters
- **appId** (Int32) - Required - The application identifier.

### Request Example
```
GET https://solutions.teamdynamix.com/TDWebApi/api/123/tickets/statuses
```

### Response
#### Success Response (200)
- **ticketStatuses** (TeamDynamix.Api.Tickets.TicketStatus[]) - A list of all active ticket statuses.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Open",
    "isActive": true,
    "isDefault": true
  },
  {
    "id": 2,
    "name": "In Progress",
    "isActive": true,
    "isDefault": false
  }
]
```
```
Tokens:
Raw