List Custom Fields(カスタム項目のリスト)

SmartHRからカスタム項目のリストを取得します

オプション

フィールド 定義 タイプ 必須
Result Set(結果セット)

次のいずれかのオプションを選択して結果を返します。

  • [First 100 Records(最初の100レコード)]:最初に一致する100レコードを返します。

  • Stream Records(レコードのストリーミング) :一致するすべてのユーザーレコードを親フローからヘルパーフローに渡します。ストリーミングのためのヘルパーフローを選択し、カスタム拡張可能フィールドを追加できる[Streaming(ストリーミング)]入力セクションをカードに追加します。

ドロップダウン TRUE

多数のレコードを返す方法については、「ヘルパーフローを使ったレコードのストリーミング一致」を参照してください。

入力

フィールド 定義 タイプ 必須
Streaming(ストリーミング)
Flow(フロー)

[Choose Flow(フローの選択)]をクリックし、検索結果がストリーミングされるヘルパーフローを参照および選択して、[Choose(選択)]をクリックして確定します。

オプションとして、[Click or drop here to create (クリックまたはここにドロップして作成)]の下の空のフィールドをクリックし、データをヘルパーフローに渡すカスタム拡張可能フィールドを追加します。これらのフィールドは、ヘルパーフロー内の[State(状態)]出力オブジェクトの下にキーと値のペアとして追加されます。

このフィールドは、[Result Set(結果セット)]フィールドでStream Records(レコードのストリーミング) が選択されている場合に表示されます。

ストリーミングヘルパーフロー内のヘルパーカードの入力フィールドは、ストリーミングレコードを取得するために、キーRecord(レコード)(タイプオブジェクト)を参照する必要があります。状態入力値を得るには、Record(レコード)オブジェクトのキーState(状態)(typeオブジェクト)を参照します。

Flow(フロー) TRUE
Record Limit(レコード制限)

ストリーミングするレコードの数を指定します。

  • [Record Limit(レコード制限)]フィールドを0に設定すると、レコードは返されません。

  • [Record Limit(レコード制限)]フィールドを0より大きい値に設定すると、0より大きい値から指定された最大レコード数までのレコードが返されます。

  • [Record Limit(レコード制限)]フィールドが空、null、または未選択の場合、すべてのレコードが返されます。

  • デフォルト値は500000です。

  • 有効な範囲は0500000です。

このフィールドは、[Result Set(結果セット)]オプションでStream Records(レコードのストリーミング) が選択されている場合に表示されます。

数値 TRUE

出力

フィールド 定義 タイプ
Result(結果)
Custom Fields(カスタム項目) オブジェクト
Custom Field ID(従業員カスタム項目ID) カスタム項目の一意の識別子。 テキスト
Name(名前) カスタム項目の名称。 テキスト
Type(タイプ) カスタム項目の入力タイプ。 テキスト
Elements(ドロップダウン項目)

enum入力タイプのドロップダウンリストオプション。

  • Item ID (Text)(ドロップダウンリスト項目ID(テキスト)) - ドロップダウンリスト項目ID

  • Display name (Text)(名称(テキスト)) - リスト項目の名称

  • Value (Text)(物理名称(テキスト)) - リスト項目の値

  • Position (Number)(ポジション(数値)) - リスト項目のポジション

オブジェクト(リスト)
Hint(ヒント) カスタム項目の入力ヒント。 テキスト
Scale(数値の場合の有効桁数) 数値の有効桁数。 数値
Separated by Commas(入力された数値を3桁ごとにカンマで区切って表示) 数値を3桁ごとにカンマで区切って表示します。 True/False
Position(ポジション) カスタム項目のポジション。 数値
作成日時 作成日。 日時
Updated At(最終更新日) 最終更新日。 日時
Custom Field Groups(カスタム項目グループ)

カスタム項目に関連付けられているカスタム項目グループ。

  • Custom Field Group ID (Text)(従業員カスタム項目グループID(テキスト)) - カスタム項目グループのID

  • Name (Text)(カスタム項目グループ名(テキスト)) - カスタム項目グループの名称

  • Position (Number)(ポジション(数値)) - カスタム項目のポジション

  • Access Type (Text)(アクセス種別(テキスト)) - アクセス種別。有効な値は、read_and_updatehiddenread_and_update_values、またはread_and_update_only_origin

  • Created At (Date & Time)(作成日(日時)) - 作成日

  • Updated At (Date & Time)(最終更新日(日時)) - 最終更新日

オブジェクト
Result(結果)
Records Streamed(ストリーミングされたレコード)

ストリーミングフロー内でストリーミングされたレコードの数。

このフィールドは、[Result Set(結果セット)]オプションで[Stream Matching Records(レコードのストリーミング)]を選択した場合に表示されます。

数値

関連項目

SmartHRコネクター

Workflows要素

SmartHR APIのドキュメント