Update Schedule Policy Entity Associations (REST API: PUT)

This operation adds, excludes, or removes entity associations on a schedule policy.

Request

Syntax

Send the request using either XML or JSON:

• XML

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

• JSON

   
  PUT <webservice>/Task HTTP/1.1
   Host: <host name>
   Accept: application/json
   Authtoken: <authentication token>
   Content-type: application/json
   <update_schedule_policy_entity_assoc_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

Request Body

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

<associations clientName="client001" />
<associations clientGroupId="2" />
    

Response

Examples

Sample Request

XML

This request associates all default backup set subclients except for the DDBBackup subclient with the schedule policy.

PUT <webservice>/Task HTTP/1.1
 Host: client1.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <TMMsg_ModifyTaskReq>
   <taskInfo taskOperation="MODIFY">
     <associations clientName="client001" appName="file system" backupsetName="defaultBackupSet" />
     <associations clientName="client001" appName="file system" backupsetName="defaultBackupSet" subclientName="DDBBackup">
       <flags exclude="1" />
     </associations>
     <task>
       <task taskName="Snap plan"/>
     </task>
   </taskInfo>
 </TMMsg_ModifyTaskReq>
    

JSON

This request associates all default backup set subclients except for the DDBBackup subclient with the schedule policy.

PUT <webservice>/Task HTTP/1.1
 Host: client1.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/json
 {
   "taskInfo":{
     "taskOperation":5,
     "associations":[
       {
         "clientName":"client001",
         "backupsetName":"defaultBackupSet",
         "appName":"file system"
       },
       {
         "clientName":"client001",
         "subclientName":"DDBBackup",
         "backupsetName":"defaultBackupSet",
         "appName":"file system",
         "flags":{
           "exclude":true
         }
       }
     ],
     "task":{
       "task":{
         "taskName":"Snap plan"
       }
     }
   }
 }
    

Sample Response

XML

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <TMMsg_GenericResp errorMessage="" errorCode="0" />
    

JSON

{
 "errorCode": "0",
 "errorMessage": ""
 }