前のトピック: getRelatedList

次のトピック: getPendingChangeTaskListForContact

getRelatedListValues

getRelatedListValues メソッドでは、以下のパラメータを使用します。

パラメータ

タイプ

説明

SID

整数

ログインにより取得したセッションを指定します。

objectHandle

String

オブジェクト ハンドルを指定します。

listName

String

オブジェクトのリスト タイプの属性名を指定します。

numToFetch

整数

返される行の最大数を指定します。

  • 0 にすることはできません。
  • -1 を指定するとすべての行が返されます。

注: 指定した整数に関係なく、Web サービスでは 1 コールにつき最大 250 行を返すことができます。

attributes

String[]

値をフェッチする1つ以上の属性名の配列を指定します。 ドット付きの名前を使用できます。

getRelatedListValuesResult

String Holder

返されたデータをキャプチャするための String Holder オブジェクトを指定します。

numRowsFound

Integer Holder

返されたデータをキャプチャするための Integer Holder オブジェクトを指定します。

説明

特定のオブジェクトに関連したリストの値が返されます。 リストは QREL または BREL として定義する必要があります。 LREL タイプをクエリするには、LREL メソッドを使用します。

たとえば、リクエスト オブジェクトには「children」という名前の関連リストがあり、これは子リクエストのリストです。 このメソッドは、getRelatedList() に代わるものですが、リスト ハンドルを使用しません。 戻り値の形式は以下に示すとおり、getListValues() に似ています。

<numRowsFound>
< UDSObjectList >
<UDSObject>
<Handle>
<AttributeName0>
<AttributeName1>

オブジェクト スキーマ(majic)を使用して、オブジェクト リスト属性の情報を取得できます。 このメソッドの代わりに getObjectTypeInformation() を使用することができます。

戻り値

このメソッドは、以下の戻り値を返します。

XML エレメント

タイプ

説明

<getRelatedListValuesResult>

N/A

一連の <UDSObject> エレメントを含む外部エレメント <UDSObjectList> を示します。 各 <UDSObject> エレメントには、<Handle>エレメントおよび 0 個以上の <AttributeNameX> エレメントが含まれます。

<numRowsFound>

整数

クエリしたリストの全行数を示します。

注: 行数の合計は、必ずしも返された行数ではありません。