タスクベース対話エンティティインターフェース - Udesk

エンティティ-削除インターフェース

リクエストURL

DELETE /v1/entity/:id

リクエストパラメータ

パラメータ	タイプ	オプション	説明
id	Integer	false	エンティティID.
force	Integer	true	強制削除するかどうか 0:いいえ 1:はい（デフォルトは0）.

レスポンス結果

パス	タイプ	説明
code	Integer	実行結果コード
message	String	実行結果の説明

例

$ curl 'https://km.udesk.cn/api/v1/entity/12?force=0&email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス

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

エンティティ-更新インターフェース

リクエストURL

PUT /v1/entity/:id

リクエストパラメータ

リクエストフィールド

パス	タイプ	オプション	説明
robotId	Integer	false	ボットID.
name	String	false	エンティティ名.
apiName	String	false	API名（API名は英字、数字、アンダースコアのみ使用可能）.
remark	String	true	エンティティの説明（説明の長さは255文字以内）.
regex	String	true	エンティティ正規表現値 .
valueList	Array	true	エンティティ値リスト .
valueList[].id	Integer	true	エンティティ値ID
valueList[].originalValue	String	true	エンティティ値名
valueList[].changeType	Integer	true	変更状態（0.未変更 1.新規追加 2.変更 3.削除）
valueList[].similarValueList	Array	true	エンティティ値の類義語配列
valueList[].similarValueList[]	String	true	エンティティ値の類義語

レスポンス結果

パス	タイプ	説明
code	Integer	実行結果コード
message	String	実行結果の説明
data	Object	エンティティ情報
data[].id	Integer	エンティティID.
data[].robotId	Integer	ボットID.
data[].name	String	エンティティ名.
data[].apiName	String	エンティティAPI名.
data[].type	Integer	タイプ 1:カスタム 2:システム.
data[].status	Integer	エンティティ状態 0:無効 1:有効.
data[].regex	String	エンティティ正規表現値.
data[].sysEntityIdentifier	String	システム識別子記述子.
data[].remark	String	エンティティの説明.
data[].orders	Integer	エンティティの並び順.
data[].valueList	Array	エンティティ値リスト.
data[].valueList[].id	Integer	エンティティ値ID
data[].valueList[].originalValue	String	エンティティ値名
data[].valueList[].similarValueList	Array	エンティティ値の類義語配列
data[].valueList[].similarValueList[]	String	エンティティ値の類義語
### サンプル

$ curl 'https://km.udesk.cn/api/v1/entity/12?email=admin@udesk.cn&timestamp=1559016375&sign=7f31519fd01b85d4043b9413d1fad225718eb914' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "apiName": "api",
    "name": "エンティティ名",
    "regex": "/d+",
    "remark": "説明",
    "robotId": 83,
    "valueList": [
     {
       "changeType": 2,
       "id": 23,
       "originalValue": "エンティティ値",
       "similarValueList": [
         "類義語"
       ]
     }
    ]
  }'

レスポンス

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 12,
        "robotId": 83,
        "name": "エンティティ名",
        "apiName": "api",
        "type": 1,
        "status": 0,
        "regex": "/d+",
        "sysEntityIdentifier": null,
        "remark": "説明",
        "orders": 15,
        "valueList": [
            {
                "id": 23,
                "originalValue": "エンティティ値",
                "similarValueList": [
                    "類義語"
                ]
            }
        ]
    }
}

エンティティ-新規作成インターフェース

リクエストURL

POST /v1/entity

リクエストパラメータ

リクエストフィールド

Path	Type	Optional	説明
robotId	Integer	false	ボットID.
name	String	false	エンティティ名.
apiName	String	false	エンティティAPI名（API名は英字、数字、アンダースコアのみ使用可能）.
regex	String	true	エンティティ正規表現値 .
remark	String	true	エンティティ説明（説明は255文字以内）.

レスポンス

Path	Type	説明
code	Integer	実行結果コード
message	String	実行結果説明
data	Object	エンティティ情報
data[].id	Integer	エンティティID.
data[].robotId	Integer	エンティティのボットID.
data[].name	String	エンティティ名.
data[].apiName	String	エンティティAPI名.
data[].type	Integer	エンティティタイプ 1:カスタム 2:システム.
data[].status	Integer	エンティティステータス 0:無効 1:有効.
data[].regex	String	エンティティ正規表現値.
data[].sysEntityIdentifier	String	エンティティシステム識別子記述子.
data[].remark	String	エンティティ説明.
data[].orders	Integer	エンティティ順序.
data[].valueList	Array	エンティティ値リスト.
data[].valueList[].id	Integer	エンティティ値ID
data[].valueList[].originalValue	String	エンティティ値名
data[].valueList[].changeType	Integer	エンティティ変更タイプ（0.未変更 1.新規追加 2.変更 3.削除）
data[].valueList[].similarValueList	Array	類義値配列
data[].valueList[].similarValueList[]	String	類義値
### サンプル

$ curl 'https://km.udesk.cn/api/v1/entity?email=admin@udesk.cn&timestamp=1559016113&sign=f16d7f6fcc3fbab73855f4510cd4904f0f60e258' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "robotId" : 83,
    "name" : "エンティティ名",
    "apiName":"api",
    "remark":"説明"
  }'

レスポンス

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 2850,
        "robotId": 83,
        "name": "エンティティ名",
        "apiName": "api",
        "type": 1,
        "status": null,
        "regex": null,
        "sysEntityIdentifier": null,
        "remark": "説明",
        "orders": null,
        "valueList": null
    }
}

リクエスト失敗の原因

{
  "code": 400,
  "message": "{具体的な例外情報}",
  "visible": false
}

message	description
"【具体的なフィールド】...."	【具体的なフィールド】{エラーの原因}

エンティティ-有効/無効化インターフェース

リクエストURL

PUT /v1/entity/:id/status/:status

リクエストパラメータ

リクエストフィールド

path	Type	Optional	Description
id	Integer	false	エンティティID.
status	Integer	false	エンティティステータス 0:無効 1:有効.

リクエスト結果

Path	Type	Description
code	Integer	実行結果コード
message	String	実行結果の説明

サンプル

$ curl 'https://km.udesk.cn/api/v1/entity/12/status/1?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス

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

エンティティ-詳細取得インターフェース

リクエストURL

GET /v1/entity/:id

リクエストパラメータ

リクエストフィールド

path	Type	Optional	Description
id	Integer	false	エンティティID.
### リクエスト結果
Path	Type	Description
---	---	---
code	Integer	実行結果コード
message	String	実行結果の説明
data	Object	エンティティ情報
data[].id	Integer	エンティティID.
data[].robotId	Integer	ロボットID.
data[].name	String	エンティティ名.
data[].apiName	String	エンティティAPI名.
data[].type	Integer	エンティティタイプ 1:カスタム 2:システム.
data[].status	Integer	エンティティステータス 0:無効 1:有効.
data[].regex	String	エンティティ正規表現値.
data[].sysEntityIdentifier	String	システム識別子記述子.
data[].remark	String	エンティティの説明.
data[].orders	Integer	エンティティの並び順.
data[].valueList	Array	エンティティ値リスト.
data[].valueList[].id	Integer	エンティティ値ID
data[].valueList[].originalValue	String	エンティティ値名
data[].valueList[].similarValueList	Array	エンティティ値の類義値配列
data[].valueList[].similarValueList[]	String	エンティティ値の類義値

例

$ curl 'https://km.udesk.cn/api/v1/entity/2850?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 2850,
        "robotId": 83,
        "name": "エンティティ名",
        "apiName": "api",
        "type": 1,
        "status": 1,
        "regex": null,
        "sysEntityIdentifier": null,
        "remark": "説明",
        "orders": null,
        "valueList": [
            {
                "id": 213984,
                "originalValue": "123123",
                "similarValueList": [
                    "b",
                    "a"
                ]
            }
        ]
    }
}

リクエスト失敗の原因

{
  "code": 400,
  "message": "{具体的な例外情報}",
  "visible": false
}

message	description
"Entity not exists"	パラメータ内の対応するIDのエンティティが存在しません
## エンティティ-リスト取得インターフェース
### リクエストURL
+ GET /v1/entity/robot/{robotId}

リクエストパラメータ

パラメータ	タイプ	オプション	説明
robotId	Integer	false	ロボットID.
pageNum	Integer	true	ページ番号 (デフォルトは1).
pageSize	Integer	true	1ページあたりの件数 (デフォルトは10,最大は100).
keyword	Integer	true	検索キーワード.
status	Integer	true	エンティティ有効化状態 0:無効 1:有効.

レスポンス結果

パス	タイプ	説明
code	Integer	実行結果コード
message	String	実行結果説明
data	Object	エンティティリスト情報
data[].id	Integer	エンティティID
data[].robotId	Integer	ロボットID,
data[].name	String	エンティティ名称
data[].apiName	String	エンティティAPI名称
data[].type	Integer	エンティティタイプ 1:カスタム 2:システム.
data[].status	Integer	エンティティ状態 0:無効 1:有効.
data[].regex	String	エンティティ正規表現値.
data[].sysEntityIdentifier	String	システム識別子記述子.
data[].remark	String	エンティティ説明.
data[].orders	Integer	エンティティソート順.
data[].valueList	Array	エンティティ値リスト.
data[].valueList[].id	Integer	エンティティ値ID
data[].valueList[].originalValue	String	エンティティ値名称
data[].valueList[].similarValueList	Array	エンティティ値の類義値配列
data[].valueList[].similarValueList[]	String	エンティティ値の類義値

例

$ curl 'https://km.udesk.cn/api/v1/entity/robot/83?pageNum=1&pageSize=15&keyword="エンティティ名称"&status=1&&email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 15,
        "total": 2
    },
    "data": [
        {
            "id": 179,
            "robotId": 83,
            "name": "都市エンティティ",
            "apiName": "sys_city",
            "type": 2,
            "status": 1,
            "regex": null,
            "sysEntityIdentifier": "中国のすべての都市・区県",
            "remark": null,
            "orders": 4,
            "valueList": null
        }
    ]
}

リクエスト失敗の原因

message	description
Failed to convert value of type 'java.lang.String' to required type 'java.lang.Integer'	整数型パラメータの値が異常です

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

エンティティ-削除インターフェース

リクエストURL

リクエストパラメータ

リクエストパラメータ

レスポンス結果

例

レスポンス

エンティティ-更新インターフェース

リクエストURL

リクエストパラメータ

リクエストフィールド

レスポンス結果

レスポンス

エンティティ-新規作成インターフェース

リクエストURL

リクエストパラメータ

リクエストフィールド

レスポンス

レスポンス

リクエスト失敗の原因

エンティティ-有効/無効化インターフェース

リクエストURL

リクエストパラメータ

リクエストフィールド

リクエスト結果

サンプル

レスポンス

エンティティ-詳細取得インターフェース

リクエストURL

リクエストパラメータ

リクエストフィールド

例

レスポンス

リクエスト失敗の原因

リクエストパラメータ

リクエストパラメータ

レスポンス結果

例

レスポンス

リクエスト失敗の原因

文档反馈