Loading...

Update Schedule Policy Agent Associations (REST API: PUT)

This operation adds or removes agent associations on a schedule policy.

Request

Syntax

Send the request using either XML or 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_agent_assoc_template.xml or update_schedule_policy_agent_assoc_template.json. The following table displays the parameters for the request body.

Parameter

Description

Element

Parent Element

appGroupName

The name of the agent group associated with the schedule policy. Most agent groups in the appGroupName parameter represent a group of agents. For example, <appGroups appGroupName="APPGRP_BACKEDUP_FILES"/> is the Files/Protected Files group, and it includes several agents. To select individual agents in the Files/Protected Files group, use the appTypeName parameter.

Valid values are:

 

  • APPGRP_ARCHIVE_DOCS, Archived Documents
  • APPGRP_ARCHIVED_FILES, Archived Files
  • APPGRP_ARCHIVED_MAILS, Archived Mail
  • APPGRP_BACKEDUP_DOCS, Protected Documents
  • APPGRP_BACKEDUP_FILES, Protected Files
  • APPGRP_BACKEDUP_MAILS, Protected Mail
  • APPGRP_CLOUDAPPS, Cloud Apps
  • APPGRP_DB2, DB2
  • APPGRP_DBS, all databases
  • APPGRP_DISTRIBUTEDAPPS, Big Data Apps
  • APPGRP_DOCUMENTUM, Documentum
  • APPGRP_INFORMIX, Informix
  • APPGRP_JOURNALED_MAILS, Journaled Mail
  • APPGRP_MySql, MySQL
  • APPGRP_NotesDb, Notes DB
  • APPGRP_NotesDb_Transaction_Log, Notes DB (Transaction Log Subclients)
  • APPGRP_NotesDoc, Notes Document
  • APPGRP_NotesDocDataMigrator, Domino Mailbox Archiver
  • APPGRP_ORACLE, Oracle
  • APPGRP_POSTGRES, PostgreSQL
  • APPGRP_SAP_FOR_ORACLE, SAP for Oracle
  • APPGRP_SAP_HANA, SAP HANA
  • APPGRP_SQL_POLICY, SQL Server
  • APPGRP_Sybase, Sybase
  • APPGRP_XchangeDB, Exchange DB
  • PACKAGEGRP_EXCHANGE, all archived files
  • PACKAGEGRP_WIN, All protected files

 

appGroups

appGroup

appTypeName

The name of the agent associated with the schedule policy. To select all of the agents in a group, use the appGroupName parameter.

Valid values are:

 

  • Active Directory
  • AIX File System
  • Big Data Apps
  • Cloud Apps
  • DB2
  • DB2 MultiNode
  • DB2 on Unix
  • Documentum
  • Domino Mailbox Archiver
  • DPM
  • Exchange Compliance Archiver
  • Exchange Database
  • Exchange Mailbox
  • Exchange Mailbox (Classic)
  • Exchange Mailbox Archiver
  • Exchange PF Archiver
  • Exchange Public Folder
  • File Share Archiver
  • FreeBSD
  • GroupWise DB
  • HP-UX Files System
  • Image Level
  • Image Level On Unix
  • Image Level ProxyHost
  • Image Level ProxyHost on Unix
  • Informix Database
  • Linux File System
  • MAC FileSystem
  • MS SharePoint Archiver
  • MySQL
  • NAS
  • Netware File Archiver
  • Netware File System
  • Notes Database
  • Notes Document
  • Novell Directory Services
  • Object Link
  • Object Store
  • OES File System on Linux
  • Oracle
  • Oracle RAC
  • Other External Agent
  • PostgreSQL
  • Proxy Client File System
  • ProxyHost on Unix
  • SAP for Oracle
  • SAP HANA
  • SharePoint Server
  • Solaris 64bit File System
  • Solaris File System
  • SQL Server
  • Sybase Database
  • Unix File Archiver
  • Unix Tru64 64-bit File System
  • Virtual Server
  • Window File System
  • Windows File Archiver

 

appTypes

appGroup

deleted

The option to remove an agent group association.

Valid value is 1.

flags

appGroups

deleted

The option to remove an agent association.

Valid value is 1.

flags

appTypes

taskName

The name of the schedule policy.

task

task

taskOperation

The operation to perform on the agent 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:

  • 0, successful completion.
  • a specific error code.

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 the DB2 agent group and the SQL Server agent 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">
    <appGroup>
      <appGroups appGroupName="APPGRP_DB2"/>
      <appTypes appTypeName="SQL Server"/>
    </appGroup>
    <task>
      <task taskName="SP002"/>
    </task>
  </taskInfo>
</TMMsg_ModifyTaskReq>

This request removes the DB2 agent group association from 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">
    <appGroup>
      <appGroups appGroupName="APPGRP_DB2">
        <flags deleted="1"/>
      <appGroups/>
    </appGroup>
    <task>
      <task taskName="SP002"/>
    </task>
  </taskInfo>
</TMMsg_ModifyTaskReq>

JSON

This request associates the DB2 agent group and the SQL Server agent 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,
    "task":{
      "task":{
        "taskName":"SP002"
      }
    },
    "appGroup":{
      "appGroups":[
        {
          "appGroupName":"APPGRP_DB2"
        }
      ],
      "appTypes":[
        {
          "appTypeName":"SQL Server"
        }
      ]
    }
  }
}

This request removes the DB2 agent group association from 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,  
    "task":{  
      "task":{  
        "taskName":"SP002"
      }
    },
    "appGroup":{  
      "appGroups":[  
        {  
          "appGroupName":"APPGRP_DB2",
          "flags":{  
            "deleted":true
          }
        }
      ]
    }
  }
}

Sample Response

XML

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

JSON

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

Last modified: 1/10/2018 7:50:40 PM