WebAPI レスポンスデータサンプル
WebAPI を利用することで、外部システムから FastAnswer2 に登録されているナレッジ情報を取得することができます。この章では、各 API のレスポンスデータのサンプルを載せます。
- 運用ガイド
- WebAPI の利用手順については、以下を参照してください。
- 「サイト設定 - WebAPIを利用する」
- 各種仕様詳細
- レスポンスデータ内のキーの説明については、以下を参照してください。
- 「入出力機能一覧 - WebAPI レスポンスデータとエラーメッセージ」
API 共通レスポンスデータ
次に、API 共通のレスポンスデータのサンプル (成功時) を載せます。
{
"count": 0,
"data": [
ここに各APIのレスポンスデータが格納される。
],
"limit": -1,
"offset": 0,
"result": "success",
"service": "/knowledgemanage/knowledge.json",
"size": 70
}
- ポイント
-
- 各 API へのレスポンスとして返されるデータは、キーワード data の値として格納されます。これ以降のセクションでは、この data の値として返されるデータのみ紹介します。
ナレッジ一覧取得 API レスポンスデータ
次に、ナレッジ一覧取得 API 実行時に data に格納される値のサンプルを載せます。
"data": [
{
"knowledgeId": 102,
"knowledgeKindId": 1,
"knowledgeKindTypeId": 1,
"siteId": 101,
"subKnowledgeId": null,
"name": "FastAnswerのあまり知られていない機能を、随時ピックアップして更新します。",
"knowledgeStatus": "50",
"knowledgeSource": "0",
"startDate": 1498575600000,
"endDate": 1519829998000,
"importance": "0",
"unreadAlertMode": "0",
"newFlg": "1",
"freqLevel": "1",
"togetherReferFlg": "1",
"importanceFlg": "0",
"dataCollectSettingId": null,
"collectDate": null,
"collectPath": null,
"collectTitle": null,
"collectId": null,
"deleteStatus": "0",
"status": "0",
"regDate": 1498627261089,
"regStaffId": 1,
"updateDate": 1517291261253,
"updateStaffId": 1,
"versionNo": 224,
"searchKeyword": "FastAnswr2",
"impossiblePublishFlg": "0",
"writingErrorFlg": "0",
"createDate": null,
"subEditId": null,
"subRevisionId": null,
"knowledgeSealId": 1,
"score": 0,
"attachFileStatus": null,
"knowledgeStatusName": "公開",
"knowledgeSourceName": "直接入力",
"importanceName": "なし",
"regStaffLname": "村崎",
"regStaffFname": null,
"updateStaffLname": "村崎",
"updateStaffFname": null
},
ナレッジ詳細取得 API レスポンスデータ
次に、ナレッジ詳細取得 API 実行時に data に格納される値のサンプルを載せます。
"data": {
"deleteStatus": "0",
"embedAttachList": [],
"freqLevel": "1",
"importance": "0",
"importanceFlg": "1",
"impossiblePublishFlg": "0",
"knowledgeAttachIdArray": [],
"knowledgeAttachList": [],
"knowledgeCategoryInfoList": [
{
"callCategoryIdAsArray": [
102,
111,
3,
4,
5
],
"category1": 102,
"category2": 111,
"category3": 3,
"category4": 4,
"category5": 5,
"categoryKindId": 1,
"categoryName1": "ハードウェア",
"categoryName2": "ディスプレイ",
"categoryName3": "(未設定)",
"categoryName4": "(未設定)",
"categoryName5": "(未設定)",
"deleteStatus": "0",
"knowledgeId": 105,
"regDate": 1507697245915,
"regStaffId": 101,
"sortNum": 1,
"status": "0",
"updateDate": 1507697245915,
"updateStaffId": 101,
"versionNo": 0
}
],
"knowledgeId": 105,
"knowledgeItemInfoList": [
{
"deleteStatus": "0",
"itemChildId": 1,
"itemChildName": "(未設定)",
"itemId": 1,
"itemName": "(未設定)",
"knowledgeId": 105,
"regDate": 1507697245917,
"regStaffId": 101,
"sortNum": 1,
"status": "0",
"updateDate": 1507697245916,
"updateStaffId": 101,
"versionNo": 0
}
],
"knowledgeKindId": 1,
"knowledgeKindTypeId": 101,
"knowledgeOptionInfoList": [
{
"deleteStatus": "0",
"infoName": "登録方法を教えてください。",
"infoNameTextType": "0",
"knowledgeId": 105,
"knowledgeOptionId": 109,
"knowledgeOptionTypeId": 1,
"regDate": 1507697245909,
"regStaffId": 101,
"status": "0",
"updateDate": 1507697245909,
"updateStaffId": 101,
"versionNo": 0
},
{
"deleteStatus": "0",
"infoName": "運用一覧への登録は登録担当者が登録内容を確認した上で行います。",
"infoNameTextType": "0",
"knowledgeId": 105,
"knowledgeOptionId": 110,
"knowledgeOptionTypeId": 2,
"regDate": 1507697245909,
"regStaffId": 101,
"status": "0",
"updateDate": 1507888043681,
"updateStaffId": 101,
"versionNo": 2
}
],
"knowledgeRecoList": [],
"knowledgeRelUrlList": [],
"knowledgeRelationList": [],
"knowledgeSealId": 101,
"knowledgeSearchTagInfoList": [],
"knowledgeSource": "0",
"knowledgeStatus": "50",
"name": "運用製品一覧への登録",
"newFlg": "1",
"regDate": 1507697245909,
"regStaff": {
"accountPolicyId": 101,
"accountStatus": "0",
"avatarAttachId": 21,
"ctiFlg": "0",
"custRoleId": 1,
"dataSecurityId": 1,
"deleteStatus": "0",
"fname": "博(SV、TEL/Mail)",
"forwardUserFlg": "1",
"initialMainAreaWindow": "DASHBOARD",
"knowledgeUserFlg": "1",
"ldapFlg": "0",
"lname": "村崎",
"loginName": "murasaki",
"mailLicenceFlg": "1",
"nameKana": "",
"popupAlertFlg": "1",
"popupMessagingFlg": "1",
"popupNewsFlg": "1",
"refUserFlg": "0",
"regDate": 1422535578429,
"regStaffId": 10,
"reportUserFlg": "0",
"snsFbUserFlg": "1",
"snsLineUserFlg": "1",
"staffDeptId": 1,
"staffId": 101,
"staffType": "スーパーバイザ",
"status": "0",
"subStaffId": "101",
"systemDataFlg": "0",
"systemRoleId": 1,
"telLicenceFlg": "1",
"updateDate": 1517395830706,
"updateStaffId": 101,
"versionNo": 22
},
"regStaffId": 101,
"searchKeyword": "運用製品一覧 登録",
"siteId": 101,
"siteRoleKnowledgeList": [
{
"deleteStatus": "0",
"knowledgeId": 105,
"regDate": 1507888048271,
"regStaffId": 101,
"siteRoleId": 1,
"status": "0",
"updateDate": 1507888048271,
"updateStaffId": 101,
"versionNo": 0
},
{
"deleteStatus": "0",
"knowledgeId": 105,
"regDate": 1507888048272,
"regStaffId": 101,
"siteRoleId": 2,
"status": "0",
"updateDate": 1507888048271,
"updateStaffId": 101,
"versionNo": 0
}
],
"status": "0",
"togetherReferFlg": "1",
"unreadAlertMode": "0",
"updateDate": 1516942025570,
"updateStaff": {
"accountPolicyId": 101,
"accountStatus": "0",
"avatarAttachId": 21,
"ctiFlg": "0",
"custRoleId": 1,
"dataSecurityId": 1,
"deleteStatus": "0",
"fname": "博(SV、TEL/Mail)",
"forwardUserFlg": "1",
"initialMainAreaWindow": "DASHBOARD",
"knowledgeUserFlg": "1",
"ldapFlg": "0",
"lname": "村崎",
"loginName": "murasaki",
"mailLicenceFlg": "1",
"nameKana": "",
"popupAlertFlg": "1",
"popupMessagingFlg": "1",
"popupNewsFlg": "1",
"refUserFlg": "0",
"regDate": 1422535578429,
"regStaffId": 10,
"reportUserFlg": "0",
"snsFbUserFlg": "1",
"snsLineUserFlg": "1",
"staffDeptId": 1,
"staffId": 101,
"staffType": "スーパーバイザ",
"status": "0",
"subStaffId": "101",
"systemDataFlg": "0",
"systemRoleId": 1,
"telLicenceFlg": "1",
"updateDate": 1517395830706,
"updateStaffId": 101,
"versionNo": 22
},
"updateStaffId": 101,
"versionNo": 7,
"writingErrorFlg": "0"
}
ナレッジ添付ファイル取得 API レスポンスデータ
ナレッジ添付ファイル取得 API 実行時に data に格納される値のサンプルを載せます。
"data": {
"downloadAttachId": 685,
"downloadUrl": "http://sample/downloadAttach/attachment?downloadKey=sample",
"fileName": "sample.jpg",
"fileSize": 98917,
"mimeSubType": "jpeg",
"mimeType": "image",
"regDate": 1517475766329,
"regStaffId": 1,
"sessionId": "937C0611DCB09E15B1A3E4C07F50526D"
}
サジェスト一覧取得 API レスポンスデータ
サジェスト一覧取得 API 実行時に data に格納される値のサンプルを載せます。
"data": [
{
"knowledgeId": "111",
"knowledgeKindId": "4",
"label": "FastAnswer製品サイト"
},
{
"knowledgeId": "115",
"knowledgeKindId": "2",
"label": "FastAnswer2 製品サイトリニューアルについて"
}
]