> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Control Panel Operations > Blackout Window Operations

View Blackout Window Details (REST API: GET)

Updated

This operation returns the details of a blackout window based on the operation rule ID.

Request

Syntax

GET <webservice>/OperationWindow/{ruleId}
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

ruleId

The system-generated ID for the operation rule. Use the GET View Blackout Window Rules API to retrieve it.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For detailed information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

startDate

The start date for the operation rule.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

operationWindow

endDate

The end date for the operation rule.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

operationWindow

level

The blackout window rule level:

  • 0: CommCell

  • 1: Client group

  • 2: Client

  • 3: Agent

  • 4: Instance

  • 5: Backup set

  • 6: Subclient

operationWindow

name

The name of the operation rule.

operationWindow

ruleEnabled

The option to enable or disable the operation rule.

Valid values are:

  • 0 (XML) or false (JSON), to disable the rule

  • 1 (XML) or true (JSON), to enable the rule

operationWindow

ruleId

The system-generated ID for the operation rule.

operationWindow

val

(Used with XML)

The operations the operation rule applies to, such as Data Pruning.

Valid values are:

  • 1, Full Data Management (full backups)

  • 2, Non Full Data Management (non full backups)

  • 4, Synthetic Full

  • 8, Data Recovery

  • 16, Auxiliary Copy

  • 32, Disaster Recovery Backup

  • 64, Data Verification

  • 128, Erase Spare Media

  • 512, Delete Data By Browsing

  • 1024, Delete Archived Data

  • 2048, Offline Content Indexing

  • 16384, Information Management

  • 32768, Media Refreshing

  • 65536, Data Analytics

  • 131072, Data Pruning

  • 262144, Backup Copy

operations

operations

(Used with JSON)

The operations the operation rule applies to, such as Data Pruning.

providerId

The system-generated ID assigned to the organization.

company

providerDomainName

The domain name of the organization.

company

schedulePolicyId

The system-generated ID of the schedule policy

entity

subclientId

The system-generated ID of the subclient.

entity

clientGroupId

The system-generated ID of the client group.

entity

applicationId

The ID of the application.

  • 53, for Exchange Database

  • 33, for File System

  • 104, for MySQL

  • 13, for NAS

  • 59, for Notes Database

  • 22, for Oracle

  • 80, for Oracle RAC

  • 125, for PostgreSQL

  • 79, for SAP for MAX DB

  • 61, for SAP for Oracle

  • 81, for SQL Server

  • 5, for Sybase Database

  • 106, Virtual Server

entity

clientName

The name of the client.

entity

backupsetId

The system-generated ID of the backupset.

entity

commCellName

The name of the CommCell.

entity

instanceId

The system-generated ID of the instance.

entity

schedulePolicyName

The name of the schedule policy.

entity

clientId

The system-generated ID of the client.

entity

subclientName

The name of the subclient.

entity

backupsetName

The name of the backup set.

entity

instanceName

The name of the instance.

entity

clientGroupName

The name of the client group.

entity

_type_

The CommCell object associated with the client.

entity

appName

The name of the application.

  • Active Directory

  • DB2

  • DB2 MultiNode

  • DB2 on UNIX

  • Documentum

  • Exchange Database

  • File System

  • Informix Database

  • MySQL

  • NAS

  • Notes Database

  • Oracle

  • Oracle RAC

  • PostgreSQL

  • SAP HANA

  • SAP for MAX DB

  • SAP for Oracle

  • Sharepoint Server

  • SQL Server

  • Sybase Database

  • Virtual Server

entity

startTime

The start time for the "do not run" interval in seconds after 12 AM.

dayTime

endTime

The end time for the "do not run" interval in seconds after 12 AM.

dayTime

val

  • The days of the week the operation rule applies to.

  • Valid values are:

  • 0, Sunday

  • 1, Monday

  • 2, Tuesday

  • 3, Wednesday

  • 4, Thursday

  • 5, Friday

  • 6, Saturday

dayOfWeek

dayOfWeek

The days of the week the operation rule applies to.

Examples

Sample Request

This request returns the operations rules for the client.

GET <webservice>/OperationWindow/3
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<Api_GetOperationWindowResp>
 <error errorCode="0" />
 <operationWindow ruleEnabled="1" doNotSubmitJob="1" endDate="0" level="6" name="SC-HistoryDB" ruleId="2" startDate="0">
  <operations val="1" />
  <operations val="2" />
  <company providerId="0" providerDomainName="" />
  <entity schedulePolicyId="0" subclientId="8" clientGroupId="0" applicationId="81" clientName="" backupsetId="6" commCellName="carbonwincs1" instanceId="3" schedulePolicyName="" clientId="2" subclientName="" backupsetName="" instanceName="" clientGroupName="" _type_="0" appName="" />
  <dayTime startTime="28800" endTime="64800">
   <dayOfWeek val="0" />
   <dayOfWeek val="6" />
  </dayTime>
 </operationWindow>
</Api_GetOperationWindowResp>