REST API - DELETE Schedule Policy Entity

This operation removes an entity association from the schedule policy.

Request

Syntax

DELETE <webservice>/Task/{taskId}/Entity HTTP/1.1

 Host: <web server host name>

 Accept: application/xml

 Authtoken: <authentication token>

 Content-type: text/plain

 <entity ID to delete>

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

ClientGroupId

The system-generated ID assigned to the client computer group. If the client computer group ID is not known, use the GET Client Group API to retrieve it.

ClientId

The system-generated ID assigned to the client. If the client ID is not known, use the GET Client API to retrieve it.

AppTypeId

The agent types associated with the schedule policy. If all of the agents in a group are selected, the response will return the appGroupId element, not the appTypeId element. For example, if all of the agents under Files/Protected Files are selected, the response returns <appGroups appGroupId="1"/>, not individual agents in the appTypeId 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

InstanceId

The system-generated ID assigned to the instance.

BackupSetId

The system-generated ID assigned to the backup set. If the backup set ID is not known, use the GET Backup Set API to retrieve it.

SubclientId

The system-generated ID assigned to the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it.

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.