List-FolderContents
最上位フォルダとして動作する、指定したフォルダまたはキャビネット内に含まれるオブジェクトをリストするグループを返します。
構文
<ie:webject name="List-FolderContents" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="CONTENT_TYPE" data="content_type"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FOLDER_PATH" data="pathname"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ARGS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
<ie:param name="WHERE" data="where-clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
パラメータ
必須
相互依存
オプション
INSTANCE
AUTHORIZATION
ACCEPT_LANGUAGE
CONTAINER_REF
ATTRIBUTE
DBUSER
CONNECTION_ATTEMPTS
DESCRIPTOR
CONNECTION_ATTEMPT_INTERVAL
FOLDER_PATH
CONTENT_TYPE
GROUP_FILTER
FORMAT
INCLUDE_ARGS
GROUP_IN
INCLUDE_CONSTRAINTS
GROUP_OUT
INCLUDE_DESCRIPTORS
REFERENCE_DELIMITER
NEXT_OP
REFERENCE_OUTPUT_DELIMITER
OBJECT_REF
UNFORMATTED
PASSWD
REFERENCE_EXCEPTIONS
TYPE
WHERE
WHERE_CASE_SENSITIVITY
* 
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、アダプタ Webject の概要の「一般 Webject パラメータ」セクションを参照してください。
CONTAINER_REF
Webject を適用する対象となる Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
MEMBERSHIP - ユーザーがメンバーになっているコンテキストのみが照会されます。
このパラメータを指定した場合、TYPE、WHERE、および FOLDER_PATH パラメータに対して実行される照会の範囲は、関連付けられたコンテキストに限られます。
CONTENT_TYPE
返されるオブジェクトのタイプ。返されるオブジェクトの複数のタイプを指定するために複数の値をこのパラメータに対して指定できます。
このパラメータの各値は、モデルクラスまたはサブタイプの完全修飾名です。このパラメータを指定しない場合は、フォルダ内に含まれるすべてのオブジェクトが返されます。このパラメータはオプションです。
FOLDER_PATH
コンテンツが返されるフォルダまたはキャビネットの完全修飾パス。
パスの最初の "/" の後ろにある文字列は、キャビネット名にする必要があります。たとえば、"System" キャビネットの下にある "a_folder" のパス名は、/System/a_folder です。
"/" のみを指定すると、すべてのルートレベルのキャビネットが返されます。
このパラメータには複数の値を指定できます。TYPE、WHERE、および OBJECT_REF の代わり、または追加でこのパラメータをフォルダを指定するのに使用できます。
GROUP_IN
エレメントごとに 1 つの UFID が含まれている入力グループの名前 (OBID 属性)。これはフォルダまたはキャビネットを表します。このパラメータはオプションです。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
OBJECT_REF
Windchill オブジェクトの Unique Federation Identifier (UFID)。複数の値を指定して複数のオブジェクトを識別できます。
このパラメータは、WHERE、FOLDER_PATH、および GROUP_IN の代わりに、または WHERE、FOLDER_PATH、および GROUP_IN と組み合わせて使用できます。
TYPE
照会するオブジェクトの通知可能な Windchill タイプの名前を指定します。WHERE を指定した場合、TYPE も指定される必要があります。OBJECT_REF はこのパラメータの代わり、または追加として指定できます。
WHERE
照会するオブジェクトを識別する照会定義式。このパラメータは、OBJECT_REF、FOLDER_PATH、および GROUP_IN の代わりに、または OBJECT_REF、FOLDER_PATH、および GROUP_IN と組み合わせて使用できます。
WHERE を指定した場合、TYPE も指定される必要があります。詳細については、TYPE および WHERE パラメータの指定を参照してください。
これは役に立ちましたか?