This operation returns a list of operation rules.
Request
Syntax
GET <webservice>/OperationWindow/OpWindowList?clientId={clientId}&clientgroupId={clientgroupId}&appTypeId={appTypeId}&instanceId={instanceId}&backupsetId={backupsetId}&subclientId={subclientId} HTTP/1.1
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 |
clientId |
The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. |
No |
clientgroupId |
The client group 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 instance ID for the instance. If the instance ID is not known, use the GET Backup Set API to retrieve it. |
No |
backupsetId |
The backup set 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 subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it. |
No |
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 details on 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 |
operationWindow |
|
name |
The name of the operation rule. |
operationWindow |
ruleEnabled |
The option to enable or disable the operation rule. Valid values are:
|
operationWindow |
ruleId |
The system-generated ID for the operation rule. |
operationWindow |
val (Used with XML) |
The operations the operation rule applies to, for example, Data Pruning. Valid values are:
|
operations |
operations (Used with JSON) |
The operations the operation rule applies to, for example, Data Pruning. |
|
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.
|
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.
|
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:
|
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/OpWindowList?clientId=3
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Api_GetOperationWindowResp>
<error errorCode="0" />
<operationWindow ruleEnabled="1" doNotSubmitJob="0" endDate="1521691200" level="2" name="" ruleId="40" startDate="1520485200">
<operations val="1" />
<operations val="2" />
<company _type_="61" providerId="0" providerDomainName="" />
<entity schedulePolicyId="0" subclientId="0" clientGroupId="0" applicationId="0" clientName="" backupsetId="0" commCellName="PrimeProdCS" instanceId="0" schedulePolicyName="" clientId="2" subclientName="" backupsetName="" instanceName="" clientGroupName="" _type_="0" appName="" />
<dayTime startTime="46800" endTime="50400">
<dayOfWeek val="1" />
<dayOfWeek val="2" />
</dayTime>
</operationWindow>
</Api_GetOperationWindowResp>