getRelatedListValues

Web Services Methods › List/Query Methods › getRelatedListValues

getRelatedListValues

The following parameters apply to the getRelatedListValues method:

Parameter	Type	Description
SID	Integer	Identifies the session retrieved from logging in.
objectHandle	String	Identifies the object handle.
listName	String	Identifies a list-type attribute name for the object.
numToFetch	Integer	Signifies the maximum number of rows to return. Cannot be zero Specify -1 to return all rows Note: Regardless of the integer specified, Web Services can return a maximum of 250 rows per call.
attributes	String[]	Identifies an array of one or more attribute names for which to fetch values. Dotted names are permitted.
getRelatedListValuesResult	String Holder	Identifies the String Holder object for capturing returned data.
numRowsFound	Integer Holder	Identifies the Integer Holder object for capturing returned data.

Description

Returns values for lists related to a specific object. The lists must be defined as a QREL or BREL. Use the LREL methods to query LREL types.

For example, the request object has a related list named “children”, that is a list of its child requests. This method is a list handle-free alternative to getRelatedList(). The return format is similar to getListValues(), as indicated by the following:

<numRowsFound>

< UDSObjectList >

<UDSObject>
<Handle>
<AttributeName0>
<AttributeName1>

You can retrieve information for object list attributes using object schema (majic). An alternative method is to use getObjectTypeInformation().

Returns

This method has the following returns:

XML Element	Type	Description
<getRelatedListValuesResult>	N/A	Identifies the outer element, <UDSObjectList>, that contains a sequence of <UDSObject> elements. Each <UDSObject> element contains a <Handle> element and zero or more <AttributeNameX> elements.
<numRowsFound>	Integer	Indicates the total number of rows in the queried list. Note: The total number of rows is not necessarily the number of rows returned.

XML Element

Type

Description

N/A

Identifies the outer element, <UDSObjectList>, that contains a sequence of <UDSObject> elements. Each <UDSObject> element contains a <Handle> element and zero or more <AttributeNameX> elements.

Integer

Indicates the total number of rows in the queried list.

Note: The total number of rows is not necessarily the number of rows returned.