1. APIs
  2. Maintenance Windows

Contents

Summary

Contains methods for working with maintenance windows.

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://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/maintenanceschedules Copy URL

Gets a list of all active maintenance windows.

Returns

A list of all active maintenance windows. (TeamDynamix.Api.Cmdb.MaintenanceSchedule[])

Rate/Submission Limitations

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

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/maintenanceschedules/search Copy URL

Gets a list of maintenance windows.

Parameters

Returns

A list of maintenance windows. (TeamDynamix.Api.Cmdb.MaintenanceSchedule[])

Rate/Submission Limitations

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

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/maintenancewindows Copy URL

Gets a list of all active maintenance windows.

Returns

A list of all active maintenance windows. (TeamDynamix.Api.Cmdb.MaintenanceSchedule[])

Rate/Submission Limitations

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

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/maintenancewindows Copy URL

Creates a maintenance window.

Parameters

Returns

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 https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/maintenancewindows/{id} Copy URL

Gets a maintenance window.

Parameters

Returns

The maintenance window if it was found. (TeamDynamix.Api.Cmdb.MaintenanceSchedule)

Rate/Submission Limitations

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

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/maintenancewindows/{id} Copy URL

Edits an existing maintenance window.

Parameters

Returns

The updated maintenance window if the operation was successful. (TeamDynamix.Api.Cmdb.MaintenanceSchedule)

Rate/Submission Limitations

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

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/cmdb/maintenancewindows/search Copy URL

Gets a list of maintenance windows.

Parameters

Returns

A list of maintenance windows. (TeamDynamix.Api.Cmdb.MaintenanceSchedule[])

Rate/Submission Limitations

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