2.10 部署の API

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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
            }
      ]
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

leader_name

string

部署長の名前

user_num

int

部署内の人数

children

list<department>

下位部署のリスト

department フィールドの説明

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

leader_name

string

部署長の名前

user_num

int

部署内の人数

children

list<department>

下位部署のリスト

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

コード

メッセージ

説明

30001

Param Invalid

無効なパラメーターです

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

code

string

Yes

部署コード。長さ制限は 45

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

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

コード

メッセージ

説明

30001

Param Invalid

無効なパラメーターです

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

部署ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

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

コード

メッセージ

説明

30001

Param Invalid

無効なパラメーターです。部署IDが存在しません

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

parentId

long

Yes

上位部署 ID

name

string

Yes

名前。長さ制限は 50。空の値で登録しないでください

leaderId

long

No

部署長の ID

code

string

No

部署コード。長さ制限は 45

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

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

コード

メッセージ

説明

30001

Param Invalid

上位の部署を選択ください

610

Similar record Exist

同じ名前の部署が同じレベルに存在します

620

Record non-existent Error

上位部署の ID が存在しません

30001

Param Invalid

無効なパラメーターです。部署名は空にはできません

30001

Param Invalid

無効なパラメーターです。部署長が存在しません

30001

Param Invalid

無効なパラメーターです。部署コードはすでに存在します

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

部署ID

parentId

long

Yes

上位部署 ID。上位部署IDが存在しない場合、エラーとなる可能性があります。ご注意ください

name

string

Yes

名前。長さ制限は 50

leaderId

long

No

部署長の ID

code

string

No

部署コード。長さ制限は 45

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

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

コード

メッセージ

説明

610

Similar record Exist

同じ名前の部署が同じレベルに存在します

620

Record non-existent Error

上位部署の ID が無効です（現在のノードの上位部署は指定できません）

30001

Param Invalid

無効なパラメーターです。上位部署の ID は空にはできません

30001

Param Invalid

無効なパラメーターです。部署 ID は空にはできません

30001

Param Invalid

無効なパラメーターです。部署名は空にはできません

30001

Param Invalid

無効なパラメーターです。部署長が存在しません

30001

Param Invalid

無効なパラメーターです。部署コードはすでに存在します

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

概要

部署を削除します。

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

部署ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

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

コード

メッセージ

説明

610

Similar record Exist

部署にユーザーが存在しているため、部署を削除できません

610

Similar record Exist

部署に下位部署があります

620

Record non-existent Error

上位部署の ID が存在しません

前へ2.9 認証用顔写真の API次へ2.11 イベントサブスクリプション API

最終更新