Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Operations Manager i10.62

Develop > Web Service Interfaces > Downtime Web Service Interface

Downtime Web Service Interface

You can use a RESTful web service running on the Gateway Server to retrieve, update, create, and delete downtimes. HTTP requests can be entered in your browser, and combinations of HTTP requests and XML commands in a REST client. Service authentication is based on basic authentication.

For information about downtime and the opr-downtime command-line interface, see Downtime Management and opr-downtime Command-Line Interface.

Note You require administration or superuser privileges to use downtime REST API.

https://<serviceURL>/<request>

<serviceURL>

The URL of the Action web service:

<server>:<port>/topaz/bsmservices/customers/[customerID]/downtimes

where <server> is the name of the OMi server.

<request>

The service request.

Aces

The downtime REST service supports the following HTTP requests:

Note CustomerID is always 1.

Request	Request Type	Action Description
`/downtimes/{[downtimeID]}`	GET	`/<downtimeID>` is omitted: Lists all configured downtimes. `/<downtimeID>` is specified: Get the downtime with ID `<downtimeID>`.
`/downtimes + XML of the downtime`	POST	Create an event category as specified in the posted XML data. Note:`/<categoryID>` must be omitted.
`downtimes/[downtimeID] + XML of the downtime`	PUT	Update an event category as specified in the posted XML data. Note: `/<categoryID>` must be specified.
`downtimes/[downtimeID]`	DELETE	Delete the event category with ID `<categoryID>`. Note: `/<categoryID>` must be specified.

Request Reference

The downtime REST service supports the following HTTP requests:

Note CustomerID is always 1.

Request	Request Type	Action Description
`/downtimes/{[downtimeID]}`	GET	`/<downtimeID>` is omitted: Lists all configured downtimes. `/<downtimeID>` is specified: Get the downtime with ID `<downtimeID>`.
`/downtimes + XML of the downtime`	POST	Create an event category as specified in the posted XML data. Note: `/<categoryID>` must be omitted.
`downtimes/[downtimeID] + XML of the downtime`	PUT	Update an event category as specified in the posted XML data. Note: `/<categoryID>` must be specified.
`downtimes/[downtimeID]`	DELETE	Delete the event category with ID `<categoryID>`. Note: `/<categoryID>` must be specified.

Allowed Downtime Actions

Use the XML commands listed for the following downtime actions:

Action Description	XML Command
Take no actions	`<action name="REMINDER"/>`
Suppress alerts and close events	`<action name="SUPPRESS_NOTIFICATIONS"/>`
Enforce downtime on KPI calculations; suppress alerts and close events (continue monitoring)	`<action name="ENFORCE_ON_KPI_CALCULATION"/>`
Enforce downtime on Reports and KPI calculations; suppress alerts and close events (continue monitoring)	`<action name="ENFORCE_ON_REPORTS"/>`
Enforce downtime on Reports and KPI calculations; suppress alerts and close events (continue monitoring), including all SLAs	`<action name="ENFORCE_ON_REPORTS"> <propGroup name="SLA" value="ALL"/> </action>`
Enforce downtime on Reports and KPI calculations; suppress alerts and close events (continue monitoring), including specific SLA	`<action name="ENFORCE_ON_REPORTS"> <propGroup name="SLA" value="SELECTED"> <prop>dda3fb0b20c0d83e078035ee1c005201</prop> </propGroup> </action>`
Stop active monitoring (BPM and SiteScope); enforce downtime on Reports & KPI calculations; suppress alerts and close events	`<action name="STOP_MONITORING"/>`

Downtime XML Example

The following fields may not exceed the maximum lengths specified:

Name: 200 characters
Description: 2000 characters
Approved by: 50 characters

Note In Oracle, if you are using East Asian Languages (Chinese, Japanese, or Korean), the maximum number of characters may be less than specified above.

<downtime userId="1" planned="true" id="8898e5a5dbcdc953e04037104bf5737c"> <name>The name of the downtime</name> <action name="ENFORCE_ON_REPORTS"> </action> <approver>The approver name</approver> <category>1</category> <notification> <recipients> <recipient id="24"/> <recipient id="22"/> <recipient id="21"/> </recipients> </notification> <selectedCIs> <ci> <id>ac700345b47064ed4fbb476f21f95a76</id> <viewName>End User Monitors</viewName> </ci> </selectedCIs> <schedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="WeeklyScheduleType"> <type>WEEKLY</type> <startDate>2010-06-10T15:40:00</startDate> <timeZone>Europe/Zurich</timeZone> <days> <selectedDays>WEDNESDAY</selectedDays> <selectedDays>THURSDAY</selectedDays> <selectedDays>FRIDAY</selectedDays> <selectedDays>SATURDAY</selectedDays> </days> <startTimeInSecs>52800</startTimeInSecs> <durationInSecs>300</durationInSecs> </schedule> </downtime>

Send Help Center feedback