Skip to content

組織の一覧取得

説明

組織の一覧を取得します。

必要権限

なし

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[] 取得した組織の一覧

エラーケース

  • なし

特記事項

なし

サンプル

有効な組織を一覧で取得する

リクエスト
GET /system/organizations
レスポンス
200 OK

{
    "totalCount":19,
    "data":[
        {
            "parentOrganizationId":null,
            "name":"システム管理",
            "englishName":"",
            "code":"",
            "description":"",
            "treePath":"2/",
            "treeDepth":0,
            "displayOrder":0.5,
            "isDeleted":false,
            "id":"2",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:19Z",
            "updatedBy":"0"
        },
        {
            "parentOrganizationId":"71",
            "name":"営業1課",
            "englishName":"",
            "code":"",
            "description":"",
            "treePath":"69/71/4/",
            "treeDepth":2,
            "displayOrder":0.5,
            "isDeleted":false,
            "id":"4",
            "createdAt":"2019-01-10T07:29:22Z",
            "createdBy":"0",
            "updatedAt":"2019-01-11T04:33:52Z",
            "updatedBy":"21"
        },
        ・
        ・
        ・
    ]
}

型定義

Organization

名前 型 説明
id string 組織ID
parentOrganizationId string 親の組織ID
name string 名前
englishName string 英語名
code string コード
description string 説明
treePath string ツリーパス
treeDepth int ツリーの深さ
subOrganizations Organization[] 子組織
displayOrder double 組織の表示順。
UIで表示する際の表示順序を示します。
isDeleted boolean 削除されているか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID