This operation bypasses blackout window rules that are configured at higher levels.
Request
Syntax
GET <webservice>/OperationWindow/IgnoreHigherLevelRules/Action/Enable?clientId={clientId}&clientgroupId={clientgroupId}&appTypeId={appTypeId}&instanceId={instanceId}&backupsetId={backupsetId}&subclientId={subclientId}
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 |
|---|---|---|
|
commcellId |
The ID for the CommCell environment. By default, the default commcellId is 2. |
No |
|
clientId |
The ID for the client. If the client ID is not known, use the GET Client API to retrieve it. |
No |
|
clientgroupId |
The ID for the client group. If the client group ID is not known, use the GET Client Group API to retrieve it. |
No |
|
appTypeId |
The application ID for the agent type. If the application ID is not known, use the REST API - GET Agent to retrieve it. |
No |
|
instanceId |
The ID for the instance. If the instance ID is not known, use the GET Instance API to retrieve it. |
No |
|
backupsetId |
The ID for the backup set. If the backup set ID is not known, use the GET Backup Set API to retrieve it. |
No |
|
subclientId |
The ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it. |
No |
Note
You can provide only one entity ID for which you want to ignore higher level blackout window rules in the API request. For example, if you want to ignore higher level blackout window rules for a backup set, then you need to provide only the backupsetId value in the API request, and you do not need to specify the IDs of its higher level entities such as the client group.The only exception to this rule is when you want to bypass higher level blackout window rules for an agent, in which case you must specify the clientId along with the appTypeId.
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 |
|---|---|---|
|
errorMessage |
The description of the error code. Not all error codes have an error message. |
error |
|
errorCode |
The possible error codes. Valid values are:
|
error |
Examples
Example Request
GET <webservice>/OperationWindow/IgnoreHigherLevelRules/Action/Enable?subclientId=8
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Example Response: Successfully bypassed higher level blackout window rules
<Api_IgnoreOperationWindowRulesResp>
<error errorCode="0" />
</Api_IgnoreOperationWindowRulesResp>
Example Response: Unsuccessful attempt due to incorrect ID
<Api_IgnoreOperationWindowRulesResp>
<error errorMessage="Subclient-level Blackout Window rule missing required parameter: SubclientId." errorCode="587207087" />
</Api_IgnoreOperationWindowRulesResp>