クラウド版製品マニュアル 楽々Webデータベース
ホーム > エクセル業務効率化支援ツール 楽々Webデータベース > マニュアルトップ > 添付資料. API > 組織管理のAPI: group-csv/get

group-csv/getOption

グループ情報をCSVファイルで取得します。パラメータ指定で絞り込みが可能です。

APIを使用するには、WebAPIオプション が必要です。

POST
http://example.com/RakWDB/webapi/v1/group-csv/get

リクエスト

ヘッダー

content-type
application/x-www-form-urlencoded
もしくは
multipart/form-data

パラメータ

webapikey

API で設定した認証キーを設定します。

lang

言語区分を設定します。
未設定時は実行ユーザーの初期表示言語を使用します。
以下の表示言語を変更できます。

  • CSV のヘッダー部
  • レスポンスのエラーメッセージ
param

検索条件をJSON形式で設定します。

項目名 フィールド 検索方法 / 設定値
グループセット名 groupset_name 完全一致
※画面ではポップアップから選択して検索
グループ名 group_name 前方一致

画面と同じで複数検索はできません。

設定例
{
    ugroupset_name:"",
    group_name:"グループ",    
}

レスポンス

ヘッダー

content-disposition
attachment; filename="group.csv"
content-type
text/x-comma-separated-values;charset=UTF-8

レスポンス

CSVファイルを返却します。CSV書式は、CSV一括更新動作設定 の設定によって異なります。
詳細は、5章 管理モード > CSV一括更新動作設定: CSV一括更新動作設定 をご参照ください。