getRelationshipDef()

Purpose

Retrieves a description of a relationship definition as an XML document in a sub-node of the DataObjectDef node.

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

Syntax

getRelationshipDef(string sessionId, string relName);				
			

Parameters

Output

An XML document with the relationship definition in a RelationshipDef node.

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 retrieves a relationship definition:

String xmlData = binding.getRelationshipDef(sessionId, "R123456");