getFieldDef

Purpose

Retrieves a full description of a field definition as an XML document in the sub-node describing objects.

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

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getFieldDef

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

objName

The object integration name.

fieldName

The field integration name.

Permissions Required

One of: VIEW, CREATE, EDIT, DELETE (VIEW by default)

Reviewers, What does VIEW by default mean?

Response

An XML document with the field definition in a DataFieldDef node.