Q&Aリストの検索

POST /sdk/knowledgeItems/search

Body リクエストパラメータ

{
  "pageSize": 10,
  "pageNum": 1,
  "knowledgeBaseId": "12246",
  "status": 1,
  "orderFlag": 1,
  "templateId": 0,
  "tagIds": []

}

リクエストパラメータ

名前 位置 タイプ 必須 日本語名 説明
knowledgeBaseId query integer はい ナレッジベースID
Content-Type header string いいえ none
body body object いいえ none
» pageNum body integer はい ページ番号 ページ番号
» pageSize body integer はい ページサイズ ページサイズ
» orderFlag body integer はい ソート ソート：1
» tagIds body [integer] いいえ タグリスト none
» knowledgeBaseId body integer はい ベースID none
» status body integer はい ナレッジステータス ナレッジステータス、固定値1を渡して公開済みナレッジを検索
» templateId body integer はい テンプレートid テンプレートid、固定値0を渡して非テンプレートナレッジを検索

例

リクエスト

curl --location --request POST 'https://knowledgeservice.s4.udesk.cn/api/sdk/knowledgeItems/search' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDMwNTk5LCJpYXQiOjE3NjI0Mjc1OTksInVzZXJJZCI6Mn0.bzZPWBD-qVaB2CpG5V7psO6UY7-dq0radv_2FN_I_n3AkTiTlahZT5A7iPwlyQ4jTCjlvgeHntW94biJ2U9T6LZA_5WHT4PJ0vnr2ZWhWl6oovzd_dREy2hxa_SL0L0myMQBxQoVR-BVKQX7LS9-ehNdNa9sgyeF5yUTneR7rjw' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=ae042aa8-1ad6-44bc-8434-7681d0192fe8' \
--data-raw '{"pageSize": 10,
  "pageNum": 1,
  "knowledgeBaseId": "12246",
  "status": 1,
  "orderFlag": 1,
  "templateId": 0,
  "tagIds": []

}'

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "paging": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 21
  },
  "data": [
    {
      "id": 362625,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-11-04 10:11:11",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-11-06 19:13:02",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        78852
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回帰テスト（変更禁止）",
      "categoryIdList": [
        78852
      ],
      "templateId": 0,
      "name": "テストナレッジ2025-11-04 10:11:10更新更新",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-11-06T19:13:02",
      "content": "テストナレッジテストナレッジ2025-11-04 10:11:10更新更新",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "browseCount": 1,
      "uvCount": 1,
      "source": 0,
      "deletePerson": false,
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 673526
    },
    {
      "id": 362624,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-11-04 09:59:20",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-11-04 09:59:20",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        75772
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回帰テスト（変更禁止）",
      "categoryIdList": [
        75772
      ],
      "templateId": 0,
      "name": "テストナレッジ2025-11-04 09:59:19",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-11-04T09:59:20",
      "content": "テストナレッジ2025-11-04 09:59:19",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 671240
    },
    {
      "id": 362623,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-11-04 09:54:00",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-11-04 09:54:00",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        75772
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回帰テスト（変更禁止）",
      "categoryIdList": [
        75772
      ],
      "templateId": 0,
      "name": "テストナレッジ2025-11-04 09:53:58",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-11-04T09:53:59",
      "content": "テストナレッジ2025-11-04 09:53:58",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 671238
    },
    {
      "id": 360423,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-30 19:37:40",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-30 19:37:40",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回帰テスト（変更禁止）",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "質問作成1761824256",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-10-30T19:37:40",
      "content": "質問への回答作成1761824256",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 668458
    },
    {
      "id": 360394,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-30 10:06:30",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-30 10:06:30",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回帰テスト（変更禁止）",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "質問作成1761789985",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-10-30T10:06:29",
      "content": "質問への回答作成1761789985",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 668383
    },
    {
      "id": 360337,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-29 10:14:42",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-29 15:39:28",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回帰テスト（変更禁止）",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "新規作成ナレッジドラフト保存",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 1,
      "approveUserId": 2,
      "approveTime": "2025-10-29T15:39:27",
      "content": "<p>新規作成ナレッジドラフト保存</p>",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 1,
      "uvCount": 1,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 668339
    },
    {
      "id": 360264,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-28 15:15:29",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-28 15:15:29",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回帰テスト（変更禁止）",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "新規
### レスポンス結果

| ステータスコード | ステータスコードの意味                                              | 説明 | データモデル |
| ------ | ------------------------------------------------------- | ---- | -------- |
| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | none | Inline   |

### レスポンスデータ構造

ステータスコード **200**

| 名前               | タイプ       | 必須  | 制約 | 日本語名                        | 説明 |
| ------------------ |----------| ----- | ---- |----------------------------| ---- |
| » succeed          | boolean  | true  | none |                            成功フラグ | none |
| » code             | integer  | true  | none |                            ステータスコード | none |
| » bizCode          | string   | true  | none |                            業務コード | none |
| » message          | string   | true  | none |                            メッセージ | none |
| » visible          | boolean  | true  | none |                            可視性 | none |
| » paging           | object   | true  | none |                            ページング情報 | none |
| »» pageNum         | integer  | true  | none |                            ページ番号 | none |
| »» pageSize        | integer  | true  | none |                            ページサイズ | none |
| »» total           | integer  | true  | none |                            総件数 | none |
| » data             | [object] | true  | none |                            データリスト | none |
| »» id              | integer  | false | none | ナレッジID                       | none |
| »» createUserId              | integer  | false | none | 作成ユーザーID                     | none |
| »» createUserUsername              | string  | false | none | 作成ユーザー名                     | none |
| »» createTime              | string  | false | none | 作成時間                       | none |
| »» updateUserId              | integer  | false | none | 更新ユーザーID                     | none |
| »» updateUserUsername              | string  | false | none | 更新ユーザー名                     | none |
| »» updateTime              | string  | false | none | 更新時間                       | none |
| »» deleteFlag              | integer  | false | none | 削除フラグ                       | none |
| »» categoryIdMultiple              | [object] | false | none | カテゴリ                         | none |
| »» knowledgeCreateBool              | boolean  | false | none | 権限フラグ（作成）                       | none |
| »» knowledgeManageBool              | boolean  | false | none | 権限フラグ（管理）                       | none |
| »» knowledgeBaseId | integer  | false | none | スペースID                       | none |
| »» knowledgeBaseName      | string  | false | none | スペース名                       | none |
| »» categoryIdList              | [object] | false | none | カテゴリリスト                         | none |
| »» templateId            | integer   | false | none | テンプレートID                       | none |
| »» name            | string   | false | none | QA名                       | none |
| »» status            | integer   | false | none | ステータス                         | none |
| »» availableTimeType            | integer   | false | none | 有効フラグ                       | none |
| »» accessLevel            | integer   | false | none | アクセス権限，0：公開可，1：内部のみ           | none |
| »» approveUserId            | integer   | false | none | 承認者                        | none |
| »» approveTime            | string   | false | none | 承認時間                       | none |
| »» content         | string   | true  | none | QA内容                       | none |
| »» share         |  [object]  | true  | none | 共有設定                         | none |
| »»» canShare         | boolean   | true  | none | 共有可否                       | none |
| »»» shareOutside         | boolean   | true  | none | 外部共有可否                    | none |
| »»» robotFlag         | boolean   | true  | none | ロボット設定有無                   | none |
| »»» backGround         | boolean   | true  | none | 背景スイッチ                       | none |
| »»» addWatermark         | boolean   | true  | none | ウォーターマーク追加(0:追加する,1:追加しない)         | none |
| »»» allowCopy         | boolean   | true  | none | コピー許可(0:許可する,1:許可しない)         | none |
| »» commentCount         | integer   | true  | none | コメント数                        | none |
| »» attachmentDownload         | boolean   | true  | none | 添付ファイルダウンロード権限                     | none |
| »» canEdit         | boolean   | true  | none | 編集可否                     | none |
| »» topFlag         | integer   | true  | none | トップ表示フラグ(0:未トップ,1:トップ中)            | none |
| »» topTime         | string   | true  | none | トップ表示時間                       | none |
| »» favoriteCount         | integer   | true  | none | お気に入り数                        | none |
| »» likeCount         | integer   | true  | none | いいね数                        | none |
| »» disLikeCount         | integer   | true  | none | 低評価数                        | none |
| »» browseCount         | integer   | true  | none | 閲覧数                        | none |
| »» uvCount         | integer   | true  | none | ユニークユーザー数                       | none |
| »» source         | integer   | true  | none | ソース                         | none |
| »» deletePerson         | boolean   | true  | none | true：削除可，false：削除不可（フィードバックボタン表示） | none |
| »» valid         | boolean   | true  | none | 有効フラグ    | none |
| »» uagentSyncStatus         | integer   | true  | none | uagent同期ステータス(0:未同期,1:同期済み)    | none |
| »» uagentSyncRetryTimes         | integer   | true  | none | 同期Agentリトライ回数    | none |
| »» historyId         | integer   | true  | none | 検索履歴ID       | none |
## Q&Aの追加

`POST /sdk/knowledgeItems`

> Body リクエストパラメータ

```json
{
  "name": "テスト知識2025-11-06 20:13:35",
  "categoryId": 78850,
  "content": "<p>テスト知識2025-11-06 20:13:35</p>",
  "availableTimeType": 0,
  "templateId": 0,
  "status": 1,
  "channelManagements": [
    {
      "id": null
    }
  ],
  "knowledgeBaseId": "12246"

}

リクエストパラメータ

名称 位置 タイプ 必須 日本語名 説明
knowledgeBaseId query integer はい 知識スペースID
systemType query string いいえ システムタイプ
Content-Type header string いいえ none
body body object いいえ none
» name body string はい QA名称 QA名称
» regulation body string はい 説明なし、空で送信
» categoryId integer false none カテゴリID none
» content body string はい QA内容 QA内容
» availableTimeType body integer はい 有効期間、0を指定で永久有効 有効期間、0を指定で永久有効
» templateId body integer はい テンプレートID テンプレートID、0を指定で非テンプレート知識を検索
» status integer false none ステータス none
» channelManagements [object] true none チャネル none
»» id integer true none チャネルID none
» knowledgeBaseId integer false none スペースID none
### サンプル

リクエスト

curl --location --request POST 'https://knowledgeservice.s4.udesk.cn/api/sdk/knowledgeItems' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM0MjE1LCJpYXQiOjE3NjI0MzEyMTUsInVzZXJJZCI6Mn0.qUgSnW8Tca6jbWpdAbqVUe-XhFNPVjDycOlyLyiiuV8KMODMdsD5nHtv5anxqkJElbHaVIi2IP43LVwEuKfo7RDChOSrgdrNa-r0DZG9EwA0zM-avIX17VqssARfOLQ4rHwbCAmMprYrIdC7Jy-uNlmjUnmXX5TiUZgKw4v6YVc' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=ef7f8ed1-83dc-4bdc-9a9f-8b0717587c90' \
--data-raw '{
  "name": "テスト知識2025-11-06 20:13:35",
  "categoryId": 78850,
  "content": "<p>テスト知識2025-11-06 20:13:35</p>",
  "availableTimeType": 0,
  "templateId": 0,
  "status": 1,
  "channelManagements": [
    {
      "id": null
    }
  ],
  "knowledgeBaseId": "12246"

}'

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "deleteFlag": 0,
    "categoryIdMultiple": [],
    "knowledgeBaseId": 12246,
    "categoryId": 78850,
    "categoryIdList": [],
    "templateId": 0,
    "name": "テスト知識2025-11-06 20:13:35",
    "status": 1,
    "availableTimeType": 0,
    "accessLevel": 0,
    "content": "テスト知識2025-11-06 20:13:35",
    "channelManagements": [
      {
        "deleteFlag": 0,
        "synchronousSend": 0
      }
    ],
    "canEdit": false,
    "topFlag": 0,
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "deletePerson": false,
    "langCode": "ZH-CN",
    "valid": true,
    "uagentSyncStatus": 0
  }
}

レスポンス結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK none Inline

レスポンスデータ構造

ステータスコード 200

名前 タイプ 必須 制約 日本語名 説明
» succeed boolean true none 成功フラグ none
» code integer true none コード none
» bizCode string true none 業務コード none
» message string true none メッセージ none
» visible boolean true none 可視性 none
» data [object] true none データ none
»» deleteFlag boolean false none 削除フラグ none
»» categoryIdMultiple [object] false none カテゴリ none
»» knowledgeBaseId integer false none ナレッジベースID none
»» categoryId integer false none カテゴリID none
»» categoryIdList [object] false none カテゴリIDリスト none
»» templateId integer false none テンプレートID none
»» name string false none QA名 none
»» status integer false none ステータス none
»» availableTimeType integer false none 有効時間タイプ none
»» accessLevel integer false none アクセスレベル，0：公開可，1：内部のみ none
»» content string true none QA内容 none
»» channelManagements [object] true none チャネル none
»»» deleteFlag integer true none 削除フラグ none
»»» synchronousSend integer true none 同期送信フラグ none
»» canEdit boolean true none 編集可能かどうか none
»» topFlag integer true none トップ表示フラグ(0:トップ表示なし,1:トップ表示あり) none
»» sdkSendFlag string true none SDK送信スイッチ none
»» sdkUseFlag integer true none SDK使用スイッチ none
»» deletePerson boolean true none true：削除可能，false：削除不可（フィードバックボタン表示） none
»» langCode string true none 言語コード デフォルトZH-CN
»» valid boolean true none 有効かどうか none
»» uagentSyncStatus integer true none uagent同期ステータス(0未同期,1同期済み) none
## Q&Aの更新

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

Body リクエストパラメータ

{
  "id": "258013",
  "historyId": 16892,
  "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
  "langCode": "ZH-CN",
  "name": "リッチテキストコンテンツを含むQA",
  "regulation": "",
  "similarQuestions": [],
  "tags": [],
  "accessLevel": 0,
  "status": 1,
  "availableTimeType": 0,
  "relevances": [],
  "channelContents": [],
  "kcs": {
    "libraries": []
  },
  "atomIds": "",
  "contentAnswerShowFlag": 0,
  "contentAnswerList": [],
  "referenceItemIds": "257566",
  "templateId": 0,
  "attachments": [],
  "content": "<p>1321，他の知識点を引用</p>\n<div style=\"display: inline-block;\">\n<p class=\"udesk-kcs-react-udesk-wfe-tinymce-knowledge-link\" style=\"cursor: pointer; color: #0000ee; padding: 0 6px; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; user-select: none;\" contenteditable=\"false\" data-id=\"257566\" data-name=\"E300硬盘盒怎么安装\" data-historyid=\"-1\" data-allowmanage=\"0\" data-templateid=\"0\" data-knowledgebaseid=\"281\">E300硬盘盒怎么安装</p>\n<p>123</p>\n</div>\n<p>&nbsp;</p>",
  "sdkSendFlag": 0,
  "sdkUseFlag": 0,
  "knowledgeBaseId": "281",
  "recordId": "",
  "channelManagements": [],
  "draftFlag": null,
  "categoryIdList": [
    11913
  ]
}

リクエストパラメータ

名前 位置 タイプ 必須 日本語名 説明
id:^[1-9]\d*$ path string はい なし
Authorization header string いいえ なし
Content-Type header string いいえ なし
body body object いいえ なし
» id body string はい 知識ID
» historyId body integer はい 知識バージョンID
» contentUuid body string はい UUID
» langCode body string はい ZH-CN
» name body string はい QA名
» regulation body string はい 説明なし、空文字を渡す
» similarQuestions body [string] はい 類似質問、なしの場合は[]を渡す
» tags body [string] はい 説明なし、[]を渡す
» accessLevel body integer はい 固定値0を渡す
» status body integer はい 知識ステータス、固定値1（公開済み知識）を渡す
» availableTimeType body integer はい 有効期間、固定値0（永久有効）を渡す
» relevances body [string] はい 説明なし、[]を渡す
» channelContents body [string] はい 説明なし、[]を渡す
» kcs body object はい 説明なし、空オブジェクトを渡す
»» libraries body [string] はい なし
» atomIds body string はい 説明なし、空文字を渡す
» contentAnswerShowFlag body integer はい 固定値0を渡す
» contentAnswerList body [string] はい 説明なし、[]を渡す
» referenceItemIds body string はい 説明なし、空文字を渡す
» templateId body integer はい テンプレートID、固定値0（非テンプレート知識を検索）を渡す
» attachments body [string] はい 説明なし、[]を渡す
» content body string はい QA回答
» sdkSendFlag body integer はい 固定値0を渡す
» sdkUseFlag body integer はい 固定値0を渡す
» knowledgeBaseId body string はい 知識スペースID
» recordId body string はい 説明なし、空文字を渡す
» channelManagements body [string] はい 説明なし、[]を渡す
» draftFlag body integer はい 下書きから編集、公開、下書き保存の場合、このフラグは1です
» categoryIdList body [integer] はい カテゴリセットID
### サンプル

リクエスト

curl --location --request PUT 'https://kcs.t1.in.tryudesk.com/api/sdk/knowledgeItems/258013' \
--header 'knowledgebaseid: 281' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM1NDE5LCJpYXQiOjE3NjI0MzI0MTksInVzZXJJZCI6Mn0.bYhqESpi7QvuYW64BraWz74hHr9_kw6xmfNLf_IeMwwyW-wztuJDnsgNgohXl6CpStambeedokbx37EEFJMudaIi2lzgSTzht6RCTIg7ZrgB4Y-BuOcK0O-h8klAOj5Y8g67VuUEqaGuV4GoJR5CVbJAibgvdYntZIYCWFiNaz8' \
--header 'Content-Type: application/json' \
--data '{
    "id": "258013",
    "historyId": 16892,
    "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
    "langCode": "ZH-CN",
    "name": "リッチテキストコンテンツを含むQA",
    "regulation": "",
    "similarQuestions": [],
    "tags": [],
    "accessLevel": 0,
    "status": 1,
    "availableTimeType": 0,
    "relevances": [],
    "channelContents": [],
    "kcs": {
        "libraries": []
    },
    "atomIds": "",
    "contentAnswerShowFlag": 0,
    "contentAnswerList": [],
    "referenceItemIds": "257566",
    "templateId": 0,
    "attachments": [],
    "content": "<p>1321，他のナレッジアイテムを参照</p>\n<div style=\"display: inline-block;\">\n<p class=\"udesk-kcs-react-udesk-wfe-tinymce-knowledge-link\" style=\"cursor: pointer; color: #0000ee; padding: 0 6px; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; user-select: none;\" contenteditable=\"false\" data-id=\"257566\" data-name=\"E300ハードドライブケースのインストール方法\" data-historyid=\"-1\" data-allowmanage=\"0\" data-templateid=\"0\" data-knowledgebaseid=\"281\">E300ハードドライブケースのインストール方法</p>\n<p>123</p>\n</div>\n<p>&nbsp;</p>",
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "knowledgeBaseId": "281",
    "recordId": "",
    "channelManagements": [],
    "draftFlag": null,
    "categoryIdList": [
        11913
    ]
}'

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "id": 258013,
    "deleteFlag": 0,
    "knowledgeBaseId": 281,
    "templateId": 0,
    "name": "リッチテキストコンテンツを含むQA",
    "regulation": "",
    "status": 1,
    "availableTimeType": 0,
    "content": "1321，他のナレッジアイテムを参照\n\nE300ハードドライブケースのインストール方法\n123\n\n&amp;nbsp;",
    "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
    "channelManagements": [],
    "attachments": [],
    "canEdit": false,
    "atomIds": "",
    "referenceItemIds": "257566",
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "accessLevel": 0,
    "contentAnswerList": [],
    "contentAnswerShowFlag": 0,
    "langCode": "ZH-CN",
    "translateRelBool": false,
    "systemType": 1,
    "categoryIds": "[11913]",
    "categoryIdList": [
      11913
    ]
  }
}

レスポンス結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK none Inline

レスポンスデータ構造

ステータスコード 200

名前 タイプ 必須 制約 日本語名 説明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» data object true none none
»» id integer true none ナレッジID none
»» deleteFlag integer true none 削除フラグ none
»» knowledgeBaseId integer true none ナレッジスペース none
»» templateId integer true none テンプレートID none
»» name string true none ナレッジ名 none
»» regulation string true none none
»» status integer true none ステータス none
»» availableTimeType integer true none 有効フラグ none
»» content string true none 内容 none
»» contentUuid string true none none
»» channelManagements [string] true none チャネル none
»» attachments [object] true none none
»» canEdit boolean true none 編集可能か none
»» atomIds string true none none
»» referenceItemIds string true none none
»» sdkSendFlag integer true none 固定値0 none
»» sdkUseFlag integer true none 固定値0 none
»» accessLevel integer true none 固定値0 none
»» contentAnswerList [string] true none none
»» contentAnswerShowFlag integer true none none
»» transfer object true none none
»»» targetStatus integer true none none
»» langCode string true none none
»» translateRelBool boolean true none none
»» systemType integer true none none
»» categoryIds string true none none
»» categoryIdList string true none none
## QA詳細を検索

GET /sdk/knowledgeItems/{id}

リクエストパラメータ

名称 位置 タイプ 必須 日本語名 説明
id path string はい ナレッジID
Authorization header string いいえ none
Content-Type header string いいえ none
historyId header integer いいえ ナレッジバージョンID, デフォルトは-1（空の場合はデフォルトで-1になります）
knowledgeBaseId header integer いいえ ナレッジスペースID none

例

リクエスト

curl --location 'https://kcs.t1.in.tryudesk.com/api/sdk/knowledgeItems/258013?historyId=-1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDk3MTU4LCJpYXQiOjE3NjI0OTQxNTgsInVzZXJJZCI6Mn0.DYjYfagGxjK8ZHSw7Sq54hbfvCaxIH0nEoDnXmD98LRPJVJe2hOgcDT1HwRCBIB48ktAz8Ycpvcv8xmN0MFbaluWTBJ_SuiXf9GawQZQR0pQbjyq6bE6JSl3JbchgfrkIE1_ZwQ_LiSnuSld3tvgUf2rC4OsikFse0IhLdfIPWw' \
--data ''

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "id": 258013,
    "createUserId": 2,
    "createUserUsername": "Admin123456",
    "createTime": "2025-10-21 16:16:46",
    "updateUserId": 2,
    "updateUserUsername": "Admin123456",
    "updateTime": "2025-11-06 20:34:03",
    "deleteFlag": 0,
    "categoryIdMultiple": [
      11913
    ],
    "knowledgeCreateBool": true,
    "knowledgeManageBool": true,
    "knowledgeBaseId": 281,
    "knowledgeBaseName": "UAgent便捷创建知识空间",
    "categoryIdList": [
      11913
    ],
    "templateId": 0,
    "priority": 0,
    "name": "带富文本内容的QA",
    "regulation": "",
    "status": 1,
    "size": 0,
    "availableTimeType": 0,
    "accessLevel": 0,
    "approveUserId": 2,
    "approveUserUsername": "Admin123456",
    "approveTime": "2025-11-06T20:34:03",
    "content": "1321，引用其他知识点\n\nE300硬盘盒怎么安装\n123\n\n&amp;nbsp;",
    "channelManagements": [],
    "managePermissionDto": {},
    "attachmentDownload": true,
    "canEdit": true,
    "topFlag": 0,
    "topTime": "1970-01-01 01:01:01",
    "entourage": {
      "catalogueList": [],
      "knowledgeAssociation": {
        "qaAssociationList": []
      }
    },
    "favoriteCount": 0,
    "likeCount": 0,
    "disLikeCount": 0,
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "contentId": 16264,
    "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
    "contentAnswerShowFlag": 0,
    "deletePerson": true,
    "langCode": "ZH-CN",
    "valid": true,
    "uagentSyncStatus": 0,
    "historyId": 17190
  }
}

返却結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK none Inline

返却データ構造

ステータスコード 200

名前 タイプ 必須 制約 日本語名 説明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» data object true none none
»» id integer true none ナレッジID none
»» createUserId integer false none 作成ユーザーID none
»» createUserUsername string false none 作成ユーザー名 none
»» createTime string false none 作成時間 none
»» updateUserId integer false none 更新ユーザーID none
»» updateUserUsername string false none 更新ユーザー名 none
»» updateTime string false none 更新時間 none
»» deleteFlag integer false none 削除フラグ none
»» categoryIdMultiple [object] false none カテゴリー none
»» knowledgeCreateBool boolean false none 権限フラグ none
»» knowledgeManageBool boolean false none 権限フラグ none
»» knowledgeBaseId integer false none スペースID none
»» knowledgeBaseName string false none スペース名 none
»» categoryIdList [object] false none カテゴリー none
»» templateId integer false none テンプレートID none
»» priority integer true none トップ表示優先度 none
»» name string true none QA名 none
»» regulation string true none none
»» status integer true none ステータス none
»» size integer true none サイズ none
»» availableTimeType integer true none 有効フラグ none
»» accessLevel integer false none アクセス権限，0：外部公開可，1：内部のみ none
»» approveUserId integer false none 承認者ID none
»» approveUserUsername string false none 承認者 none
»» approveTime string false none 承認時間 none
»» content string true none QA内容 none
» channelManagements [object] true none チャネル none
»» id integer true none チャネルID none
»» relevances [object] true none 関連問題リスト none
»»» relevantItemId integer true none 関連ナレッジID none
»»» relevantItemName string true none 関連ナレッジ名 none
»» managePermissionDto [object] true none 権限リスト none
»» attachmentDownload boolean true none 添付ファイルダウンロード権限 none
»» canEdit boolean true none 編集可能かどうか none
»» topFlag integer true none トップ表示フラグ(0未トップ,1トップ済) none
»» topTime string true none トップ表示時間 none
»» entourage [object] true none 随録データ補足情報 none
»»» catalogueList [object] true none 目録 none
»»» knowledgeAssociation [object] true none ナレッジ関連付け none
»»»» qaAssociationList [object] true none ナレッジ関連付け none
»» favoriteCount integer true none お気に入り数 none
»» likeCount integer true none いいね数 none
»» disLikeCount integer true none 低評価数 none
»» sdkSendFlag string true none SDK送信スイッチ none
»» sdkUseFlag integer true none SDK使用スイッチ none
»» contentId integer true none コンテンツID none
» contentUuid body string はい uuid
» contentAnswerShowFlag body integer はい 固定で0を渡す
»» deletePerson boolean true none true：削除可能，false：削除不可（フィードバックボタンを表示） none
»» langCode body string はい デフォルトZH-CN
»» valid boolean true none 有効かどうか none
»» uagentSyncStatus integer true none uagent同期ステータス(0未同期,1同期済) none
»» historyId integer true none 検索履歴ID none
## システム内に重複するQ&Aが存在するか確認

POST /sdk/knowledgeItems/checkRepeat

Body リクエストパラメータ

{
  "name":"テスト知識2025-11-06 20:13:35更新",
  "knowledgeBaseId": "12246",
  "type":1,
  "editionId":null,
  "id":362625

}

リクエストパラメータ

名称 位置 タイプ 必須 日本語名 説明
id body integer はい 知識ID
editionId body integer いいえ 重複チェック時に無視する知識バージョンID 重複チェック時に無視する知識バージョンID
knowledgeBaseId body integer はい スペースID スペースID
name body string はい 知識名 知識名
type body integer はい テンプレートID 1:デフォルトテンプレート 2:カスタムテンプレート

例

リクエスト

curl --location --request POST 'https://knowledgeservice.s4.udesk.cn/api/sdk/knowledgeItems/checkRepeat' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM0MjE1LCJpYXQiOjE3NjI0MzEyMTUsInVzZXJJZCI6Mn0.qUgSnW8Tca6jbWpdAbqVUe-XhFNPVjDycOlyLyiiuV8KMODMdsD5nHtv5anxqkJElbHaVIi2IP43LVwEuKfo7RDChOSrgdrNa-r0DZG9EwA0zM-avIX17VqssARfOLQ4rHwbCAmMprYrIdC7Jy-uNlmjUnmXX5TiUZgKw4v6YVc' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=ef7f8ed1-83dc-4bdc-9a9f-8b0717587c90' \
--data-raw '{

  "name":"テスト知識2025-11-06 20:13:35更新",
  "knowledgeBaseId": "12246",
"type":1,
"editionId":null,
"id":362625

}'

結果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "id": 362624,
    "deleteFlag": 0,
    "categoryIdMultiple": [],
    "knowledgeBaseId": 12246,
    "categoryIdList": [],
    "templateId": 0,
    "name": "テスト知識2025-11-06 19:17:48更新",
    "attachmentDownload": false,
    "itemType": 1,
    "canEdit": false,
    "topFlag": 0,
    "favoriteCount": 0,
    "likeCount": 0,
    "disLikeCount": 0,
    "deletePerson": false,
    "valid": true,
    "uagentSyncStatus": 0,
    "historyId": 673531
  }
}

レスポンス結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK none Inline

レスポンスデータ構造

ステータスコード 200

名前 タイプ 必須 制約 日本語名 説明
» succeed boolean true none 成功フラグ none
» code integer true none コード none
» bizCode string true none 業務コード none
» message string true none メッセージ none
» visible boolean true none 表示フラグ none
» data [object] true none データ none
»» id integer false none ナレッジID none
»» deleteFlag integer false none 削除フラグ none
»» categoryIdMultiple [object] false none カテゴリ none
»» knowledgeBaseId integer false none スペースID none
»» categoryIdList [object] false none カテゴリリスト none
»» templateId integer false none テンプレートID none
»» name string false none QA名称 none
»» attachmentDownload boolean true none 添付ファイルダウンロード権限 none
»» itemType integer true none ナレッジタイプ none
»» canEdit boolean true none 編集可能フラグ none
»» topFlag integer true none トップ表示フラグ(0:未トップ,1:トップ済み) none
»» favoriteCount integer true none お気に入り数 none
»» likeCount integer true none いいね数 none
»» disLikeCount integer true none 低評価数 none
»» deletePerson boolean true none true：削除可能、false：削除不可（フィードバックボタン表示） none
»» valid boolean true none 有効フラグ none
»» uagentSyncStatus integer true none uagent同期ステータス(0:未同期,1:同期済み) none
»» historyId integer true none 検索履歴ID none