1 / 1

2.10 部署の API

2.10.1 部署リストの取得 (/api/v2/department)

概要

部署リストを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data":  "id": 0,
        "name": " 日本コンピュータビジョン",
        "children": [
            {
                "id": 1,
                "name": " 開発部",
                "children": [
                    {
                        "id": 3,
                        "name": " クラウドサービス",
                        "children": [
                            { }
                        ],
                        "parent_id": 1,
                        "leader_id": 370108,
                        "leader_name": "test1",
                        "user_num": 15
                    },
                    {
                        "id": 56,
                        "name": "test2",
                        "children": [],
                        "parent_id": 1,
                        "leader_id": null,
                        "leader_name": null,
                        "user_num": 0
                    }
                ],
                "parent_id": 0,
                "leader_id": 372345,
                "leader_name": "leader",
                "user_num": 17
            }
      ]
}

レスポンスのフィールド

department フィールドの説明

エラーレスポンスのフィールド

2.10.2 部署コードでの部署の検索 (/api/v2/department/search/code)

概要

部署コードから部署情報を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/search/code

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 11,
        "name": "test",
        "code": "003",
        "parent_id": 0,
        "leader_id": null
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.3 ID での部署の検索 (/api/v2/department/{id})

概要

部署 ID から部署情報を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": " 開発部",
        "code": “003”,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.4 部署の作成 (/api/v2/department)

概要

部署作成のインターフェースです。

リクエストアドレスの例

https://HOST:PORT/api/v2/department

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": " 開発部",
        "code": null,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.5 部署の更新 (/api/v2/department/update)

概要

部署インターフェースを更新します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/update

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": "開発部",
        "code": null,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.6 部署の削除 (/api/v2/department/delete)

概要

部署を削除します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/delete

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
 "message": "OK"
}

エラーレスポンスのフィールド

2.10 部署の API

2.10.1 部署リストの取得 (/api/v2/department)

概要

部署リストを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data":  "id": 0,
        "name": " 日本コンピュータビジョン",
        "children": [
            {
                "id": 1,
                "name": " 開発部",
                "children": [
                    {
                        "id": 3,
                        "name": " クラウドサービス",
                        "children": [
                            { }
                        ],
                        "parent_id": 1,
                        "leader_id": 370108,
                        "leader_name": "test1",
                        "user_num": 15
                    },
                    {
                        "id": 56,
                        "name": "test2",
                        "children": [],
                        "parent_id": 1,
                        "leader_id": null,
                        "leader_name": null,
                        "user_num": 0
                    }
                ],
                "parent_id": 0,
                "leader_id": 372345,
                "leader_name": "leader",
                "user_num": 17
            }
      ]
}

レスポンスのフィールド

department フィールドの説明

エラーレスポンスのフィールド

2.10.2 部署コードでの部署の検索 (/api/v2/department/search/code)

概要

部署コードから部署情報を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/search/code

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 11,
        "name": "test",
        "code": "003",
        "parent_id": 0,
        "leader_id": null
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.3 ID での部署の検索 (/api/v2/department/{id})

概要

部署 ID から部署情報を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": " 開発部",
        "code": “003”,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.4 部署の作成 (/api/v2/department)

概要

部署作成のインターフェースです。

リクエストアドレスの例

https://HOST:PORT/api/v2/department

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": " 開発部",
        "code": null,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.5 部署の更新 (/api/v2/department/update)

概要

部署インターフェースを更新します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/update

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": "開発部",
        "code": null,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.6 部署の削除 (/api/v2/department/delete)

概要

部署を削除します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/delete

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
 "message": "OK"
}

エラーレスポンスのフィールド