Search Scheduled Maintenance Windows

Gets the client's scheduled maintenance windows under a specific client.

Notes

There are special characters that can be used in a query string:

  • (+) represents the next field and must be URL-encoded.
  • (:) represents equals. An example is key : value.
  • Space characters must be URL-encoded.
  • Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Query Variable Description
uniqueId Schedule Maintenance window unique ID.
name Schedule Maintenance name.
startDate Start date of schedule maintenance.
Example: 2016-08-12T10:55:27 0000
endDate Expiry date of schedule maintenance.
Example: 2016-09-15T18:55:27 0000
deviceUniqueId Device ID
Name Name.
deviceGroupId Device group ID.
deviceGroupName Device group name.
siteId Site ID.
siteName Site name.
startCreationDate Filter schedule maintenance windows created within a date range. Provide from creation date.
Example: 2016-07-24T06:48:40 0000
endCreationDate Filter schedule maintenance windows created within a date range. Provide to creation date.
Example: 2016-07-26T06:48:40 0000
startUpdationDate Filter schedule maintenance windows updated within a date range. Provide from update date.
Example: 2016-07-24T06:48:40 0000
endUpdationDate Filter schedule maintenance windows updated within a date range. Provide to update date.
Example: 2016-07-26T06:48:40 0000
status Filter with scheduled maintenance window status. For example, to get all scheduled maintenance windows that are completed, provide status: Completed in the query string.
Supported statuses: Active, Pending, Suspended, and Completed.
get
/api/v2/tenants/{tenantId}/scheduleMaintenances/search

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Current pagination number

  • pageSizeinteger

    No of records in each page

  • isDescendingOrderboolean

    Pagination data ordering: true for descending false for ascending

  • sortNamestring

    Field name on which paginated data is ordered

    Enum:
    idtsstartaltimec_namep_namesourcertypername
  • queryStringstring

    Generic query string to be prepared using query parameters

  • uniqueIdstring

    Schedule Maintenance window unique ID

  • namestring

    Schedule Maintenance name

  • startDatestring

    Start date of schedule maintenance. Example: 2016-08-12T10:55:27 0000

  • endDatestring

    Expiry date of schedule maintenance. Example: 2016-09-15T18:55:27 0000

  • deviceUniqueIdstring

    Device ID

  • deviceGroupIdstring

    Device group ID

  • deviceGroupNamestring

    Device group name

  • siteIdstring

    Site ID

  • siteNamestring

    Site name

  • startCreationDatestring

    Filter schedule maintenance windows created within a date range. Provide from creation date. Example: 2016-07-24T06:48:40 0000

  • endCreationDatestring

    Filter schedule maintenance windows created within a date range. Provide to creation date. Example: 2016-07-26T06:48:40 0000

  • startUpdationDatestring

    Filter schedule maintenance windows updated within a date range. Provide from update date. Example: 2016-07-24T06:48:40 0000

  • endUpdationDatestring

    Filter schedule maintenance windows updated within a date range. Provide to update date. Example: 2016-07-26T06:48:40 0000

  • statusstring

    Filter with scheduled maintenance window status. For example, to get all scheduled maintenance windows that are completed, provide status: Completed in the query string. Supported statuses.

    Enum:
    ActivePendingSuspendedand Completed.
00