1. APIs
  2. Maintenance Activities

Contents

Summary

Contains methods for working with maintenance activities.

Application Identifier Use

This set of APIs uses a application identifier parameter, named appId and of type Int32, which specifies the corresponding application in which actions should be performed.

For the sake of brevity, it is omitted from the parameter list of the API methods below, but still needs to be included whenever there is an {appId} placeholder in the URL for the API method.

API Methods

GET https://demotemplate.teamdynamix.com/TDWebApi/api/{appId}/tickets/{ticketId}/MaintenanceActivities Copy URL

Gets a list of maintenance activities currently on a ticket.

Parameters

Returns

A list of ticket maintenance activities currently on the specified ticket. (TeamDynamix.Api.Tickets.MaintenanceActivity[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://demotemplate.teamdynamix.com/TDWebApi/api/{appId}/tickets/{ticketId}/MaintenanceActivities Copy URL

Creates a new maintenance activity on a ticket.

Parameters

Returns

The created maintenance activity, if it was successfully created.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

Only maintenance activities may be added to a ticket in this manner.

DELETE https://demotemplate.teamdynamix.com/TDWebApi/api/{appId}/tickets/{ticketId}/MaintenanceActivities/{id} Copy URL

Removes a maintenance activity from a ticket. This cannot be undone.

Parameters

Returns

A response message indicating if the operation was successful or not.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://demotemplate.teamdynamix.com/TDWebApi/api/{appId}/tickets/{ticketId}/MaintenanceActivities/{id} Copy URL

Gets an individual maintenance activity on a ticket.

Parameters

Returns

The maintenance activity, if found on the specified ticket. (TeamDynamix.Api.Tickets.MaintenanceActivity)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://demotemplate.teamdynamix.com/TDWebApi/api/{appId}/tickets/{ticketId}/MaintenanceActivities/{id} Copy URL

Updates a maintenance activity.

Parameters

Returns

The feed entry generated, 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.

PUT https://demotemplate.teamdynamix.com/TDWebApi/api/{appId}/tickets/{ticketId}/MaintenanceActivities/{id} Copy URL

Updates a maintenance activity with a set of new values.

Parameters

Returns

The modified maintenance activity, if the operation was successful. (TeamDynamix.Api.Tickets.MaintenanceActivity)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://demotemplate.teamdynamix.com/TDWebApi/api/{appId}/tickets/{ticketId}/MaintenanceActivities/{id}/feed Copy URL

Gets the feed entries for a maintenance activity.

Parameters

Returns

The maintenance activity's feed entries. (TeamDynamix.Api.Feed.ItemUpdate[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

The replies and likes collections will not be returned by this endpoint.

However, replies count, likes count, and "liked by me" flag values will be loaded.

To retrieve replies and likes, query the single feed entry retrieval endpoint using the individual entry's URI.