PlatioSearchUser - Platioユーザーの検索

Platioユーザーを検索します。
共通ユーザー機能が有効な場合、検索で取得できるユーザーは、指定したアプリケーションで設定済みのユーザーのみになります。

■ストリーム情報

入力フォーマットすべて
接続数無制限
説明 入力ストリームは使用せず、すべて無視します。
出力フォーマットRecord
説明 検索されたユーザー情報を以下のフィールドを持つレコード形式で出力します。
フィールド名データ型
IdStringユーザーのID
NameStringユーザーの名前
EmailStringユーザーのメールアドレス
AdminBooleanユーザーが管理者かどうかのフラグ
ApiAccessBooleanユーザーがPlatio APIを使えるかどうかのフラグ
ManagementApiAccessBooleanユーザーが管理APIを使えるかどうかのフラグ
ProfileNameStringユーザーに割り当てるプロファイル
TeamNameStringユーザーに割り当てるチーム
TeamLeaderBooleanユーザーがチームリーダーかどうかのフラグ
DisabledBooleanユーザーの有効・無効フラグ

■コンポーネントプロパティ

名前プロパティ型マッピング説明
コネクションを使用boolean- 接続先に以下のコネクション名 を使用するかどうか選択します。
はい [true] - 以下のコネクション名 で指定されたPlatio接続名を接続先として使用します。
いいえ [false] - コネクション情報 以下のプロパティを使ってPlatioに接続を行います。
コネクション名connection-コネクションを使用 が「はい」の場合に、Platioアプリケーションへの接続用コネクションを指定します。
コネクションペインまたは管理コンソールにて作成した接続名を選択します。
コネクション情報group-コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。
アプリケーションベースURLstring入力&出力 PlatioのアプリケーションベースURLを指定します。
指定するURLは「 https://api.plat.io/v1/[アプリケーションのID] 」の形式で指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
トークンIDstring入力&出力 Platioの開発者向け情報ページから取得したAPIトークンのトークンIDを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
秘密トークンpassword入力&出力 Platioの開発者向け情報ページから取得したAPIトークンの秘密トークンを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
タイムアウトint入力&出力 Platioアプリケーションへの接続時のタイムアウト値を指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
プロキシ設定を使用boolean- 管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
はい [true] - プロキシ設定を使用します。
いいえ [false] - プロキシ設定を使用しません。
ユーザーIDstring入力&出力 取得するユーザーのIDを指定します。事前に取得するユーザーのIDが分かっている場合にはこのプロパティにユーザーIDを指定してください。
検索条件string入力&出力 検索条件を指定します。
指定した文字列がユーザーの名前、メールアドレス、プロファイル名、チーム名のいずれかに含まれるユーザーを検索します。大文字・小文字は区別しません。
ユーザーIDを指定しない場合に使用されます。
スキップ件数int入力&出力 読み飛ばすユーザーの数を指定します。
「10」を指定した場合、検索された先頭から10ユーザーは出力されず、11番目のユーザーから出力されます。
ユーザーIDを指定しない場合に使用されます。
取得件数int入力&出力 取得するユーザー数を指定します。
未指定または0以下を指定した場合には、すべてのユーザーを取得します。
ユーザーIDを指定しない場合に使用されます。
ループを開始loopProcess- 検索されたユーザーをまとめて出力するか、1レコードずつループして出力するかを選択します。
はい [true] - ループの起点となって1レコードずつストリームに出力されます。
いいえ [false] - すべてのレコードがまとめてストリームに出力されます。

■ループ処理

■トランザクション処理

コミット何もしません。
ロールバック何もしません。

■エラー処理

タイプパラメーターエラー処理フロー
へのストリーム
エラー
コード
説明
APIエラー「APIエラーのパラメーター 」
を参照してください。
コンポーネントの入力ストリーム1 Platio APIがエラーを返した場合
  • パラメーターが不正な場合
  • ユーザー認証に失敗した場合
  • リクエストが許可されていない場合
  • リクエスト数の制限に達した場合
  • サーバー上で問題が発生した場合
  • 一時的にサービスを使用することができない場合
接続エラー なし コンポーネントの入力ストリーム2Platioとの通信中にエラーが発生した場合
3Platioとの通信中、もしくは通信前処理でエラーが発生した場合
ユーザーが無い なし コンポーネントの入力ストリーム13ユーザーが検索されなかった場合
汎用 なし コンポーネントの入力ストリーム5コネクション名 に指定したコネクションが見つからない場合
9Platioに関連するその他のエラーが発生した場合

■「APIエラー」のパラメーター

No.名前説明
1ErrorCodePlatio APIのエラーコードが返されます。
2StatusCodeHTTPのステータスコードが返されます。
3ErrorResponseエラーレスポンスのJSONが返されます。

■APIトークンの取得方法

Platio APIを使用するためにはAPIトークンを生成する必要があり、PlatioSearchUserコンポーネントは生成したAPIトークンを指定する必要があります。
APIトークンには「トークンID」と「秘密トークン」がありPlatioの「開発者向け情報」ページで生成することができます。
「トークンID」はAPIトークンを生成後、Platioの「開発者向け情報」ページよりいつでも確認することができますが、「秘密トークン」はAPIトークン生成時のみ表示され、その後、値を確認することはできません。
「秘密トークン」はAPIトークン生成時に「クリップボードにコピー」アイコンをクリックしてコピーし保存してください。

■Platio APIリクエスト回数

PlatioSearchUserコンポーネントのPlatio APIリクエスト回数は以下のようになります。
API説明
ユーザーリスト・ユーザーの取得ユーザーIDを指定した場合に1回実行します。
検索条件を指定して検索されたユーザー数、100ユーザーごとにリクエスト回数が増加します。
例:検索条件で指定した値で、250ユーザーが検索される場合は、APIは3回実行されます。