組織一覧の取得
説明
組織の一覧を取得します。
必要権限
なし
URL
GET /system/organizations
クエリパラメーター
名前 | 型 | 必須か | 説明 |
---|---|---|---|
name | string | × | 名前 |
englishName | string | × | 英語名 |
code | string | × | コード |
keyword | string | × | キーワード 以下のフィールドに指定したキーワードを持つ組織を取得します。 ・名前 ・英語名 ・コード |
depth | int | × | 取得するツリーの深さ |
includeDeleted | boolean | × | 削除済みデータも取得対象とするか true:削除されたデータを含めて取得します。 false:削除されていないデータのみを取得します。 |
isDeleted | boolean | × | includeDeleted =trueのとき有効とします。 true:削除されたデータのみを取得します。 false:削除されていないデータのみを取得します。 |
limit | int | × | データの最大取得件数 |
offset | int | × | 何件目のデータから取得するか 省略した場合の既定値は 0 で先頭のデータから取得します。 |
orderby | string | × | 並び替えに用いるフィールド フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。 asc:昇順(既定値) desc:降順 |
レスポンス
名前 | 型 | 説明 |
---|---|---|
totalCount | int | 検索条件に該当する組織の総数 |
data | Organization[] | 取得した組織の一覧 |
エラーケース
- なし