getObjectDef()

Purpose

Retrieves a full description of an object definition as an XML document. The XML schema for this document can be found at: https://app.infiniteblue.com/webapi/wsdl/metadata.xsd

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

Syntax

getObjectDef(string sessionId, string objDefName);

Parameters

Output

An XML document containing the object definition description in a DataObjectDef 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 the definition of a lead object.

String xmlData = binding.getObjectDef(sessionId, "lead");