指定組織一覧の取得

説明

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

必要権限

なし

URL

GET /system/organizations/{organizationId}/subOrganizations

パスパラメーター

名前	型	必須か	説明
organizationId	string	○	組織ID

クエリパラメーター

名前	型	必須か	説明
depth	int	×	取得するツリーの深さ
includeDeleted	boolean	×	削除済みデータも取得対象とするか true：削除されたデータを含めて取得します。 false：削除されていないデータのみを取得します。
isDeleted	boolean	×	includeDeleted =trueのとき有効とします。 true：削除されたデータのみを取得します。 false：削除されていないデータのみを取得します。

レスポンス

名前	型	説明
ー	Organization	取得した組織

エラーケース

• なし

特記事項

なし

サンプル

組織IDを指定し、その組織および配下の組織を2階層まで取得する

リクエスト

GET /system/organizations/69/suborganizations?depth=2

レスポンス

200 OK

{
    "parentOrganizationId":null,
    "subOrganizations":[
        {
            "parentOrganizationId":"69",
            "subOrganizations":[
                {
                    "parentOrganizationId":"71",
                    "name":"営業1課",
                    "englishName":"",
                    "code":"",
                    "description":"",
                    "treePath":"69/71/4/",
                    "treeDepth":2,
                    "displayOrder":0.5,
                    "isDeleted":false,
                    "metadata":{},
                    "id":"4",
                    "createdAt":"2019-01-10T07:29:22Z",
                    "createdBy":"0",
                    "updatedAt":"2019-01-11T04:33:52Z",
                    "updatedBy":"21"
                },
                {
                    "parentOrganizationId":"71",
                    "name":"営業2課",
                    "englishName":"",
                    "code":"",
                    "description":"",
                    "treePath":"69/71/5/",
                    "treeDepth":2,
                    "displayOrder":0.75,
                    "isDeleted":false,
                    "metadata":{},
                    "id":"5",
                    "createdAt":"2019-01-10T07:29:22Z",
                    "createdBy":"0",
                    "updatedAt":"2019-01-11T04:33:58Z",
                    "updatedBy":"21"
                }
                .
                .
                .
            ],
            "name":"営業部",
            "englishName":"",
            "code":"",
            "description":"",
            "treePath":"69/71/",
            "treeDepth":1,
            "displayOrder":0.5,
            "isDeleted":false,
            "metadata":{},
            "id":"71",
            "createdAt":"2019-01-11T04:32:39Z",
            "createdBy":"21",
            "updatedAt":"2019-01-11T04:32:39Z",
            "updatedBy":"21"
        },
        .
        .
        .
    "name":"第1事業部",
    "englishName":"",
    "code":"",
    "description":"",
    "treePath":"69/",
    "treeDepth":0,
    "displayOrder":0.625,
    "isDeleted":false,
    "metadata":{},
    "id":"69",
    "createdAt":"2019-01-11T04:31:41Z",
    "createdBy":"21",
    "updatedAt":"2019-01-07T00:03:13Z",
    "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