> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Schedule and Schedule Policy Operations

REST API - POST Schedule Policy Add Agent

Updated

This operation adds an agent or agent group to the schedule policy.

Request

Syntax
 
POST <webservice>/Task/{taskId}/Agent/add HTTP/1.1
 Host: <web server host name>
 Accept: application/xml
 Authtoken: <authentication token>
 Content-type: text/plain
 <AgentTypeId or AgentGroupId to add>

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

taskId

The system-generated ID assigned to the schedule policy. If the task ID is not known, use the GET Schedule Policy API to retrieve it.

Yes
Request Headers

Name

Description

Host

The host name of the web server.

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. The valid value is text/plain.
Request Body

Name

Description

AgentGroupId

The agent types associated with the schedule policy. Some agent types in the agentGroupId parameter represent a group of agents. For example, <agentGroups agentGroupId="1"/> is the Files/Protected Files group, and it includes several agents. To select individual Files/Protected Files agents, use the agentTypeId element.

Valid values are:

Database

  • 11, DB2

  • 14, Exchange DB

  • 111, Informix

  • 12, Lotus Notes DB

  • 104, Lotus Notes DB (Transaction Log Subclients)

  • 100, MySQL

  • 10, Oracle

  • 114, PostgreSQL

  • 101, SAP for Oracle

  • 90, SQL Server

  • 13, Sybase

    Documentum

  • 115, Documentum

Exchange Mail

  • 7, Archived Mail

  • 8, Journaled Mail

  • 6, Protected Mail

    Files

  • 5, Archived Files

  • 1, Protected Files

    Lotus Notes

  • 67, Domino Mailbox Archiver

  • 68, Lotus Notes Document

    SharePoint

  • 2, Archived Documents

  • 3, Protected Documents

AgentTypeId

The agent types associated with the schedule policy. If all of the agents in a group are selected, the response will return the agentGroupId element, not the agentTypeId element. For example, if all of the agents under Files/Protected Files are selected, the response returns <agentGroups agentGroupId="1"/>, not individual agents in the agentTypeId element.

Valid values are:

Database/DB2

  • 37, DB2

  • 103, DB2 MultiNode

  • 62, DB2 on Unix

    Database/Exchange DB

  • 53, Exchange Database

    Database/Informix

  • 3, Informix Database

    Database/MySQL

  • 104, MySQL

    Database/Oracle

  • 22, Oracle Database

  • 80, Oracle RAC

    Database/Sybase

  • 5, Sybase Database

    Exchange Mail/Archived Mail

  • 56, Exchange Mailbox Archiver

  • 82, Exchange PF Archiver

    Exchange Mail/Journaled Mail

  • 67, Exchange Compliance Archiver

    Exchange Mail/Protected Mail

  • 54, Exchange Mailbox

  • 35, Exchange Public Folder

    Files/Archived Files

  • 73, File Share Archiver

  • 83, Netware File Archiver

  • 66, Unix File Archiver

  • 58, Windows File Archiver

    Files/Protected Files

  • 41, Active Directory

  • 21, AIX File System

  • 91, DPM

  • 74, FreeBSD

  • 17, HP-UX Files System

  • 65, Image Level

  • 75, Image Level On Unix

  • 76, Image Level ProxyHost

  • 87, Image Level ProxyHost on Unix

  • 29, Linux File System

  • 63, Macintosh File System

  • 13, NAS

  • 12, Netware File System

  • 10, Novell Directory Services

  • 124, Object Link

  • 131, Object Store

  • 86, OES File System on Linux

  • 130, Other External Agent

  • 38, Proxy Client File System

  • 40, ProxyHost on Unix

  • 64, CGI FileSystem

  • 20, Solaris 64bit File System

  • 19, Solaris File System

  • 36, Unix Tru64 64-bit File System

  • 106, Virtual Server

  • 33, Window File System

  • 107, Workstation Backup

    SharePoint/Archived Documents

  • 89, MS SharePoint Archiver

    SharePoint/Protected Documents

  • 78, SharePoint Server

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.

  • 2, a failure.

  • a specific error code.

TMMsg_GenericResp

errorMessage

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

TMMsg_GenericResp

Examples

Sample Request
POST <webservice>/Task/6441/Agent/add HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: text/plain
 AgentTypeId=104
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <TMMsg_GenericResp errorMessage="" errorCode="0" />