Previous Topic: freeListHandlesNext Topic: getRelatedListValues


getRelatedList

The following parameters apply to the getRelatedList 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 of the object.

Description

Returns a list handle for list (QREL or BREL) attribute of an object. For example, the request object has a related list named “children”, which is a list of its child requests. The Request’s Activity Log (“act_log” or “act_log_all”) is another example.

To retrieve information about an object’s list attributes, refer to the object schema (majic) documentation or use getObjectTypeInformation().

Returns

The following:

XML Element

Type

Description

<listHandle>

Integer

Identifies the list handle.

<listLength>

Integer

Identifies the length of the list generated.