WebAPI レスポンスデータとエラーメッセージ
WebAPI を利用することで、外部システムから FastAnswer2 に登録されているナレッジ情報を取得することができます。この章では、FastAnswer2 が返すデータ (レスポンスデータ)、エラーメッセージについて説明します。
WebAPI レスポンスデータ仕様
WebAPI のレスポンスデータは、json 形式です。レスポンスデータの仕様を次にまとめます。
- 運用ガイド
- WebAPI の利用手順については、以下を参照してください。
- 「サイト設定 - WebAPIを利用する」
- 各種仕様詳細
- レスポンスデータのサンプルについては、以下を参照してください。
- 「入出力機能一覧 - WebAPI レスポンスデータサンプル」
API 共通レスポンスデータ
どの API を使用する場合も共通で返されるデータを次にまとめます。
| キー | 型 | 説明 |
|---|---|---|
| count | 数字 | 一覧で情報を取得する場合、条件に合致した件数を表示する。詳細を取得した場合は常に-1が表示される。 |
| data | オブジェクト/配列 | APIで取得されたデータを表示する。 |
| limit | 数字 | 一覧で情報を取得する場合、取得するデータ件数を表示する。詳細を取得した場合は常に-1が表示される。 |
| offset | 数字 | 一覧で情報を取得する場合、取得を開始する位置を表示する。詳細を取得した場合は常に-1が表示される。 |
| result | 文字列 | 処理結果を表示する (success:成功、fail:失敗)。 |
| service | 文字列 | 呼び出したAPIを表示する。 |
| size | 数字 | レスポンスとして返したデータのサイズを表示する。 |
| message | 文字列 | エラー時のメッセージ。 |
| messageCode | 文字列 | エラー時のメッセージコード。 |
| subMessage | 文字列 | エラー時のサブメッセージ。 |
| subMessageCode | 文字列 | エラー時のサブメッセージコード。 |
- ポイント
-
- 各 API へのレスポンスとして返されるデータは、キーワード data の値として格納されます。これ以降のセクションでは、この data の値として返されるデータについて説明します。
ナレッジ一覧取得 API レスポンスデータ
ナレッジ一覧取得 API 実行時に data に格納される値を次にまとめます。
| キー | 型 | 説明 | 値の意味 |
|---|---|---|---|
| knowledgeId | 数字 | ナレッジ番号 | |
| knowledgeKindId | 数字 | ナレッジ分類番号 | |
| knowledgeKindTypeId | 数字 | ナレッジ分類種別番号 | |
| siteId | 数字 | サイト番号 | |
| subKnowledgeId | 文字列 | サブナレッジ番号 | |
| name | 文字列 | ナレッジ名 | |
| knowledgeStatus | 文字列 | 公開状態 | (0:未公開、1:プライベート、50:公開) |
| knowledgeSource | 文字列 | 登録経路 | (0:直接入力, 1:CSV, 2:プライベート入力, 3:データ収集) |
| startDate | 日付形式 | 有効期限開始日 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| endDate | 日付形式 | 有効期限終了日 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| importance | 文字列 | 重要度 | |
| unreadAlertMode | 文字 | 未読ナレッジ警告モード | (0:警告しない、1:ログイン時に警告) |
| newFlg | 文字 | 新着フラグ | (0:OFF、1:ON) |
| freqLevel | 文字 | よく利用されているフラグ | (0:OFF、1:ON) |
| togetherReferFlg | 文字 | 一緒に参照されるフラグ | (0:OFF、1:ON) |
| importanceFlg | 文字 | 重要フラグ | (0:OFF、1:ON) |
| dataCollectSettingId | 数字 | データ収集設定番号 | |
| collectDate | 日付形式 | データ収集日 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| collectPath | 文字列 | データ収集時のパス | |
| collectTitle | 文字列 | データ収集時のタイトル | |
| collectId | 文字列 | データ収集時のID | |
| deleteStatus | 文字 | 削除状態 | (0:OFF、1:ON) |
| status | 文字 | 行ステータス | (0:制限なし、1:削除不可、2:変更不可) |
| regDate | 日付形式 | 登録日時 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| regStaffId | 数字 | 登録担当者番号 | |
| updateDate | 日付形式 | 更新日時 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| updateStaffId | 数字 | 更新担当者番号 | |
| versionNo | 数字 | バージョン番号 | |
| searchKeyword | 文字列 | 検索キーワード | |
| impossiblePublishFlg | 文字列 | 社外提示不可 | |
| writingErrorFlg | 文字 | 誤記指摘 | (0:OFF、1:ON) |
| createDate | 日付形式 | 作成年月 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| subEditId | 数字 | 版番号 | |
| subRevisionId | 数字 | 改訂版番号 | |
| score | 文字列 | 評価 | |
| attachFileStatus | 文字 | 添付ファイル有無 | (0:なし、1:あり) |
| knowledgeStatusName | 文字列 | 公開状態(文字列) | 未公開/プライベート/公開 |
| knowledgeSourceName | 文字列 | 登録経路(文字列) | 直接入力/CSV/プライベート入力/データ収集 |
| importanceName | 文字列 | 重要度(文字列) | |
| regStaffLname | 文字列 | 登録担当者姓 | |
| regStaffFname | 文字列 | 登録担当者名 | |
| updateStaffLname | 文字列 | 更新担当者姓 | |
| updateStaffLname | 文字列 | 更新担当者名 |
ナレッジ詳細取得 API レスポンスデータ
ナレッジ詳細取得 API 実行時に data に格納される値を次にまとめます。
| キー | 型 | 説明 | 値の意味 |
|---|---|---|---|
| deleteStatus | 文字 | 削除状態 | |
| freqLevel | 文字 | よく利用されているフラグ | (0:OFF、1:ON) |
| importance | 文字列 | 重要度 | |
| importanceFlg | 文字 | 重要フラグ | (0:OFF、1:ON) |
| impossiblePublishFlg | 文字 | 社外提示不可フラグ | (0:OFF、1:ON) |
| knowledgeId | 数字 | ナレッジ番号 | |
| knowledgeKindId | 数字 | ナレッジ分類番号 | |
| knowledgeKindTypeId | 数字 | ナレッジ分類種別番号 | |
| knowledgeStatus | 文字列 | 公開状態 | (0:未公開、1:プライベート、50:公開) |
| knowledgeStatus | 文字列 | 公開状態 | (0:未公開、1:プライベート、50:公開) |
| name | 文字列 | ナレッジ名 | |
| newFlg | 文字 | 新着フラグ | (0:OFF、1:ON) |
| regDate | 日付形式 | 登録日時 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| regStaffId | 数字 | 登録担当者番号 | |
| searchKeyword | 文字列 | 検索キーワード | |
| siteId | 数字 | サイト番号 | |
| status | 文字 | 行ステータス | (0:制限なし、1:削除不可、2:変更不可) |
| togetherReferFlg | 文字 | 一緒に参照されるフラグ | |
| unreadAlertMode | 文字 | 未読ナレッジ警告モード | (0:警告しない、1:ログイン時に警告) |
| updateDate | 日付形式 | 更新日時 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| updateStaffId | 数字 | 更新担当者番号 | |
| versionNo | 数字 | バージョン番号 | |
| writingErrorFlg | 文字 | 誤記指摘フラグ | (0:OFF、1:ON) |
| knowledgeAttachIdArray | 数字 (配列) | ナレッジに紐づく添付ファイルの一覧 | |
| regStaff | json | 登録担当者情報 | |
| updateStaff | json | 更新担当者情報 | |
| siteRoleKnowledgeList | 配列 | サイト権限リスト | |
| knowledgeOptionInfoList | 配列 | ナレッジオプションリスト | |
| embedAttachList | 配列 | 埋め込み添付ファイルリスト | |
| KnowledgeCategoryInfoList | 配列 | ナレッジカテゴリリスト | |
| KnowledgeSearchTagInfoList | 配列 | 製品情報リスト | |
| KnowledgeRelUrlList | 配列 | 外部URLリスト | |
| knowledgeRecoList | 配列 | よく一緒に参照されるナレッジリスト |
ナレッジ添付ファイル取得 API レスポンスデータ
ナレッジ添付ファイル取得 API 実行時に data に格納される値を次にまとめます。
| キー | 型 | 説明 | 値の意味 |
|---|---|---|---|
| downloadAttachId | 数字 | ダウンロードファイル番号 | |
| fileName | 文字列 | ファイル名 | |
| fileSize | 数字 | MIMEタイプ | |
| mimeSubType | 文字列 | MIMEサブタイプ | |
| regDate | 日付形式 | 登録日時 | 1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数を返す。 |
| regStaffId | 数字 | 登録担当者番号 | |
| downloadUrl | 文字列 | 添付ファイルダウンロードURL |
サジェスト一覧取得 API レスポンスデータ
サジェスト一覧取得 API 実行時に data に格納される値を次にまとめます。
| キー | 型 | 説明 | 値の意味 |
|---|---|---|---|
| knowledgeId | 数字 | ナレッジ番号 | |
| knowledgeKindId | 数字 | ナレッジ分類番号 | |
| label | 文字列 | ナレッジ名 |
WebAPI エラーメッセージ
エラーが発生した時には、エラーメッセージが返されます。エラーメッセージを次にまとめます。
| エラーコード | エラーメッセージ |
|---|---|
| WTYP0010 | 論理エラー |
| WTYP0020 | ライセンスエラー |
| WTYP0030 | 認証エラー |
| ETYP0040 | アプリケーションエラー |