deleteFieldDef()

Purpose

Permanently deletes an existing field definition from the specified object, along with any existing values for that field.

See Field XML Definition for a description of the DataFieldDef XML node and an example of its use.

Syntax

deleteFieldDef(string sessionId, string objDefName, string fieldName);

Parameters

Output

Status text: Field 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 firstName field from lead objects:

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