deleteObjectDef()

Purpose

Permanently deletes an existing object definition, its components, and its records.

See Object XML Definition for a description of the DataObjectDef XML node and an example of its use.

Syntax

deleteObjectDef(string sessionId, string objDefName);

Parameters

Output

Status text: Object ABC has been deleted

Permissions Required

All metadata methods require administrative privileges, regardless of the view, edit, create and delete permissions set on the application or object. Establish the session by logging in with credentials for an administrative user.

Example

The following example deletes the definition of a lead object, its records, and components.

String infoMessage = binding.deleteObjectDef(sessionId, "lead");