ApplyMaintenanceWindowTemplateRequest

This is the type of element expected in an invocation of the ApplyMaintenanceWindowTemplate operation. This element is embedded in a SOAP envelope.

Derived by

Restricting anyType

Content model

Contains elements as defined in the following table.

Component Type Occurs Nillable? Description
SEQUENCE 1..1
Credentials anyType (restriction) 1..1 No A Credentials element contains the username and password of an account user. The element is required in all requests to the Test Management Web Service.
UserName [element Credentials] string 1..1 No The UserName of an employee for an account (and used for authentication).
Password [element Credentials] string 1..1 No A secret used as part of user credentials for authentication. Every request to the Test Management API web service must include a Credentials element. That element itself contains a UserName and a Password element.
MonitorIds anyType (restriction) 1..1 No The MonitorIds element contains a list of monitor ids. This element may appear in a MaintenanceWindowFilter. The output of this query is restricted to the monitors listed in the MonitorIds. However, the monitors listed in the MonitorIds element that are not defined under the account or that do not have maintenance window definitions do not appear in the output. The MonitorIds element may also appear in an ApplyMaintenanceWindowTemplateRequest. In this context, the monitor ids listed in the element designate the monitors that will receive new maintenance window definitions as a result of the request.
OneTimeMaintenanceWindows anyType (restriction) 0..1 No OneTimeMaintenanceWindows are collections of OneTimeMaintenanceWindow elements (see OneTimeMaintenanceWindow).
RecurringMaintenanceWindows anyType (restriction) 0..1 No The RecurringMaintenanceWindows element is a container of RecurringMaintenanceWindow elements. It appears in both GetMaintenanceWindowsResponses and in invocations of the two operations provided for updating the existing maintenance windows (AddOrUpdateMaintenanceWindows and ApplyMaintenanceWindowTemplate) to the monitors.

Example

Creating three one-time maintenance window for a single monitor:

<prov:ApplyMaintenanceWindowTemplateRequest>
   <prov:Credentials>
     <prov:UserName>erics</prov:UserName>
     <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MonitorIds>
      <prov:MonitorId>309545</prov:MonitorId>
   </prov:MonitorIds>
    <prov:OneTimeMaintenanceWindows>
      <prov:OneTimeMaintenanceWindow beginDate="2012-11-15T15:03:42"
                                     endDate="2012-11-10T18:03:42"/>
      <prov:OneTimeMaintenanceWindow beginDate="2012-11-16T15:03:42"
                                     endDate="2012-11-16T18:03:42"/>
      <prov:OneTimeMaintenanceWindow beginDate="2012-11-17T15:03:42"
                                     endDate="2012-11-16T18:03:42"/>
    </prov:OneTimeMaintenanceWindows>
</prov:ApplyMaintenanceWindowTemplateRequest>

Deleting one-time maintenance windows from a group of monitors:

<prov:ApplyMaintenanceWindowTemplateRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MonitorIds>
      <!--Zero or more repetitions:-->
      <prov:MonitorId>326334</prov:MonitorId>
      <prov:MonitorId>328141</prov:MonitorId>
      <prov:MonitorId>328196</prov:MonitorId>
   </prov:MonitorIds>
   <prov:OneTimeMaintenanceWindows/>
</prov:ApplyMaintenanceWindowTemplateRequest>

Creating seven recurring maintenance windows for a group of monitors:

 <prov:ApplyMaintenanceWindowTemplateRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MonitorIds>
      <prov:MonitorId>326334</prov:MonitorId>
      <prov:MonitorId>328141</prov:MonitorId>
      <prov:MonitorId>328196</prov:MonitorId>
   </prov:MonitorIds>
   <prov:RecurringMaintenanceWindows>
         <prov:RecurringMaintenanceWindow dayOfWeek="SUN"
           startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="MON"
           startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="TUE"
           startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="WED"
           startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="THU"
           startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="FRI"
           startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="SAT"
           startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
   </prov:RecurringMaintenanceWindows>
</prov:ApplyMaintenanceWindowTemplateRequest>

Deleting all recurring maintenance windows for a group of monitors:

<prov:ApplyMaintenanceWindowTemplateRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MonitorIds>
      <!--Zero or more repetitions:-->
      <prov:MonitorId>326334</prov:MonitorId>
      <prov:MonitorId>328141</prov:MonitorId>
      <prov:MonitorId>328196</prov:MonitorId>
   </prov:MonitorIds>
   <prov:RecurringMaintenanceWindows/>
</prov:ApplyMaintenanceWindowTemplateRequest>