Get Maintenance Schedules Using GET

Get Maintenance Schedules Using GET

Using this method, you can get all maintenance schedules with or without specific parameters

Request
URI
GET
https://{api_host}/api/maintenanceschedules
COPY
Query Parameters
string of array
id
Optional

Maintenance schedule identifiers

string of array
name
Optional

Maintenance schedule names or keys

integer
page
Optional

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional

Expected number of entries per page

string of array
resourceId
Optional

List of Object identifiers


Authentication
This operation uses the following authentication methods.
Responses
200

The Maintenance Schedules that match the criteria specified

Returns maintenance-schedules of type(s) application/json
{
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    },
    "schedules": [
        {
            "id": "string",
            "key": "string",
            "schedule": {
                "dayOfTheMonth": 0,
                "daysOfTheMonth": [
                    "string"
                ],
                "daysOfTheWeek": [
                    "string"
                ],
                "duration": 0,
                "expirationDate": "string",
                "expireRuns": 0,
                "hour": 0,
                "minuteOfTheHour": 0,
                "month": 0,
                "months": [
                    0
                ],
                "recurrence": 0,
                "scheduleType": "string",
                "startDate": "string",
                "timeZone": "string",
                "weeksOfTheMonth": [
                    "string"
                ]
            }
        }
    ]
}
array of link
links
Optional

Collection of links

pageInfo
Optional

Represents page information for a paged result

schedules
Optional

Collection of maintenance schedules