Previous Topic: getLrelLengthNext Topic: createLrelRelationships

Web Services Methods › LREL Methods › getLrelValues

getLrelValues

The following parameters apply to the getLrelValues method:

Parameter

Type

Description

SID

Integer

Identifies the session retrieved from logging in.

contextObject

String

Identifies the object on one side of the LREL.

LrelName

String

Identifies the Lrel Name. Use the name.

startIndex

Integer

Identifies the position in the “list” from which to begin fetching.

endIndex

Integer

Identifies the Last “list” position from which to fetch. Specify -1 to fetch all rows from startIndex.

attributes

String[]

Identifies an array of one or more attribute names for which to fetch values.

Description

Returns attribute values for a range of objects in an LREL relationship. Remember that items involved in an LREL relationship have no specific ordering. In fact, it is not really a “list”, as defined in this document.

The start and end index parameters are there to help throttle a large number of items. The format is as follows:

< UDSObjectList >

<UDSObject>

<Handle>

<AttributeName0>

<AttributeName1>

Returns

This method has the following returns:

XML Element

Type

Description

<UDSObjectList>

Array

Specifies the outer element, which contains a sequence of <UDSObject> elements.

<UDSObject>

Sequence

Contains a <Handle> element and zero or more <AttributeNameX> elements.