実行例

 リクエスト

curl 'https://zinrai-pf.jp-east-1.paas.cloud.global.fujitsu.com/F AQSearch/v1/admin/operationlogs/20180620' -H 'X-Access-Token: 000 000000000000000001FJAI000000aaaa1' -H 'X-Service-Code: FJAI000011 -00802'

 レスポンス

{"timestamp": "2018-06-20T13:00:00.000000+00:00", "user_id":

"user", "action": "search", "operation_info": {"search_id":

"1234_20180620130000_1", "query": {"query": {"text": "電源ボタンを押し て も 、 パ ソ コ ン が 起 動 し ま せ ん 。 "}}, "document_ids": ["a1234-5678",

"a2345-6789"]}, "success": true}

{"timestamp": "2018-06-20T13:03:14.000000+00:00", "user_id":

"user", "action": "get_document", "operation_info": {"search_id":

"1234_20180620130000_1", "document_id": "a1234-5678"}, "success":

true}

{"timestamp": "2018-06-20T13:07:39.000000+00:00", "user_id":

"user", "action": "feedback", "operation_info": {"search_id":

"1234_20180620130000_1", "document_id": "a1234-5678", "key":

"good"}, "success": true}

付録A パラメータ仕様

本書では、API 毎にパラメータを以下のように種別分けしています。

種別 説明

path URI の中で、クエリ文字列以外（リソース名など）で指定する。

値のみで、パラメータ名は記述されない。

例：/Sample/v1/samp_file/0001 query URI の中で、クエリ文字列で指定する

例：/Sample/v1/samp_file/0001?param1=AAA

本 API におけるリクエスト／レスポンスボディの形式は、JSON を基本とします。JSON の場合、本書では、

型について、以下のように表記します。

型 説明

string ダブルクォーテーションで括った文字列

number 数値

boolean 真偽値（true と false）

array ※[]表記 配列

object※()内にオブジェクト名表記 オブジェクト（キーと値の組の集まり）

付録B データ仕様

質問データおよび紐づけデータの仕様について説明します。

はじめに、各データの共通事項は以下です。

1) ヘッダが必要です。

ヘッダに使用する各カラムのカラム名は Zinrai 導入支援サービスで決定します。

2) カラムの順番は任意です。

3) 区切り文字は「,」とし、区切り文字の前後にスペースを入れた場合は、値の一部として扱われます。

値に改行や「,」が含まれる場合は「"」で囲んでください。「"」で囲んだ値に「"」を含む場合は「""」に置 き換えてください。

4) 文字コードは UTF-8 とし、改行コードは CRLF、LF、CR のいずれかとします。

質問データのカラムについて

必須 内容 文字種 文字数 備考

○ 質問 ID 「/」以外、かつ先頭は

「_」以外のパーセントエ ンコーディング可能な文 字

100 文字以内 質問を特定するための一意 な ID

○ 質問文 任意 5000 文字以内 質問文(自然文)のテキスト

データ作成日時 YYYY-MM-DDThh:

mm:ss±hh:mm の 形式

― ―

その他の付加情報 任意 各 10000 文字

以内

複数定義することが可能

紐づけデータのカラムについて

必須 内容 文字種 文字数 備考

○ 質問 ID 「/」以外、かつ先頭は

「_」以外のパーセントエ ンコーディング可能な文 字

100 文字以内 質問を特定するための一意 な ID

○ FAQ ID ID：「/」以外、かつ先 頭は「_」以外のパーセン トエンコーディング可能な 文字

ID：100 文字 以内

区切り文字：1 文字

FAQ を特定するための一意 な ID

一つの質問に対して複数の FAQ が紐づく場合、FAQ