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

Update an Operation Rule (REST API: PUT)

Updated

This operation updates an operation rule.

Request

Syntax

Send the request using either XML or JSON:

  • XML

     
    PUT <webservice>/OperationWindow HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>
 Content-type: application/xml
<update_operation_rule_template.xml>

  • JSON

     
    PUT <webservice>/OperationWindow HTTP/1.1
 Host: <host name>
 Accept: application/json
 Authtoken: <authentication token>
 Content-type: application/json
<update_operation_rule_template.json>

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 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.

Content-type

The media type contained in the request body.

Request Body

Download the XML or JSON file required for this request: update_operation_rule_template.xml or update_operation_rule_template.json. The following table displays the parameters for the request body.

Parameter

Description and Parameter Values

Element

commCellId

entity

clientId

The client the operation rule is associated with. If the client ID is not known, use the GET Client API to retrieve it.

entity

clientGroupId

The client computer group the operation rule is associated with. If the client ID is not known, use the GET Client Group API to retrieve it.

entity

applicationId

The agent the operation rule is associated with. If the application ID is not known, use the GET Agent API to retrieve it.

entity

instanceId

The instance the operation rule is associated with. If the instance ID is not known, use the GET Backup Set API to retrieve it.

entity

backupsetId

The backup set the operation rule is associated with. If the backup set ID is not known, use the GET Backup Set API to retrieve it.

entity

subclientId

The subclient the operation rule is associated with. If the subclient ID is not known, use the GET Subclient API to retrieve it.

entity

ruleEnabled

The option to enable or disable the operation rule.

Valid values are:

  • 0, to disable the rule

  • 1, to enable the rule

operationWindow

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

name

The name of the operation rule.

operationWindow

val

(Used with XML)

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

(Used with JSON)

The days of the week the operation rule applies to.

val

(Used with XML)

The operations the operation rule applies to, for example, Data Pruning.

Valid values are:

  • All, Non-admin Jobs

  • 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

  • 8192, Transaction Logs

  • 16384, Information Management

  • 32768, Media Refreshing

  • 65536, Data Analytics

  • 131072, Data Pruning

  • 262144, Backup Copy

  • 524288, Cleanup Operations

operations

operations

(Used with JSON)

The operations the operation rule applies to, for example, Data Pruning.

val

(Used with XML)

The start time for the "do not run" interval.

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

startTime

startTime

(Used with JSON)

The start time for the "do not run" interval.

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

val

(Used with XML)

The end time for the "do not run" interval.

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

endTime

endTime

(Used with JSON)

The end time for the "do not run" interval.

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

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.

  • 2, a failure.

  • a specific error code.

Api_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

Api_GenericResp

Examples

Sample Request

XML

This request disables an operation rule for a client computer group.

PUT <webservice>/OperationWindow HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<Api_UpdateOperationWindowReq>  <entity clientId="0" clientGroupId="11"/>  <operationWindow ruleEnabled="0" name="Holiday1"/>
</Api_UpdateOperationWindowReq>

JSON

This request disables an operation rule for a client.

PUT <webservice>/OperationWindow HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
 {
   "operationWindow": {
     "ruleEnabled":false,
     "name": "Holiday3"
   },
   "entity": {
     "clientGroupId": 0,
     "clientId": 5
   }
 }

Sample Response

XML

<Api_GenericResp errorMessage="" errorCode="0" />

JSON

{
   "error": {
     "errorCode": 0
   }
 }