キュー作成

POST /v1/queue
リクエストパラメータ
パラメータ タイプ 必須 説明
name 文字列 はい キュー名（長さは1〜60文字）.
dataId 整数型 いいえ キュー拡張情報ID.
isAutoAssign 整数型 はい 自動割り当てするかどうか.
assignStrategy 整数型 いいえ 割り当て戦略（1.順番割り当て）.
supportObjectList オブジェクト いいえ サポートするオブジェクトリスト.
supportObjectList[].id 整数型 いいえ カスタムオブジェクトID.
userList オブジェクト いいえ ユーザーリスト.
userList[].id 整数型 いいえ ユーザーID.
userList[].order 整数型 いいえ ユーザー順序
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 可視性, true / false .
data オブジェクト ビジネスオブジェクト.
data.id 整数型 キューID.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/queue?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "name":"新規キュー",
    "isAutoAssign":0,
    "assignStrategy":1,
    "supportObjectList":[{
        "id":1
    }],
    "userList":[{
        "id":2,
        "order":1
    }]
}'
レスポンス例
成功レスポンス：
{
    "code": 200,
    "visible": false,
    "data": {
        "id": 4
    }
}
失敗レスポンス：
{
    "code": 400,
    "message": "名称长度不合法",
    "visible": true
}

キュー更新

PUT v1/queue/{id:^[1-9]\d*$}
パスパラメータ
パラメータ タイプ 必須 説明 制限
id 整数 はい ID. 1より大きい必要があります
リクエストパラメータ
パラメータ タイプ 必須 説明
name 文字列 はい キュー名.
dataId 整数 いいえ キュー拡張情報ID.
isAutoAssign 整数 はい 自動割り当てするかどうか.
assignStrategy 整数 いいえ 割り当て戦略(1.順番割り当て)
supportObjectList 配列 いいえ サポート対象オブジェクトリスト.
supportObjectList[].id 整数 いいえ オブジェクトID.
userList 配列 いいえ ユーザーリスト.
userList[].id 整数 いいえ ユーザーID
userList[].order 整数 いいえ ユーザー順序
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示するかどうか. true / false .
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/queue/1?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "name":"テストキュー1",
    "isAutoAssign":1,
    "assignStrategy":1,
    "supportObjectList":[{
        "id":1
    }],
    "userList":[{
        "id":2,
        "order":1
    }]
}'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

キューを取得

GET /v1/queue/{id:^[1-9]\d*$}
リクエストパラメータ（パス）
パラメータ タイプ 必須 説明 制約
id 整数 はい キューID 1より大きい必要があります
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示/非表示. true / false .
data オブジェクト ビジネスオブジェクト.
data.id 整数 キューID.
data.name 文字列 キュー名.
data.dataId 整数 キュー関連情報ID.
data.isAutoAssign 整数 自動割り当てフラグ.
data.assignStrategy 整数 割り当て戦略.
data.supportObjectList 配列 サポート対象オブジェクトリスト.
data.supportObjectList[].id 整数 オブジェクトID.
data.userList 配列 ユーザーリスト.
data.userList[].id 整数 ユーザーID.
data.userList[].order 整数 ユーザー順序 .
data.userList[].realname 文字列 氏名
data.userList[].email 文字列 メールアドレス
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/queue/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": "テストキュー",
        "dataId": null,
        "supportObjectList": [
            {
                "id": 1,
                "label": "購買オーダー"
            }
        ],
        "userList": [
            {
                "id": 2,
                "realname": "zhangsan",
                "email": "1@test.cn",
                "order": 1
            }
        ],
        "isAutoAssign": 0,
        "assignStrategy": null
    }
}

キュー削除

DELETE /v1/queue/{id:^[1-9]\d*$}
リクエストパラメータ
パラメータ タイプ 必須 説明
id 整数 はい キューID.
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示/非表示, true / false .
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/queue/1?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
}

キュー一覧取得

GET /v1/queue
リクエストパラメータ
パラメータ タイプ 必須 説明
pageNum 整数 はい ページ番号, 最小: 1.
pageSize 整数 はい ページサイズ, 最小: 1, 最大: 100.
##### レスポンスデータ

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

属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示/非表示, true / false .
paging オブジェクト ページネーションオブジェクト.
paging.pageNum 整数 ページ番号.
paging.pageSize 整数 1ページあたりの表示件数.
paging.total 整数 クエリにヒットした総件数.
data 配列 ビジネスオブジェクト.
data[].id 整数 キューID.
data[].name 文字列 キュー名.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/queue?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": 5,
        "total": 2
    },
    "data": [
        {
            "id": 5,
            "name": "テストキュー01"
        },
        {
            "id": 4,
            "name": "テストキュー02"
        }
    ]
}