deleteRelationshipDef()

Purpose

Permanently deletes an existing relationship definition.

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

Syntax

deleteObjectDef(string sessionId, string relName);

Parameters

sessionId

A string containing the session ID obtained at log in.

relName

String containing the integration name for the relationship definition to delete

Output

Status text: Field R123456 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 a relationship definition:

String infoMessage = binding.deleteRelationshipDef(sessionId, "R123456");