従業員グループの作成

POST /v1/userGroup

リクエストパラメータ
パラメータ タイプ 必須 説明
name 文字列 はい 従業員グループ名.
userList 配列 いいえ 従業員リスト.
userList[].id 整数 はい 従業員ID.
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性, true / false .
data オブジェクト ビジネスオブジェクト.
data.id 整数 従業員グループID.
data.name 文字列 従業員グループ名.
data.userCount 整数 従業員数.
data.userList 配列 従業員リスト.
data.userList[].id 整数 従業員ID.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "name" : "テスト従業員グループ1",
  "userList" : [ {
    "id" : 2
  } ]
}'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 1,
    "name" : "テスト従業員グループ1",
    "userCount" : 1,
    "userList" : [ {
      "id" : 2
    } ]
  }
}

従業員グループの更新

PUT /v1/userGroup/{id:^[1-9]\d*$}

埋め込みリクエストパラメータ
パラメータ タイプ 必須 説明 制限
id 整数 はい 従業員グループID 1より大きい必要があります
リクエストパラメータ
パラメータ タイプ 必須 説明
name 文字列 はい 名称.
userList 配列 はい 従業員リスト.
userList[].id 整数 はい 従業員ID.
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性, true / false .
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup/1?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "name" : "テスト従業員グループ2",
  "userList" : [ {
    "id" : 3
  } ]
}'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : true
}

従業員グループの検索

GET /v1/userGroup/{id:^[1-9]\d*$}

リクエストパラメータ
パラメータ タイプ 必須 説明 制限
id 整数型 はい 従業員グループID 1より大きい必要があります
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性. true / false .
data オブジェクト ビジネスオブジェクト.
data.id 整数型 従業員グループID.
data.name 文字列 名前.
data.userCount 整数型 従業員数.
data.userList 配列 従業員リスト.
data.userList[].id 整数型 従業員ID.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup/1?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 1,
    "name" : "テスト従業員グループ2",
    "userCount" : 1,
    "userList" : [ {
      "id" : 3
    } ]
  }
}

従業員グループの削除

DELETE /v1/userGroup/{ids}

リクエストパラメータ
パラメータ タイプ 必須 説明 制限
id 整数型 はい 従業員グループID 1より大きい必要があります
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性. true / false .
data オブジェクト ビジネスオブジェクト.
data.successList 配列 削除成功リスト
data.successTotal 整数型 削除成功数
data.failMap オブジェクト 削除失敗マップ
data.failTotal 整数型 削除失敗数
data.total 整数型 削除成功と失敗の合計数
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup/3,4?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "successList" : [3],
    "successTotal" : 1,
    "failMap" : {
        "4" : "従業員グループが存在しません"
    },
    "failTotal" : 1,
    "total" : 2
  }
}

従業員グループリストの取得

GET /v1/userGroup

リクエストパラメータ
パラメータ タイプ 必須 説明
pageNum 整数型 否 ページ番号, 最小: 1, デフォルト: 1.
pageSize 整数型 否 ページサイズ, 最小: 1, 最大: 100, デフォルト: 20.
レスポンスデータ

標準ページネーションオブジェクトページネーション

属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列型 レスポンスメッセージ.
visible ブール型 可視性, true / false .
paging オブジェクト ページネーションオブジェクト.
paging.pageNum 整数型 ページ番号.
paging.pageSize 整数型 ページサイズ.
paging.total 整数型 ページネーションクエリの総ヒット数.
data 配列 ビジネスオブジェクト.
data[].id 整数型 ID.
data[].name 文字列型 名称.
data[].userCount 整数型 従業員数.
data[].userList 配列 従業員リスト.
data[].userList[].id 整数型 ユーザーID.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&pageSize=10&pageNum=1' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "paging": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 50
  },
  "data" : [ {
    "id" : 187,
    "name" : "テスト従業員グループ1",
    "userCount" : 3,
    "userList" : [{
        "id" : 2
    }]
  }, {
    "id" : 383,
    "name" : "テスト従業員グループ2",
    "userCount" : 1,
    "userList" : [{
        "id" : 3
    }]
  }]
}