Endpoint
/api/v2/tenants/{tenantId}/scheduleMaintenances/search
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.createdTime
results.dontInstallPatch
results.dontRunRBA
results.installPatch
results.name
results.runRBA
results.schedule
results.status
results.uniqueId
results.updatedTime
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "createdTime": "2017-08-16T06:58:26+0000",
      "dontInstallPatch": "false",
      "dontRunRBA": "false",
      "installPatch": true,
      "name": "Weekly_Schedule_For_all_Weekdays",
      "runRBA": true,
      "schedule": {
        "endTime": "2017-08-29T18:55:27+0000",
        "pattern": {
          "type": "weekly",
          "weekDays": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday"
        },
        "startTime": "2017-08-12T10:55:27+0000",
        "type": "recurring"
      },
      "status": "Completed",
      "uniqueId": "SM-c11b6b44-c85a-426c-9963-0e977070ce98",
      "updatedTime": ""
    },
    {
      "createdTime": "2017-08-12T07:11:35+0000",
      "dontInstallPatch": "false",
      "dontRunRBA": "false",
      "installPatch": true,
      "name": "Change Request from Alert -  151  -- From CR",
      "runRBA": true,
      "schedule": {
        "endTime": "2017-08-12T07:11:00+0000",
        "startTime": "2017-08-12T07:11:00+0000",
        "type": "one-time"
      },
      "status": "Completed",
      "uniqueId": "SM-a7aa1874-ee4f-4a12-add1-2313bd717d4e",
      "updatedTime": ""
    },
    {
      "createdTime": "2017-08-11T07:55:40+0000",
      "dontInstallPatch": "true",
      "dontRunRBA": "true",
      "installPatch": false,
      "name": "Schedule maintenance with device",
      "runRBA": false,
      "schedule": {
        "endTime": "2017-08-14T20:00:00+0000",
        "startTime": "2017-08-10T10:00:00+0000",
        "type": "one-time"
      },
      "status": "Completed",
      "uniqueId": "SM-50d135c3-ef77-4145-a10f-822c27a8e372",
      "updatedTime": "2017-08-11T07:59:52+0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 3
}