getRelationshipDef

Purpose

Retrieves an XML document containing a full description of a relationship definition in a sub-node of the node describing an object.

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

HTTP Method

GET

URL

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

URL Parameters

sessionId

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

relName

The relationship 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 a relationship definition in the RelationshipDef node.