createRuleTZ

Creates a downtime rule for the specified configuration, which includes timezone as well.

Applies to Clouds and Integration Appliances.

Parameters:

projectName
The name of the specified project.
version
The version number for the specified project.
configName
The configuration name for the specified project.
stopDate
The date the configuration is to be stopped.
restartDate
The date the configuration is to be restarted.
downtimeType
The type or reason for the downtime. The values for this property are stop, stopAndCancel, and suspend

Stop (allows jobs to finish) - At the specified time, this action prevents a new orchestration job from starting, while allowing the current jobs to finish processing. This action allows all jobs to end.

Stop (cancel running jobs) - At the specified time, this action prevents a new orchestration job from starting and stops all jobs that are currently running. This action immediately stops all jobs.

Suspend - At the specified time, prevents any new orchestrations from starting and pauses any jobs that are currently running. At the end of the scheduled downtime, the runtime processes the suspended job from the point it paused.

Together projectName, version, and configName uniquely identify a configuration.

Returns:
The new downtime rule for the specified configuration.

Examples:

The following code is an example of a SOAP request to create a rule. Dates must conform to ISO 8601.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:dep="http://www.approuter.com/schemas/2008/1/deployment">
 <soapenv:Header>
  <dep:sessionId>8FDBC8ED7A014272714D23D14794473A</dep:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <dep:createRuleTZ>
   <dep:projectName>GenericProject_1_Cloud</dep:projectName>
   <dep:version>1.0</dep:version>
   <dep:configName>Default</dep:configName>
   <dep:stopDate>2010-04-17T07:00:00.066Z</dep:stopDate>
   <dep:restartDate>2010-04-17T08:00:00.066Z</dep:restartDate>
   <dep:downtimeType>stop</dep:downtimeType>
	 <dep:timeZone>PDT</dep:timeZone>
  </dep:createRuleTZ>
 </soapenv:Body>
</soapenv:Envelope>
The following example is the SOAP response to the request.
<:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:createRuleTZResponse xmlns:ns5="http://www.approuter.com/schemas/2008/1/util/types"
   xmlns:ns4="http://www.approuter.com/schema/router/1000/security/03"
   xmlns:ns3="http://www.approuter.com/schemas/2008/1/deployment/types"
   xmlns:ns2="http://www.approuter.com/schemas/2008/1/deployment">
   <ns2:ruleId>1572864</ns2:ruleId>
  </ns2:createRuleTZResponse>
 </S:Body>
</S:Envelope>



Feedback | Notices


Timestamp icon Last updated: Thursday, December 17, 2015


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.api.doc/ci00161.html