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
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_schedule_policy_entity_assoc_template.xml or update_schedule_policy_entity_assoc_template.json. The following table displays the parameters for the request body.
Parameter |
Description and Parameter Values |
Element |
Parent Element |
|||
associations |
You define the schedule policy entities in the <associations> element. You can use either the entity IDs or the entity names as parameters in the element. To work with multiple associations, add additional <associations> elements, for example:
Entities include all of the sub-entities under them unless the entity is specifically exclude by using the exclude parameter. For an example, see the sample request. |
taskInfo |
TMMsg_ModifyTaskReq |
|||
clientId |
The system-generated ID assigned to the client. |
associations |
taskInfo |
|||
clientName |
The name of the client. |
associations |
taskInfo |
|||
clientGroupId |
The system-generated ID assigned to the client computer group. |
associations |
taskInfo |
|||
clientGroupName |
The name of the client computer group. |
associations |
taskInfo |
|||
applicationId |
The ID of the application. For a list of application IDs, see the valid values for the appName parameter. |
associations |
taskInfo |
|||
appName |
The name of the application. Valid values for the applicationId and appName parameters:
|
associations |
taskInfo |
|||
backupsetId |
The system-generated ID assigned to the backup set. |
associations |
taskInfo |
|||
backupsetName |
The name of the backup set. |
associations |
taskInfo |
|||
instanceId |
The system-generated ID assigned to the instance. |
associations |
taskInfo |
|||
instanceName |
The name of the instance. |
associations |
taskInfo |
|||
subclientId |
The system-generated ID assigned to the subclient. |
associations |
taskInfo |
|||
subclientName |
The name of the subclient. |
associations |
taskInfo |
|||
storagePolicyName |
The name of the storage policy to add to the auxiliary copy schedule policy. |
associations |
taskInfo |
|||
storagePolicyId |
The system-generated ID assigned to the storage policy. |
associations |
taskInfo |
|||
copyName |
The name of the copy to add to the auxiliary copy schedule policy, for example, Primary. |
associations |
taskInfo |
|||
copyId |
The system-generated ID assigned to the copy. |
associations |
taskInfo |
|||
exclude |
The option to exclude an entity from an association. Valid value is 1. |
flags |
associations |
|||
deleted |
The option to remove an entity association. Valid value is 1. |
flags |
associations |
|||
taskName |
The name of the schedule policy. |
task |
task |
|||
taskOperation |
The operation to perform on the entity associations. JSON valid value is 5. XML valid value is MODIFY. |
taskInfo |
TMMsg_ModifyTaskReq |
Response
Parameter |
Description |
Element |
errorCode |
The possible error codes. Valid values are:
|
App_GenericResp |
errorMessage |
The description of the error code. Not all error codes have an error message. |
App_GenericResp |
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": ""
}