1. APIs
  2. Blackout Windows

Contents

Summary

Contains methods for working with blackout 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}/tickets/blackoutwindows Copy URL

Gets a list of all active blackout windows.

Returns

A list of all active blackout windows. (TeamDynamix.Api.Cmdb.BlackoutWindow[])

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}/tickets/blackoutwindows Copy URL

Creates a blackout window.

Parameters

Returns

The created blackout window, if 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}/tickets/blackoutwindows/{id} Copy URL

Gets a blackout window.

Parameters

Returns

The blackout window, if it was found. (TeamDynamix.Api.Cmdb.BlackoutWindow)

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}/tickets/blackoutwindows/{id} Copy URL

Edits an existing blackout window.

Parameters

Returns

The updated blackout window, if the operation was successful. (TeamDynamix.Api.Cmdb.BlackoutWindow)

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}/tickets/blackoutwindows/search Copy URL

Gets a list of blackout windows.

Parameters

Returns

A list of blackout windows matching the specified criteria. (TeamDynamix.Api.Cmdb.BlackoutWindow[])

Rate/Submission Limitations

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