{
"swagger": "2.0",
"info": {
"version": "1.3.0-13190",
"title": "Digital Paper Control Interface",
"description": "Released on January 19th, 2018.
\n[Instruction](http://kiwi.dps.sony.co.jp/drbd/polaris/trac/wiki/Team/Server/DpcifInstruction)
\n[Change log](http://kiwi.dps.sony.co.jp/drbd/polaris/trac/browser/Teams/Dpcif/_Polaris40/Swagger_Deneb/change_log.txt)
"
},
"paths": {
"/documents": {
"get": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**ドキュメント一覧の取得** \n * entry_type 項目の種別によるフィルタ\n * すべて(フォルダー＋ドキュメント) : 'all'\n * ドキュメント : 'documents'\n * ドキュメントのうち、ノートのみ : 'notes'\n * search_target キーワード検索 もしくは 識別子指定の対象\n * ドキュメントメタ情報(名前、タイトル、著者) : 'document_meta'\n * ドキュメント本文 : 'document_body'\n * アノテーションのプリセットのパターン文字列（★、*） : 'annotation_pattern'\n * annotation_type アノテーション種別によるフィルタ
\n ※search\\_target に 'annotation\\_pattern' を指定した場合に結果に影響\n * すべて(ハイライト＋手書き) : 'all'\n * ハイライト : 'highlights'\n * 手書き : 'handwritings'\n * order_type 一覧のソート順指定
\n ※フォルダーとドキュメントはグルーピングされ、昇順の場合はフォルダーがまとめて先に、降順の場合はドキュメントがまとめて先に列挙される\n * 名前-昇順 : 'entry_name_asc'\n * 名前-降順 : 'entry_name_desc'\n * 作成日時-昇順 : 'created_date_asc'\n * 作成日時-降順 : 'created_date_desc'\n * 編集日時-昇順 : 'modified_date_asc'\n * 編集日時-降順 : 'modified_date_desc'\n * 最終閲覧日時-昇順 : 'reading_date_asc'\n * 最終閲覧日時-降順 : 'reading_date_desc'\n * タイトル-昇順 : 'title_asc'\n * タイトル-降順 : 'title_desc'\n * 著者-昇順 : 'author_asc'\n * 著者-降順 : 'author_desc'\n * ファイルサイズ-昇順 : 'file_size_asc'\n * ファイルサイズ-降順 : 'file_size_desc'\n",
"parameters": [
{
"name": "entry_type",
"in": "query",
"description": "取得する一覧の項目の種別 ※指定が無い場合は 'documents'",
"type": "string"
},
{
"name": "search_target",
"in": "query",
"description": "キーワード検索 もしくは 識別子指定の対象 ※指定が無い場合は検索を行わず、全件取得",
"type": "string"
},
{
"name": "annotation_type",
"in": "query",
"description": "アノテーション種別 ※指定が無い場合は 'all'",
"type": "string"
},
{
"name": "search_keyword",
"in": "query",
"description": "キーワード もしくは 識別子 ※search_target が指定されている場合は必須、されていない場合は無視",
"type": "string"
},
{
"name": "origin_folder_id",
"in": "query",
"description": "任意のフォルダー以下の項目のみに絞る場合のフォルダーID ※指定が無い場合は 'root'",
"type": "string"
},
{
"name": "order_type",
"in": "query",
"description": "取得する一覧のソート順 ※指定が無い場合は 'reading_date_desc'",
"type": "string"
},
{
"name": "offset",
"in": "query",
"description": "取得開始位置 ※指定が無い場合は先頭から",
"type": "string"
},
{
"name": "limit",
"in": "query",
"description": "1回のAPIコールで取得する一覧の最大取得件数。\n指定が無い場合はデフォルト件数(1300件)までを取得。\nただし、条件に合致するデータサイズが大きすぎる場合には応答が無くなることがあるため、\n基本的にlimitの指定を行うこと。 \n※limit指定参考値・・・推奨:100件、上限:1000件\n",
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "取得したい'commonEntryObjectResult'内の項目をカンマ区切りで指定 ※指定が無い場合は全項目を返却",
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonEntryListObjectResult"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40005] 規定された選択肢以外の文字列が指定された\n* [40006] 不正なパラメータ値が指定された\n* [40012] origin_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"post": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**ドキュメントの新規登録**\n * この後、生成されたドキュメントIDに対してファイルのアップロードが必要\n",
"parameters": [
{
"name": "doc_info",
"in": "body",
"description": "登録するドキュメントの情報",
"required": true,
"schema": {
"$ref": "#/definitions/documentsPostRequest"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonDocumentIdObject"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないファイル名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/documents2": {
"get": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**ドキュメント一覧の取得** \n * entry_type 項目の種別によるフィルタ\n * すべて(フォルダー＋ドキュメント) : 'all'\n * ドキュメント : 'documents'\n * ドキュメントのうち、ノートのみ : 'notes'\n * search_target キーワード検索 もしくは 識別子指定の対象\n * ドキュメントメタ情報(名前、タイトル、著者) : 'document_meta'\n * ドキュメント本文 : 'document_body'\n * アノテーションのプリセットのパターン文字列（★、*） : 'annotation_pattern'\n * annotation_type アノテーション種別によるフィルタ
\n ※search\\_target に 'annotation\\_pattern' を指定した場合に結果に影響\n * すべて(ハイライト＋手書き) : 'all'\n * ハイライト : 'highlights'\n * 手書き : 'handwritings'\n * order_type 一覧のソート順指定
\n ※フォルダーとドキュメントはグルーピングされ、昇順の場合はフォルダーがまとめて先に、降順の場合はドキュメントがまとめて先に列挙される\n * 名前-昇順 : 'entry_name_asc'\n * 名前-降順 : 'entry_name_desc'\n * 作成日時-昇順 : 'created_date_asc'\n * 作成日時-降順 : 'created_date_desc'\n * 編集日時-昇順 : 'modified_date_asc'\n * 編集日時-降順 : 'modified_date_desc'\n * 最終閲覧日時-昇順 : 'reading_date_asc'\n * 最終閲覧日時-降順 : 'reading_date_desc'\n * タイトル-昇順 : 'title_asc'\n * タイトル-降順 : 'title_desc'\n * 著者-昇順 : 'author_asc'\n * 著者-降順 : 'author_desc'\n * ファイルサイズ-昇順 : 'file_size_asc'\n * ファイルサイズ-降順 : 'file_size_desc'\n",
"parameters": [
{
"name": "entry_type",
"in": "query",
"description": "取得する一覧の項目の種別 ※指定が無い場合は 'documents'",
"type": "string"
},
{
"name": "search_target",
"in": "query",
"description": "キーワード検索 もしくは 識別子指定の対象 ※指定が無い場合は検索を行わず、全件取得",
"type": "string"
},
{
"name": "annotation_type",
"in": "query",
"description": "アノテーション種別 ※指定が無い場合は 'all'",
"type": "string"
},
{
"name": "search_keyword",
"in": "query",
"description": "キーワード もしくは 識別子 ※search_target が指定されている場合は必須、されていない場合は無視",
"type": "string"
},
{
"name": "origin_folder_id",
"in": "query",
"description": "任意のフォルダー以下の項目のみに絞る場合のフォルダーID ※指定が無い場合は 'root'",
"type": "string"
},
{
"name": "order_type",
"in": "query",
"description": "取得する一覧のソート順 ※指定が無い場合は 'reading_date_desc'",
"type": "string"
},
{
"name": "offset",
"in": "query",
"description": "取得開始位置 ※指定が無い場合は先頭から",
"type": "string"
},
{
"name": "limit",
"in": "query",
"description": "1回のAPIコールで取得する一覧の最大取得件数。\n指定が無い場合はデフォルト件数(1300件)までを取得。\nただし、条件に合致するデータサイズが大きすぎる場合には応答が無くなることがあるため、\n基本的にlimitの指定を行うこと。 \n※limit指定参考値・・・推奨:100件、上限:1000件",
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "取得したい'commonEntryObjectResult2'内の項目をカンマ区切りで指定 ※指定が無い場合は全項目を返却",
"type": "string"
}
],
"responses": {
"200": {
"description": "成功",
"schema": {
"$ref": "#/definitions/commonEntryListObjectResult2"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40005] 規定された選択肢以外の文字列が指定された\n* [40006] 不正なパラメータ値が指定された\n* [40012] origin_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] origin_folder_id で指定されたIDのフォルダーの読み込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"post": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**ドキュメントの新規登録**\n * この後、生成されたドキュメントIDに対してファイルのアップロードが必要\n",
"parameters": [
{
"name": "doc_info",
"in": "body",
"description": "登録するドキュメントの情報",
"required": true,
"schema": {
"$ref": "#/definitions/documentsPostRequest2"
}
}
],
"responses": {
"200": {
"description": "成功",
"schema": {
"$ref": "#/definitions/commonDocumentIdObject2"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないファイル名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] parent_folder_id で指定されたIDのフォルダーの書き込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/documents/{document_id}": {
"get": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**指定ドキュメントIDに該当するドキュメントの情報を取得**\n",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "ドキュメントID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonEntryObjectResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**ドキュメントの名称変更・移動 （ドキュメントの情報更新）**\n",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "更新するドキュメントID",
"required": true,
"type": "string"
},
{
"name": "doc_update_info",
"in": "body",
"description": "更新するドキュメントの情報",
"required": true,
"schema": {
"$ref": "#/definitions/documentsDocumentIdPutRequest"
}
}
],
"responses": {
"204": {
"description": "Successful response"
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないファイル名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"delete": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**ドキュメントの削除**\n",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "削除するドキュメントのID",
"required": true,
"type": "string"
},
{
"name": "del_target_doc_info",
"in": "body",
"description": "削除する対象ドキュメントの情報",
"schema": {
"$ref": "#/definitions/documentsDocumentIdDeleteRequest"
}
}
],
"responses": {
"204": {
"description": "Successful response"
},
"400": {
"description": "* [40017] ドキュメントのリビジョンが更新されているため操作できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/documents2/{document_id}": {
"get": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**指定ドキュメントIDに該当するドキュメントの情報を取得**\n",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "ドキュメントID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "成功",
"schema": {
"$ref": "#/definitions/commonEntryObjectResult2"
}
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの読み込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**ドキュメントの名称変更・移動 （ドキュメントの情報更新）**\n",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "更新するドキュメントID",
"required": true,
"type": "string"
},
{
"name": "doc_update_info",
"in": "body",
"description": "更新するドキュメントの情報",
"required": true,
"schema": {
"$ref": "#/definitions/documentsDocumentIdPutRequest2"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないファイル名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの操作権限がない、もしくは parent_folder_id で指定されたIDのフォルダーの書き込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/documents/{document_id}/file": {
"get": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/pdf"
],
"description": "**指定IDに該当するドキュメントのファイル実体を取得**\n * 応答のヘッダに ETag が設定され、それを利用した分割ダウンロードが可能。ETagには、ダウンロードドキュメントのリビジョン（本体側で計算したもの）、ダウンロードファイルのハッシュ値、ドキュメントのファイルハッシュ（クライアント側で計算されたもの）の3つの要素が設定される。",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "ドキュメントのID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"type": "file"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"description": "**ドキュメントのファイル実体のアップロード**\n * 特定のドキュメントに対してファイル実体を紐づける。\n * 既にdocument_idに紐づくドキュメントが存在した場合は上書きする。\n * 分割アップロードが可能。\n",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "アップロードして紐づけるドキュメントのID ※先にドキュメント登録を行い、IDを取得",
"required": true,
"type": "string"
},
{
"name": "file",
"in": "formData",
"description": "ファイル実体",
"required": true,
"type": "file"
},
{
"name": "offset_bytes",
"in": "query",
"description": "分割アップロードの際に指定 ※詳細はInstructionを参照の事",
"type": "string"
},
{
"name": "total_bytes",
"in": "query",
"description": "分割アップロードの際に指定 ※詳細はInstructionを参照の事",
"type": "string"
},
{
"name": "target_revision",
"in": "query",
"description": "ファイル実体をアップロードする対象のリビジョン。クライアント側で把握した最新のリビジョンを指定する。クライアント側で把握した以降に本体内でドキュメントが更新され、管理するリビジョンの値が指定されたtarget_revisionと異なる状態になっている場合にはエラーを返却する。target_revisionの指定が無い場合は、当該リビジョンチェックを行わない。新規アップロード時にはtarget_revisionを指定しない。",
"type": "string"
},
{
"name": "file_hash",
"in": "query",
"description": "クライアント側で計算されたファイル実体のハッシュ値。",
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonFileUploadResult"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40010] ファイルが指定されていない\n* [40011] 分割アップロードで不整合\n* [40017] ドキュメントのリビジョンが更新されているため操作できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"500": {
"description": "* [50095] 通信関連のエラーが発生し処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/documents/{document_id}/copy": {
"post": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**ドキュメントの複製**\n",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "複製元のドキュメントのID",
"required": true,
"type": "string"
},
{
"name": "doc_copy_info",
"in": "body",
"description": "複製先の情報",
"required": true,
"schema": {
"$ref": "#/definitions/documentsDocumentIdCopyPostRequest"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonDocumentIdObject"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないファイル名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/documents/{document_id}/attribute": {
"get": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**ドキュメントの属性情報の取得**",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "属性を取得するドキュメントのID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "ドキュメントの属性情報",
"schema": {
"$ref": "#/definitions/documentAttributeObject2"
}
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの読み込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**ドキュメントの属性情報を設定する**\n * 一つの 'action_performer' には、'result', 'request', 'indicate' のどれか一つが設定されなければならない\n * 他の設定変更用APIとは異なり、省略やNULL指定で「以前の設定値を維持」とはならない事に注意",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "属性を取得するドキュメントのID",
"required": true,
"type": "string"
},
{
"name": "attribute_info",
"in": "body",
"description": "設定する属性情報",
"required": true,
"schema": {
"$ref": "#/definitions/documentAttributeObject2"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値を期待しているパラメータについて、数値として認識できなかった\n* [40004] 指定パラメータが ISO8601 フォーマットでない\n* [40005] 仕様で定めた選択肢以外のもの指定した\n* [40006] 不正なパラメータ値が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの操作権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"delete": {
"tags": [
"ドキュメント"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**ドキュメントの属性情報をクリアする**",
"parameters": [
{
"name": "document_id",
"in": "path",
"description": "属性をクリアするドキュメントのID",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "成功"
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの操作権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/folders": {
"post": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**フォルダーの新規作成**\n",
"parameters": [
{
"name": "folder_info",
"in": "body",
"description": "作成するフォルダーの情報",
"required": true,
"schema": {
"$ref": "#/definitions/foldersPostRequest"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonFolderIdObject"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないフォルダー名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/folders2": {
"post": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**フォルダーの新規作成**\n",
"parameters": [
{
"name": "folder_info",
"in": "body",
"description": "作成するフォルダーの情報",
"required": true,
"schema": {
"$ref": "#/definitions/foldersPostRequest2"
}
}
],
"responses": {
"200": {
"description": "成功",
"schema": {
"$ref": "#/definitions/commonFolderIdObject2"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないフォルダー名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] parent_folder_id で指定されたIDのフォルダーの書き込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/folders/{folder_id}": {
"get": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**指定IDに該当するフォルダーの情報を取得**\n",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "フォルダーのID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonEntryObjectResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのフォルダーが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**フォルダーの名称変更・移動 （フォルダーの情報更新）**\n",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "更新するフォルダーのID",
"required": true,
"type": "string"
},
{
"name": "folder_update_info",
"in": "body",
"description": "更新するフォルダーの情報",
"required": true,
"schema": {
"$ref": "#/definitions/foldersFolderIdPutRequest"
}
}
],
"responses": {
"204": {
"description": "Successful response"
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないフォルダー名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのフォルダーが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"delete": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**フォルダーの削除**\n",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "削除するフォルダーのID",
"required": true,
"type": "string"
},
{
"name": "del_target_folder_info",
"in": "body",
"description": "削除する対象フォルダーの情報",
"schema": {
"$ref": "#/definitions/foldersFolderIdDeleteRequest"
}
}
],
"responses": {
"204": {
"description": "Successful response"
},
"400": {
"description": "* [40018] 指定されたIDのフォルダー配下にエントリーが存在するため削除は未実行",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのフォルダーが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/folders2/{folder_id}": {
"get": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**指定IDに該当するフォルダーの情報を取得**\n",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "フォルダーのID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "成功",
"schema": {
"$ref": "#/definitions/commonEntryObjectResult2"
}
},
"403": {
"description": "* [40310] 指定されたIDのフォルダーの読み込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのフォルダーが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**フォルダーの名称変更・移動 （フォルダーの情報更新）**\n",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "更新するフォルダーのID",
"required": true,
"type": "string"
},
{
"name": "folder_update_info",
"in": "body",
"description": "更新するフォルダーの情報",
"required": true,
"schema": {
"$ref": "#/definitions/foldersFolderIdPutRequest2"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないフォルダー名が指定された\n* [40007] 名前重複により処理ができない\n* [40012] parent_folder_id に存在しないフォルダーIDが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] 指定されたIDのフォルダーの操作権限がない、もしくは parent_folder_id で指定されたIDのフォルダーの書き込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのフォルダーが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/folders/{folder_id}/entries": {
"get": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**フォルダー内のエントリー一覧を取得** \n * order_type 一覧のソート順指定
\n ※フォルダーとドキュメントはグルーピングされ、昇順の場合はフォルダーがまとめて先に、降順の場合はドキュメントがまとめて先に列挙される\n * 名前-昇順 : 'entry_name_asc'\n * 名前-降順 : 'entry_name_desc'\n * 作成日時-昇順 : 'created_date_asc'\n * 作成日時-降順 : 'created_date_desc'\n * 編集日時-昇順 : 'modified_date_asc'\n * 編集日時-降順 : 'modified_date_desc'\n * 最終閲覧日時-昇順 : 'reading_date_asc'\n * 最終閲覧日時-降順 : 'reading_date_desc'\n * タイトル-昇順 : 'title_asc'\n * タイトル-降順 : 'title_desc'\n * 著者-昇順 : 'author_asc'\n * 著者-降順 : 'author_desc'\n * ファイルサイズ-昇順 : 'file_size_asc'\n * ファイルサイズ-降順 : 'file_size_desc'\n",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "エントリー一覧を取得するフォルダーのID",
"required": true,
"type": "string"
},
{
"name": "order_type",
"in": "query",
"description": "取得する一覧のソート順 ※指定が無い場合は 'entry_name_asc'",
"type": "string"
},
{
"name": "offset",
"in": "query",
"description": "取得開始位置 ※指定が無い場合は先頭から",
"type": "string"
},
{
"name": "limit",
"in": "query",
"description": "1回のAPIコールで取得する一覧の最大取得件数。\n指定が無い場合はデフォルト件数(1300件)までを取得。\nただし、条件に合致するデータサイズが大きすぎる場合には応答が無くなることがあるため、\n基本的にlimitの指定を行うこと。 \n※limit指定参考値・・・推奨:100件、上限:1000件\n",
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "取得したい'commonEntryObjectResult'内の項目をカンマ区切りで指定 ※指定が無い場合は全項目を返却",
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonEntryListObjectResult"
}
},
"400": {
"description": "* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのフォルダーが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/folders/{folder_id}/entries2": {
"get": {
"tags": [
"フォルダー"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**フォルダー内のエントリー一覧を取得** \n * order_type 一覧のソート順指定
\n ※フォルダーとドキュメントはグルーピングされ、昇順の場合はフォルダーがまとめて先に、降順の場合はドキュメントがまとめて先に列挙される\n * 名前-昇順 : 'entry_name_asc'\n * 名前-降順 : 'entry_name_desc'\n * 作成日時-昇順 : 'created_date_asc'\n * 作成日時-降順 : 'created_date_desc'\n * 編集日時-昇順 : 'modified_date_asc'\n * 編集日時-降順 : 'modified_date_desc'\n * 最終閲覧日時-昇順 : 'reading_date_asc'\n * 最終閲覧日時-降順 : 'reading_date_desc'\n * タイトル-昇順 : 'title_asc'\n * タイトル-降順 : 'title_desc'\n * 著者-昇順 : 'author_asc'\n * 著者-降順 : 'author_desc'\n * ファイルサイズ-昇順 : 'file_size_asc'\n * ファイルサイズ-降順 : 'file_size_desc'\n",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "エントリー一覧を取得するフォルダーのID",
"required": true,
"type": "string"
},
{
"name": "order_type",
"in": "query",
"description": "取得する一覧のソート順 ※指定が無い場合は 'entry_name_asc'",
"type": "string"
},
{
"name": "offset",
"in": "query",
"description": "取得開始位置 ※指定が無い場合は先頭から",
"type": "string"
},
{
"name": "limit",
"in": "query",
"description": "1回のAPIコールで取得する一覧の最大取得件数。\n指定が無い場合はデフォルト件数(1300件)までを取得。\nただし、条件に合致するデータサイズが大きすぎる場合には応答が無くなることがあるため、\n基本的にlimitの指定を行うこと。 \n※limit指定参考値・・・推奨:100件、上限:1000件",
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "取得したい'commonEntryObjectResult2'内の項目をカンマ区切りで指定 ※指定が無い場合は全項目を返却",
"type": "string"
}
],
"responses": {
"200": {
"description": "成功",
"schema": {
"$ref": "#/definitions/commonEntryListObjectResult2"
}
},
"400": {
"description": "* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] 指定されたIDのフォルダーの読み込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのフォルダーが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/configs/note_templates": {
"get": {
"tags": [
"ノートテンプレート"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**ノートテンプレートの一覧**\n",
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/viewerConfigsNoteTemplateGetResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"post": {
"tags": [
"ノートテンプレート"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**ノートテンプレート情報の作成**\n * ここではノートテンプレート情報の作成のみ行う。\n * 本APIでノートテンプレート情報を作成後、それに対してノートテンプレートファイル実体を「/viewer/configs/note_templates/{note_template_id}/file」にて紐付ける必要がある。\n",
"parameters": [
{
"name": "note_template_info",
"in": "body",
"description": "作成するノートテンプレートの情報",
"required": true,
"schema": {
"$ref": "#/definitions/viewerConfigsNoteTemplatePostRequest"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/viewerConfigsNoteTemplatePostResult"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないファイル名が指定された\n* [40007] 名前重複により処理ができない\n* [40008] 登録可能なノートテンプレート数の上限に達している",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/configs/note_templates/{note_template_id}": {
"get": {
"tags": [
"ノートテンプレート"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "note_template_id",
"in": "path",
"description": "取得するノートテンプレートのID",
"required": true,
"type": "string"
}
],
"description": "**ノートテンプレートの情報取得**\n",
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonTemplateObjectResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのノートテンプレートが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"ノートテンプレート"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**ノートテンプレートの情報を更新**\n",
"parameters": [
{
"name": "note_template_id",
"in": "path",
"description": "更新するノートテンプレートのID",
"required": true,
"type": "string"
},
{
"name": "note_template_update_info",
"in": "body",
"description": "更新するノートテンプレートの情報",
"required": true,
"schema": {
"$ref": "#/definitions/viewerConfigsNoteTemplateTemplateIdPutRequest"
}
}
],
"responses": {
"204": {
"description": "Successful response"
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40006] サポートされていないファイル名が指定された\n* [40007] 名前重複により処理ができない\n* [40009] 更新不可であるデフォルトノートテンプレートが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのノートテンプレートが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"delete": {
"tags": [
"ノートテンプレート"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**ノートテンプレートの削除**\n",
"parameters": [
{
"name": "note_template_id",
"in": "path",
"description": "削除するノートテンプレートのID",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Successful response"
},
"400": {
"description": "* [40009] 削除不可であるデフォルトノートテンプレートが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのノートテンプレートが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/configs/note_templates/{note_template_id}/file": {
"put": {
"tags": [
"ノートテンプレート"
],
"schemes": [
"https"
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"description": "**ノートテンプレート実体のアップロード**\n * 特定のノートテンプレートに対してファイル実体を紐づける。\n * 既にnote_template_idに紐づくファイルが存在した場合は上書きする。\n * 分割アップロードが可能\n",
"parameters": [
{
"name": "note_template_id",
"in": "path",
"description": "アップロードして紐づけるノートテンプレートのID ※先にノートテンプレート登録を行い、IDを取得",
"required": true,
"type": "string"
},
{
"name": "file",
"in": "formData",
"description": "ファイル実体",
"required": true,
"type": "file"
},
{
"name": "offset_bytes",
"in": "query",
"description": "分割アップロードの際に指定 ※詳細はInstructionを参照の事",
"type": "string"
},
{
"name": "total_bytes",
"in": "query",
"description": "分割アップロードの際に指定 ※詳細はInstructionを参照の事",
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/commonFileUploadResult"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40009] 更新不可であるデフォルトノートテンプレートが指定された\n* [40010] ファイルが指定されていない\n* [40011] 分割アップロードで不整合\n* [40013] このファイル形式はサポートしない\n* [40014] このファイルは開く事ができない\n* [40015] このファイルは編集する事できない\n* [40016] このファイルはサイズの規格を満たしていない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのノートテンプレートが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"500": {
"description": "* [50095] 通信関連のエラーが発生し処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"507": {
"description": "* [50701] 本体のストレージ容量が不足が原因で処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/status/preset_marks": {
"get": {
"tags": [
"ビューワー操作"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**ハンドライティングのプリセットパターン一覧取得** \n",
"responses": {
"200": {
"description": "Successful response (パターンリスト)",
"schema": {
"$ref": "#/definitions/viewerStatusPresetMarksGetResult"
}
}
}
}
},
"/viewer/controls/open": {
"put": {
"tags": [
"ビューワー操作"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n**指定ドキュメントを開く**\n",
"parameters": [
{
"name": "target_doc_info",
"in": "body",
"description": "開く対象のドキュメントの情報",
"required": true,
"schema": {
"$ref": "#/definitions/viewerControlsOpenPutRequest"
}
}
],
"responses": {
"204": {
"description": "Successful response"
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/controls/open2": {
"put": {
"tags": [
"ビューワー操作"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**指定ドキュメントを開く**\n * ページ番号は省略可能。その場合、開かれるページは本体側にオマカセ。\n * ページ番号が 0 もしくは負の値を指定した場合はエラー。\n * ページ番号がそのドキュメントの総ページ数より大きい値の場合は、最終ページが開く。",
"parameters": [
{
"name": "target_doc_info",
"in": "body",
"description": "開く対象のドキュメントの情報",
"required": true,
"schema": {
"$ref": "#/definitions/viewerControlsOpenPutRequest2"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40006] 不正なパラメータ値が指定された(ページ数が 0 もしくは負の値)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの操作権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/controls/open2_confirm": {
"put": {
"tags": [
"ビューワー操作"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "**確認ダイアログを表示した上で指定ドキュメントを開く**\n * ページ番号は省略可能。その場合、開かれるページは本体側にオマカセ。\n * ページ番号が 0 もしくは負の値を指定した場合はエラー。\n * ページ番号がそのドキュメントの総ページ数より大きい値の場合は、最終ページが開く。\n * 'confirm_dialog_params' パラメーターを省略した場合は、PUT /viewer/controls/open2 と同じ挙動になる",
"parameters": [
{
"name": "target_doc_info",
"in": "body",
"description": "開く対象のドキュメントの情報",
"required": true,
"schema": {
"$ref": "#/definitions/viewerControlsOpenPutRequest2Confirm"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40006] 不正なパラメータ値が指定された(ページ数が 0 もしくは負の値)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの操作権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたIDのドキュメントが存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/status/current_viewing": {
"get": {
"tags": [
"ビューワー操作"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**本体のドキュメント表示状態を取得**\n * ドキュメント閲覧中でない場合(設定画面になっている等)は、中身がほとんど空の応答が返る。",
"responses": {
"200": {
"description": "表示状態情報",
"schema": {
"$ref": "#/definitions/viewerStatusCurrentViewingGetResult2"
}
},
"403": {
"description": "* [40310] 指定されたIDのドキュメントの読み込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/controls/transfer/documents_view": {
"put": {
"tags": [
"ビューワー操作"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "ドキュメント一覧画面に遷移する",
"parameters": [
{
"name": "documents_view_info",
"in": "body",
"description": "ドキュメント一覧画面に関する各種パラメーター",
"required": true,
"schema": {
"$ref": "#/definitions/documentsViewInfoObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/viewer/controls/transfer/folder_view": {
"put": {
"tags": [
"ビューワー操作"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "フォルダー画面に遷移する",
"parameters": [
{
"name": "folder_view_info",
"in": "body",
"description": "フォルダー画面に関する各種パラメーター",
"required": true,
"schema": {
"$ref": "#/definitions/commonFolderIdObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n本体設定情報をまとめて取得する",
"responses": {
"200": {
"description": "設定情報をまとめたもの",
"schema": {
"$ref": "#/definitions/configsListResult"
}
}
}
}
},
"/system/configs2": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体設定情報をまとめて取得する",
"responses": {
"200": {
"description": "設定情報をまとめたもの",
"schema": {
"$ref": "#/definitions/configsListResult2"
}
}
}
}
},
"/system/configs/timezone": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されているタイムゾーンを取得する",
"responses": {
"200": {
"description": "タイムゾーンID ※詳細はInstructionを参照の事",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "タイムゾーンを設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "タイムゾーンID ※詳細はInstructionを参照の事",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/datetime": {
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "現在の日時を設定する",
"parameters": [
{
"name": "datetime",
"in": "body",
"description": "ISO8601 フォーマットの日時情報",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40004] 指定パラメータが ISO8601 フォーマットでない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/date_format": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されている日付表記形式を取得する",
"responses": {
"200": {
"description": "日付パターン文字列 ※詳細はInstructionを参照の事",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "日付表記形式を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "日付パターン文字列 ※詳細はInstructionを参照の事",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40006] 不正なパラメータ値が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/time_format": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されている日付表記形式を取得する",
"responses": {
"200": {
"description": "以下のどれかの文字列を返却\n * '12hour' : 12時間表記\n * '24hour' : 24時間表記",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "日付表記形式を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "以下のどれかを文字列で指定する\n * '12hour' : 12時間表記\n * '24hour' : 24時間表記",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/initialized_flag": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "初期設定完了かどうかを取得する",
"responses": {
"200": {
"description": "初期化済なら 'initialized' 初期化していない場合は 'none'",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "初期設定完了フラグを設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "初期化後 'initialized' 設定解除なら 'none'",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/timeout_to_standby": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されているスリープに入る時間を取得する",
"responses": {
"200": {
"description": "設定時間 (分単位)
\nスリープに入らない時は 'never'",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "スリープに入る時間を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "設定時間を分単位で数値を指定
\nスリープに入らない時は 'never'",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40006] 不正なパラメータ値が指定された(数値が規定範囲外)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/owner": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されている所有者名情報を取得する",
"responses": {
"200": {
"description": "設定されている所有者名(JSONエスケープ)",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "所有者名情報を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "所有者名(JSONエスケープ)",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40006] 不正なパラメータ値が指定された(桁数オーバーなど)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/use_mode": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されている利用形態情報を取得する
\n※将来の拡張を考慮し、use_mode に 'others' が返却されるケースがあるので注意",
"responses": {
"200": {
"description": "設定されている利用形態情報",
"schema": {
"$ref": "#/definitions/configsUseModeObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "利用形態情報を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "利用形態情報",
"required": true,
"schema": {
"$ref": "#/definitions/configsUseModeObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/regulation_voltage": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されている規制電圧値を取得する",
"responses": {
"200": {
"description": "設定されている規制電圧値 (単位 mV)",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "規制電圧値を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "規制電圧値 (単位 mV)",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40006] 不正なパラメータ値が指定された(数値が規定範囲外)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/pen_grip_style": {
"get": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "設定されているペンの持ち方情報を取得する",
"responses": {
"200": {
"description": "設定されているペンの持ち方情報\n* 右利き: 'right_standard'\n* 右利き巻き込み: 'right_hooked'\n* 左利き: 'left_standard'\n* 左利き巻き込み: 'left_hooked'",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-本体設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "ペンの持ち方情報を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "ペンの持ち方情報 (以下の4種類から選択)\n* 右利き: 'right_standard'\n* 右利き巻き込み: 'right_hooked'\n* 左利き: 'left_standard'\n* 左利き巻き込み: 'left_hooked'",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/status/storage": {
"get": {
"tags": [
"設定-本体状態取得"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体ストレージ使用状況の取得",
"responses": {
"200": {
"description": "ストレージ使用状況",
"schema": {
"$ref": "#/definitions/statusStorageResult"
}
}
}
}
},
"/system/status/firmware_version": {
"get": {
"tags": [
"設定-本体状態取得"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体ファームウェアバージョン番号とモデル名の取得",
"responses": {
"200": {
"description": "ファームウェアバージョン番号とモデル名",
"schema": {
"$ref": "#/definitions/statusFirmwareVersionResult"
}
}
}
}
},
"/system/status/mac_address": {
"get": {
"tags": [
"設定-本体状態取得"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体搭載の無線LANデバイスの物理アドレスの取得
\n※コロン繋ぎの16進数表現 (xx:xx:xx:xx:xx:xx)",
"responses": {
"200": {
"description": "アドレス値",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
}
},
"/system/status/battery": {
"get": {
"tags": [
"設定-本体状態取得"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "バッテリー状態の取得",
"responses": {
"200": {
"description": "バッテリー状態",
"schema": {
"$ref": "#/definitions/statusBatteryResult2"
}
}
}
}
},
"/system/controls/indicate": {
"post": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "画面上に各種通知用ダイアログを表示する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "ダイアログのパラメータ",
"required": true,
"schema": {
"$ref": "#/definitions/indicationInfoObject2"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/indicate/{indication_id}": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "画面上に各種通知用ダイアログを表示する
\n※識別子はUUID形式であれば任意なものを指定可能
\n※以前指定したのと同じ識別子を指定した場合は、対応するダイアログの情報を上書きする",
"parameters": [
{
"name": "indication_id",
"in": "path",
"description": "識別子(UUID形式)",
"required": true,
"type": "string"
},
{
"name": "indication_info",
"in": "body",
"description": "ダイアログのパラメータ",
"required": true,
"schema": {
"$ref": "#/definitions/indicationInfoObject2"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40006] 識別子がUUID形式じゃなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"delete": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "画面上に表示されている、指定した識別子に対応する各種通知用ダイアログを非表示にする
\n※指定した識別子に対応するダイアログが、ユーザー操作等により非表示だった場合でも、エラーとならずに成功となる",
"parameters": [
{
"name": "indication_id",
"in": "path",
"description": "表示時に指定した識別子(UUID形式)",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40006] 識別子がUUID形式じゃなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/screen_shot": {
"get": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"image/png",
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\n本体のスクリーンショット画像取得 (フォーマットは png 固定)
\n※画像の大きさは本体の画面画素数に依存 (1650×2200 または 1404x1872)",
"responses": {
"200": {
"description": "スクリーンショット画像",
"schema": {
"type": "file",
"description": "画像データバイナリ"
}
}
}
}
},
"/system/controls/screen_shot2": {
"get": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"image/png",
"image/jpeg",
"application/json"
],
"description": "本体のスクリーンショット画像取得 (フォーマットはパラメータで指定)
\n※画像の大きさは本体の画面画素数に依存 (1650×2200 または 1404x1872)",
"parameters": [
{
"name": "format",
"in": "query",
"description": "画像フォーマット ['jpeg'/'png'] (省略時'jpeg')",
"type": "string"
}
],
"responses": {
"200": {
"description": "スクリーンショット画像",
"schema": {
"type": "file",
"description": "画像データバイナリ"
}
},
"400": {
"description": "* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/reset_configs": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "特定の設定項目について初期値を復元する",
"responses": {
"204": {
"description": "成功"
}
}
}
},
"/system/controls/transfer/wizard": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "初期設定ウィザード画面に遷移する\n* 表示する順番通りに、ウイザード画面の識別子を配列で指定する。\n * ペン先位置調整画面: 'pen_grip_style'\n* ウィザード終了後、特定の画面に遷移させたい場合は、next_screen 以下のどれかのパラメーターを指定する\n * 任意のドキュメントを開く: document_open を設定\n * ドキュメント一覧画面に遷移する: documents_view を設定\n * フォルダー画面に遷移する: folder_view を設定\n * 本体側にオマカセの場合は何も設定しない\n * 2つ以上のパラメーターを設定した場合はエラー",
"parameters": [
{
"name": "transfer_wizard_info",
"in": "body",
"description": "ウィザード画面情報",
"required": true,
"schema": {
"$ref": "#/definitions/transferWizardInfoObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値を期待しているパラメータについて、数値として認識できなかった\n* [40005] 仕様で定めた選択肢以外のもの指定した\n* [40006] 不正なパラメータ値が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/sleep": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体をスリープ状態にする (既にスリープ状態の場合は何も起きない)",
"responses": {
"204": {
"description": "成功"
}
}
}
},
"/system/controls/run": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体をスリープ状態から復帰させる (既に復帰状態の場合は何も起きない)",
"responses": {
"204": {
"description": "成功"
}
}
}
},
"/system/controls/customize_ux": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "本体の各種 UI の表示可否や設定内容をカスタマイズする",
"parameters": [
{
"name": "jsonParam",
"in": "body",
"description": "カスタマイズ情報",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "エラーなし"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 有効なカスタマイズ項目が一つも指定されていない\n* [40005] 'target' に有効な選択肢以外のもの指定した\n* [40006] 'version' に不正な値が指定された"
}
}
}
},
"/system/controls/clear_documents": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体内のドキュメントを全て削除する",
"responses": {
"204": {
"description": "成功"
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/update_firmware/precheck": {
"get": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体のファームウェアアップデートが開始できるか事前チェック",
"responses": {
"200": {
"description": "チェック結果",
"schema": {
"$ref": "#/definitions/updateFirmwarePrecheckResult"
}
}
}
}
},
"/system/controls/update_firmware": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体のファームウェアアップデート開始する",
"responses": {
"204": {
"description": "ファームウェアアップデート開始"
},
"403": {
"description": "* [40302] 電池残量がファームウェアアップデートするのに十分でない\n* [40303] ファームウェアのイメージファイルが本体に転送されていない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 複数同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/update_firmware/file": {
"put": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"description": "本体にファームウェアのイメージファイルを転送する
\n* 分割アップロードが可能\n* offset_bytes に 0 を指定してリクエストした場合、そのクライアントのIDがサーバ側で保持される\n* offset_bytes に 0 より大きい値を指定してリクエストした場合、サーバ側で保持しているIDと一致するクライアントからでなければ 503 応答を返す",
"parameters": [
{
"name": "file",
"in": "formData",
"description": "ファイル実体",
"required": true,
"type": "file"
},
{
"name": "offset_bytes",
"in": "query",
"description": "分割アップロードの際に指定 ※詳細はInstructionを参照の事",
"required": true,
"type": "string"
},
{
"name": "total_bytes",
"in": "query",
"description": "分割アップロードの際に指定 ※詳細はInstructionを参照の事",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "受信完了",
"schema": {
"$ref": "#/definitions/commonFileUploadResult"
}
},
"400": {
"description": "* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40010] ファイルが指定されていない\n* [40011] 分割アップロードで不整合",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"500": {
"description": "* [50095] 通信関連のエラーが発生し処理が完了できなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 複数同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/pastlog": {
"get": {
"tags": [
"設定-本体制御"
],
"schemes": [
"https"
],
"produces": [
"application/octet-stream",
"application/json"
],
"description": "本体に記録されている各種ログ情報を暗号化した上で取得する
\n※注意: 処理にかなり時間がかかる上、データ量も十数MB程度になる",
"responses": {
"200": {
"description": "成功",
"schema": {
"type": "file",
"description": "暗号化されたログ情報"
}
}
}
}
},
"/system/configs/wifi": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体の Wi-Fi 機能の ON/OFF 状態を取得する",
"responses": {
"200": {
"description": "設定値 'on'で有効、'off'で無効",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "本体の Wi-Fi 機能の ON/OFF 状態を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "'on'で有効、'off'で無効",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された"
},
"403": {
"description": "* [40302] 本体の電池残量不足で ON にできない\n* [40307] 本体がスリープ状態のため ON にできない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/wifi_apmode": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体の Wi-Fi のアクセスポイントモードの ON/OFF 状態を取得する",
"responses": {
"200": {
"description": "設定値 'on'で有効、'off'で無効",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "本体の Wi-Fi のアクセスポイントモードの ON/OFF 状態を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "'on'で有効、'off'で無効",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された"
},
"403": {
"description": "* [40302] 本体の電池残量不足で指定されたモードに設定できない\n* [40307] 本体がスリープ状態のため指定されたモードに設定できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/wifi_accesspoints": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "全ての登録済みアクセスポイントの設定を取得する",
"responses": {
"200": {
"description": "登録済みアクセスポイントの設定情報のリスト
\n※ passwd は取得できず、常に未設定",
"schema": {
"$ref": "#/definitions/apConfigureListObject"
}
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/wifi_accesspoints/{ssid}/{security}": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "指定した SSID の登録済みアクセスポイントの設定を取得する",
"parameters": [
{
"name": "ssid",
"in": "path",
"description": "SSID を URL encode したもの、文字コードは UTF-8",
"required": true,
"type": "string"
},
{
"name": "security",
"in": "path",
"description": "暗号化方式 ['nonsec'/'psk'/'eap']",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "登録済みアクセスポイントの設定情報
\n※ passwd は取得できず、常に未設定",
"schema": {
"$ref": "#/definitions/apConfigureObject"
}
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定された SSID と暗号化方式のアクセスポイントは登録されていない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"delete": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "登録済みアクセスポイントの削除\n",
"parameters": [
{
"name": "ssid",
"in": "path",
"description": "SSID を URL encode したもの、文字コードは UTF-8",
"required": true,
"type": "string"
},
{
"name": "security",
"in": "path",
"description": "暗号化方式 ['nonsec'/'psk'/'eap']",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "成功"
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定された SSID と暗号化方式のアクセスポイントは登録されていない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/certificates": {
"delete": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "登録済み EAP 用各種証明書(CA 証明書、TLS クライアント証明書)を全て削除する\n",
"responses": {
"204": {
"description": "成功"
}
}
}
},
"/system/configs/certificates/ca": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "登録済み EAP 用 CA 証明書の名前一覧を取得する\n",
"responses": {
"200": {
"description": "証明書名のリスト",
"schema": {
"$ref": "#/definitions/commonCertificatesListObject"
}
}
}
},
"post": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "EAP 用 CA 証明書の新規インストール
\n証明書名が同一のものがインストール済みの場合は上書きされる",
"parameters": [
{
"name": "value",
"in": "body",
"description": "EAP 用 CA 証明書情報",
"required": true,
"schema": {
"$ref": "#/definitions/caCertificatesFileObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した\n* [40006] 証明書ファイルのデータ中に適切な証明書情報が見つからない\n* [40013] ファイル名の拡張子が、対応していない形式を指定された\n* [40014] 証明書のインストールに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/certificates/client": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "登録済み EAP 用 TLS クライアント証明書の名前一覧を取得する\n",
"responses": {
"200": {
"description": "証明書名のリスト",
"schema": {
"$ref": "#/definitions/commonCertificatesListObject"
}
}
}
},
"post": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "EAP 用 TLS クライアント証明書の新規インストール
\n証明書名が同一のものがインストール済みの場合は上書きされる",
"parameters": [
{
"name": "value",
"in": "body",
"description": "EAP 用 TLS クライアント証明書情報",
"required": true,
"schema": {
"$ref": "#/definitions/clientCertificatesFileObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した\n* [40006] 証明書ファイルのデータ中に適切な証明書情報が見つからない\n* [40013] ファイル名の拡張子が、対応していない形式を指定された\n* [40014] 証明書のインストールに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40301] パスワードが正しくない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/wifi_frequency_band": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体の Wi-Fi 機能の周波数帯設定を取得する",
"responses": {
"200": {
"description": "Wi-Fi 機能の周波数帯\n* 'auto': 自動\n* '5ghz': 5 GHz\n* '2.4ghz': 2.4 GHz",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "本体の Wi-Fi 機能の周波数帯を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "Wi-Fi 機能の周波数帯\n* 自動: 'auto'\n* 5 GHz: '5ghz'\n* 2.4 GHz: '2.4ghz'",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された"
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/configs/wifi_sleep_policy": {
"get": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体がスリープ中における Wi-Fi 機能維持の方針を取得する",
"responses": {
"200": {
"description": "Wi-Fi 機能維持の方針情報\n* 'enabled_always': 常に有効\n* 'enabled_if_plugged': 電源接続時のみ有効\n* 'disabled': 無効",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
},
"put": {
"tags": [
"設定-無線設定"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "本体がスリープ中における Wi-Fi 機能維持の方針を設定する",
"parameters": [
{
"name": "value",
"in": "body",
"description": "Wi-Fi 機能維持の方針情報\n* 常に有効: 'enabled_always'\n* 電源接続時のみ有効: 'enabled_if_plugged'\n* 無効: 'disabled'",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された"
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/status/wifi_state": {
"get": {
"tags": [
"設定-無線状態取得"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "現在の Wi-Fi 接続状況を取得する (アクセスポイント接続中は、そのアクセスポイントの情報も取得)",
"responses": {
"200": {
"description": "Wi-Fi 接続状況\n* state が 'connecting', 'connected' 以外の場合、他のパラメータは未設定",
"schema": {
"$ref": "#/definitions/commonApObject"
}
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/status/wps_state": {
"get": {
"tags": [
"設定-無線状態取得"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "Wi-Fi Protected Setup™ (WPS) による Wi-Fi 登録処理の状況、もしくは結果を取得する",
"responses": {
"200": {
"description": "状態値\n* 'none': 初期状態 (本体起動後、まだ一度も実行していない)\n* 'in_progress': 処理中\n* 'success': 成功\n* 'overlap_error': 複数のセッションを検知\n* 'wep_prohibited': サポート外のセキュリティ方式(WEP)\n* 'tkip_only_prohibited': サポート外のセキュリティ方式(TKIP)\n* 'timed_out': タイムアウト(2分)",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/wifi_accesspoints/scan": {
"post": {
"tags": [
"設定-無線制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "Wi-Fi アクセスポイントのスキャンを行い、結果の一覧を取得する",
"responses": {
"200": {
"description": "スキャンして見つかったアクセスポイントのリスト",
"schema": {
"$ref": "#/definitions/commonApListObject"
}
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 処理が想定時間内に完了しなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/wifi_accesspoints/register": {
"put": {
"tags": [
"設定-無線制御"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "Wi-Fi アクセスポイント新規登録または登録済みのアクセスポイントの設定変更の上、そのアクセスポイントへの接続要求\n* 同一の SSID 且つ同一暗号化方式のアクセスポイントが既に登録されている場合、設定内容が上書きされる\n* dhcp が 'false' の場合、static_address, gateway, network_mask, dns1, dns2 は必須
\n (static_address, network_mask, dns1 は空文字不可。gateway, dns2は空文字許容。)\n* proxy が 'true' の場合、proxy_host, proxy_port は必須 (空文字は許容)\n* security が 'eap' の場合、eap, eap_phase2, eap_id, eap_anid, eap_cacert, eap_cert は必須 (空文字は許容)\n* 登録済みのアクセスポイントの設定変更の際は、変更がない項目についても全て指定する\n * 例外的に passwd のみ、未設定もしくは空文字の場合は「変更なし」と解釈する",
"parameters": [
{
"name": "ap",
"in": "body",
"description": "アクセスポイント設定内容",
"required": true,
"schema": {
"$ref": "#/definitions/apConfigureObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40003] Base64のデコードに失敗した\n* [40005] 規定された選択肢以外の文字列が指定された\n* [40006] 不正なパラメータ値が指定された\n* [40008] 登録可能なアクセスポイント数の上限に達している",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/wps_start/button": {
"put": {
"tags": [
"設定-無線制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "Wi-Fi Protected Setup™ (WPS) による Wi-Fi 登録開始 (ボタン型、非同期)",
"responses": {
"204": {
"description": "成功 (登録シーケンスが開始された)"
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/wps_start/pin": {
"put": {
"tags": [
"設定-無線制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "Wi-Fi Protected Setup™ (WPS) による Wi-Fi 登録開始 (PIN 型、非同期)",
"responses": {
"200": {
"description": "登録シーケンスが開始され、PIN を取得",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"408": {
"description": "* [40800] 想定時間内に PIN が取得できなかった(60秒)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/system/controls/wps_cancel": {
"put": {
"tags": [
"設定-無線制御"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "Wi-Fi Protected Setup™ (WPS) による Wi-Fi 登録の手動キャンセル",
"responses": {
"204": {
"description": "成功 (登録シーケンスを停止した)"
},
"403": {
"description": "* [40304] Wi-Fi が OFF なので処理できない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register/serial_number": {
"get": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"produces": [
"application/json"
],
"description": "本体シリアル番号の取得
\n※HTTP通信が可能",
"responses": {
"200": {
"description": "本体シリアル番号",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
}
},
"/register/information": {
"get": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"produces": [
"application/json"
],
"description": "本体の各種情報を取得
\n※HTTP通信が可能",
"responses": {
"200": {
"description": "本体の各種情報",
"schema": {
"$ref": "#/definitions/deviceInformationResult"
}
}
}
}
},
"/register/pin": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその1
\n※HTTP通信が可能、詳しくは別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"responses": {
"200": {
"description": "M1
※別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
}
}
}
},
"/register/hash": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその2
\n※HTTP通信が可能、詳しくは別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"parameters": [
{
"name": "M2",
"in": "body",
"description": "M2
※別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"required": true,
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
}
],
"responses": {
"200": {
"description": "M3
※別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40301] 登録シーケンスに基づくパラメータの検証結果に問題あり\n* [40305] リトライ制限・時間制限により、登録シーケンスを最初からやりなおす必要あり",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register/ca": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその3
\n※HTTP通信が可能、詳しくは別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"parameters": [
{
"name": "M4",
"in": "body",
"description": "M4
※別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"required": true,
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
}
],
"responses": {
"200": {
"description": "M5
※別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40301] 登録シーケンスに基づくパラメータの検証結果に問題あり\n* [40305] リトライ制限・時間制限により、登録シーケンスを最初からやりなおす必要あり",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその4
\n※HTTP通信が可能、詳しくは別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"parameters": [
{
"name": "M6",
"in": "body",
"description": "M6
※別紙 'クライアント登録用WebAPI補足.pptx' 参照",
"required": true,
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
}
],
"responses": {
"204": {
"description": "登録完了"
},
"400": {
"description": "* [40000] JSONのパースに失敗した(もしくは中身が何もなかった)\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40301] 登録シーケンスに基づくパラメータの検証結果に問題あり\n* [40305] リトライ制限・時間制限により、登録シーケンスを最初からやりなおす必要あり",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register/dcss1": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその1 (DCSS向け)
\n※HTTP通信が可能、詳しくは別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"responses": {
"200": {
"description": "M5
※別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
},
"403": {
"description": "* [40301] 登録シーケンスに基づくパラメータの検証結果に問題あり\n* [40305] リトライ制限・時間制限により、登録シーケンスを最初からやりなおす必要あり",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register/dcss2": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその2 (DCSS向け)
\n※HTTP通信が可能、詳しくは別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"parameters": [
{
"name": "M2",
"in": "body",
"description": "M2
※別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"required": true,
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
}
],
"responses": {
"200": {
"description": "M3
※別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40301] 登録シーケンスに基づくパラメータの検証結果に問題あり\n* [40305] リトライ制限・時間制限により、登録シーケンスを最初からやりなおす必要あり",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register/dcss3": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその3 (DCSS向け)
\n※HTTP通信が可能、詳しくは別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"parameters": [
{
"name": "M4",
"in": "body",
"description": "M4
※別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"required": true,
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
}
],
"responses": {
"200": {
"description": "M5
※別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40301] 登録シーケンスに基づくパラメータの検証結果に問題あり\n* [40305] リトライ制限・時間制限により、登録シーケンスを最初からやりなおす必要あり",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register/dcss4": {
"post": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスその4 (DCSS向け)
\n※HTTP通信が可能、詳しくは別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"parameters": [
{
"name": "M6",
"in": "body",
"description": "M6
※別紙 'DCSS登録用WebAPI補足.pptx' 参照",
"required": true,
"schema": {
"$ref": "#/definitions/commonRegisterObject"
}
}
],
"responses": {
"204": {
"description": "登録完了"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40003] Base64のデコードに失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40301] 登録シーケンスに基づくパラメータの検証結果に問題あり\n* [40305] リトライ制限・時間制限により、登録シーケンスを最初からやりなおす必要あり",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/register/cleanup": {
"put": {
"tags": [
"クライアント登録"
],
"schemes": [
"http",
"https"
],
"produces": [
"application/json"
],
"description": "クライアント登録シーケンスに関連する、本体画面の表示のクリアを指示する",
"responses": {
"204": {
"description": "結果に依らず応答"
}
}
}
},
"/auth/nonce/{client_id}": {
"get": {
"tags": [
"クライアント認証"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "Nonce (ワンタイムトークン) を取得する",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "クライアントの識別子",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Nonce (ワンタイムトークン) 情報",
"schema": {
"$ref": "#/definitions/commonNonceObjectResult"
}
},
"404": {
"description": "* [40401] 指定された識別子のクライアントは登録されていない ",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/auth": {
"put": {
"tags": [
"クライアント認証"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "認証を行う
\nnonce_signed には、Nonce (ワンタイムトークン)をK_PRIV_C(クライアントの秘密鍵)を用いてSHA256署名アルゴリズムで電子署名したものを指定する",
"parameters": [
{
"name": "auth_info",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/authPutRequest"
}
}
],
"responses": {
"204": {
"description": "認証に成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"401": {
"description": "* [40100] 認証に失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/extensions/status": {
"get": {
"tags": [
"拡張アプリ"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "(拡張アプリ向け) 状態値の一覧を取得する",
"responses": {
"200": {
"description": "各種状態値の一覧
(JSONの属性名'item1, item2...'は動的に変化する)",
"schema": {
"$ref": "#/definitions/extensionsStatusGetResult"
}
}
}
}
},
"/extensions/status/{item}": {
"get": {
"tags": [
"拡張アプリ"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "(拡張アプリ向け) 状態値を取得する",
"parameters": [
{
"name": "item",
"in": "path",
"description": "状態項目名",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "指定された状態項目の状態値",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
},
"404": {
"description": "* [40401] 拡張アプリには指定された状態項目が存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/extensions/configs": {
"get": {
"tags": [
"拡張アプリ"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "(拡張アプリ向け) 設定値の一覧を取得する",
"responses": {
"200": {
"description": "各種設定値の一覧
(JSONの属性名 'item1, item2...' は動的に変化する)",
"schema": {
"$ref": "#/definitions/extensionConfigsGetResult"
}
}
}
}
},
"/extensions/configs/{item}": {
"get": {
"tags": [
"拡張アプリ"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "(拡張アプリ向け) 設定値を取得する",
"parameters": [
{
"name": "item",
"in": "path",
"description": "設置項目名",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "指定された設定項目の設定値",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
},
"404": {
"description": "* [40401] 拡張アプリには指定された設定項目が存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"拡張アプリ"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "(拡張アプリ向け) 指定した内容で設定を変更する",
"parameters": [
{
"name": "item",
"in": "path",
"description": "設定項目名",
"required": true,
"type": "string"
},
{
"name": "config",
"in": "body",
"description": "設定値情報",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "指定されたパラメータが不正",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 拡張アプリには指定された設定項目が存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/testmode/auth/nonce": {
"get": {
"tags": [
"テストモード"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "テストモード専用認証のNonce (ワンタイムトークン) を取得する",
"responses": {
"200": {
"description": "Nonce (ワンタイムトークン) 情報",
"schema": {
"$ref": "#/definitions/commonNonceObjectResult"
}
},
"403": {
"description": "* [40300] テストモードとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/testmode/auth": {
"put": {
"tags": [
"テストモード"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "テストモード専用認証を行う
\nnonce_signed には、Nonce (ワンタイムトークン)をK_PRIV_DT(テストモード専用クライアントの秘密鍵)を用いてSHA256署名アルゴリズムで電子署名したものを指定する",
"parameters": [
{
"name": "auth_info",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/specialAuthPutRequest"
}
}
],
"responses": {
"204": {
"description": "認証に成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"401": {
"description": "* [40100] 認証に失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40300] テストモードとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/testmode/launch": {
"put": {
"tags": [
"テストモード"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "テストモードUI表示",
"responses": {
"204": {
"description": "成功"
},
"403": {
"description": "* [40300] テストモードとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/testmode/recovery_mode": {
"put": {
"tags": [
"テストモード"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "本体をリカバリーモードで再起動する",
"responses": {
"204": {
"description": "成功"
},
"403": {
"description": "* [40300] テストモードとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/testmode/assets/{path}": {
"get": {
"tags": [
"テストモード"
],
"schemes": [
"https"
],
"produces": [
"application/octet-stream",
"text/plain",
"application/json"
],
"description": "テストモード専用ストレージ領域内のファイル実体、もしくはフォルダーの情報を取得",
"parameters": [
{
"name": "path",
"in": "path",
"description": "ファイル/フォルダーの相対パスをURLエンコードしたもの
\nデコードした結果の末尾が'/'の場合は、フォルダー情報を要求されたと判断",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "* ファイル指定の場合、指定ファイルの実体\n* フォルダー指定の場合、指定フォルダー内のファイルとフォルダーの一覧をtext/plainで返す
\n (一覧について、末尾に '/' があればフォルダー、なければファイルを表す)",
"schema": {
"type": "file"
}
},
"400": {
"description": "* [40006] パラメータに不正なパスが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40300] テストモードとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたパスにファイル/フォルダーは存在しない\n * ファイル指定で、そのパスにあるのはフォルダーだった場合も該当\n * フォルダー指定で、そのパスにあるのはファイルだった場合も該当",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"テストモード"
],
"schemes": [
"https"
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"description": "テストモード専用ストレージ領域内にファイルをアップロード、もしくはフォルダーの作成
\n指定パスの途中までのフォルダーは、適宜自動生成される
\n同一パスに何かあった場合は、ファイルであれフォルダーであれ、問答無用で削除した後、上書きされる",
"parameters": [
{
"name": "path",
"in": "path",
"description": "ファイル/フォルダーの相対パスをURLエンコードしたもの
\nデコードした結果の末尾が'/'の場合は、フォルダー作成を要求されたと判断",
"required": true,
"type": "string"
},
{
"name": "file",
"in": "formData",
"description": "ファイル実体(フォルダー作成の場合は不要)",
"type": "file"
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40006] パラメータに不正なパスが指定された\n* [40010] ファイル指定なのに、ファイル実体が指定されていない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40300] テストモードとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"delete": {
"tags": [
"テストモード"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "テストモード専用ストレージ領域内のファイル/フォルダーを削除
\nフォルダーを指定した場合は、そのフォルダー以下を再帰的に削除",
"parameters": [
{
"name": "path",
"in": "path",
"description": "ファイル/フォルダーの相対パスをURLエンコードしたもの
\nデコードした結果の末尾が'/'の場合は、フォルダー削除を要求されたと判断",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40006] パラメータに不正なパスが指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40300] テストモードとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたパスにファイル/フォルダーは存在しない\n * ファイル指定で、そのパスにあるのはフォルダーだった場合も該当\n * フォルダー指定で、そのパスにあるのはファイルだった場合も該当",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/kitting/auth/nonce": {
"get": {
"tags": [
"キッティング"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "キッティング専用認証のNonce (ワンタイムトークン) を取得する",
"responses": {
"200": {
"description": "Nonce (ワンタイムトークン) 情報",
"schema": {
"$ref": "#/definitions/commonNonceObjectResult"
}
},
"403": {
"description": "* [40300] キッティングとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/kitting/auth": {
"put": {
"tags": [
"キッティング"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "キッティング専用認証を行う
\nnonce_signed には、Nonce (ワンタイムトークン)をK_PRIV_DK(テストモード専用クライアントの秘密鍵)を用いてSHA256署名アルゴリズムで電子署名したものを指定する",
"parameters": [
{
"name": "auth_info",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/specialAuthPutRequest"
}
}
],
"responses": {
"204": {
"description": "認証に成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"401": {
"description": "* [40100] 認証に失敗した",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40300] キッティングとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/kitting/register/code": {
"put": {
"tags": [
"キッティング"
],
"schemes": [
"https"
],
"produces": [
"text/plain",
"application/json"
],
"description": "キッティングで DCSS の登録処理を行うため、事前に DCSS の URL と登録コードを設定する",
"parameters": [
{
"name": "code_info",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/kittingRegisterCodeRequest"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40006] パラメータに不正な内容が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40300] キッティングとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/kitting/transfer_timeout": {
"get": {
"tags": [
"キッティング"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "HTTP 通信に関連する諸々のタイムアウト時間を取得する",
"responses": {
"200": {
"description": "HTTP 通信に関連する諸々のタイムアウト時間",
"schema": {
"$ref": "#/definitions/transferTimeoutInfoObject"
}
},
"403": {
"description": "* [40300] キッティングとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
},
"put": {
"tags": [
"キッティング"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "HTTP 通信に関連する諸々のタイムアウト時間を設定する
\n'socket_timeout' よりも 'transfer_loop_timeout' の値が大きくなければならない
\n**注意: 本体を再起動しないと設定が反映されない**",
"parameters": [
{
"name": "value",
"in": "body",
"description": "HTTP 通信に関連する諸々のタイムアウト時間",
"required": true,
"schema": {
"$ref": "#/definitions/transferTimeoutInfoObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40002] 数値指定のパラメータが数値として認識できなかった\n* [40006] 不正なパラメータ値が指定された(数値が規定範囲外)",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"403": {
"description": "* [40300] キッティングとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/kitting/shutdown": {
"put": {
"tags": [
"キッティング"
],
"schemes": [
"https"
],
"produces": [
"text/plain",
"application/json"
],
"description": "キッティングの手順の一環として、本体をシャットダウンする",
"responses": {
"204": {
"description": "成功"
},
"403": {
"description": "* [40300] キッティングとして規定された手順以外でアクセスした",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"503": {
"description": "* [50301] 複数同時にできない処理を実行中で、要求に応じられない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/resolve/entry/{path}": {
"get": {
"tags": [
"その他"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "**★Obsoleted 使用非推奨★**
\nドキュメント/フォルダーのフルパスからエントリー情報を取得する
\n※ルートフォルダーを'Document/'と表現する事に注意",
"parameters": [
{
"name": "path",
"in": "path",
"description": "ドキュメント/フォルダーのフルパスをURLエンコードしたもの",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "エントリー情報",
"schema": {
"$ref": "#/definitions/commonEntryObjectResult"
}
},
"404": {
"description": "* [40401] 指定されたパスにドキュメント/フォルダーは存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/resolve/entry/path/{path}": {
"get": {
"tags": [
"その他"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "ドキュメント/フォルダーのフルパスからエントリー情報を取得する
\n※ルートフォルダーを'Document/'と表現する事に注意",
"parameters": [
{
"name": "path",
"in": "path",
"description": "ドキュメント/フォルダーのフルパスをURLエンコードしたもの",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "エントリー情報",
"schema": {
"$ref": "#/definitions/commonEntryObjectResult2"
}
},
"403": {
"description": "* [40310] 指定されたパスのドキュメント/フォルダーの読み込み権限がない",
"schema": {
"$ref": "#/definitions/errorResult"
}
},
"404": {
"description": "* [40401] 指定されたパスにドキュメント/フォルダーは存在しない",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/resolve/entry/ext_id/{ext_id}": {
"get": {
"tags": [
"その他"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "指定された外部IDが設定されているエントリー情報のリストを取得する
\n※読み込み権限がないエントリーについては、リストに含まれない(エラーにもならない)
\n※該当するエントリーが一件もない場合は空のリストを応答する",
"parameters": [
{
"name": "ext_id",
"in": "path",
"description": "外部IDをURLエンコードしたもの",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "エントリー情報のリスト",
"schema": {
"$ref": "#/definitions/commonEntryListObjectResult2"
}
}
}
}
},
"/notify/login_result": {
"put": {
"tags": [
"その他"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "DCSS のログイン処理実行の結果を通知する。",
"parameters": [
{
"name": "value",
"in": "body",
"description": "ログイン処理実行結果\n * 'success' : 成功\n * 'failure' : 失敗",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/notify/logout_result": {
"put": {
"tags": [
"その他"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "DCSS のログアウト処理実行の結果を通知する。",
"parameters": [
{
"name": "value",
"in": "body",
"description": "ログアウト処理実行結果\n * 'success' : 成功\n * 'failure' : 失敗",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった\n* [40005] 規定された選択肢以外の文字列が指定された",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/notify/force_assigned": {
"put": {
"tags": [
"その他"
],
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"description": "DCSS 側で本体とユーザーの紐付けが変更された事を通知する。",
"parameters": [
{
"name": "value",
"in": "body",
"description": "本体に新たに紐付けられたユーザー ID (空文字の場合はユーザーに紐付けられていない事を表す)",
"required": true,
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
],
"responses": {
"204": {
"description": "成功"
},
"400": {
"description": "* [40000] JSONのパースに失敗した\n* [40001] 必須パラメータが指定されていなかった",
"schema": {
"$ref": "#/definitions/errorResult"
}
}
}
}
},
"/api_version": {
"get": {
"tags": [
"その他"
],
"schemes": [
"http",
"https"
],
"produces": [
"application/json"
],
"description": "提供する Web API のバージョンを取得
\n※HTTP通信が可能",
"responses": {
"200": {
"description": "バージョン情報 (整数値)",
"schema": {
"$ref": "#/definitions/commonValueObject"
}
}
}
}
},
"/ping": {
"get": {
"tags": [
"その他"
],
"schemes": [
"https"
],
"produces": [
"application/json"
],
"description": "ただ応答をするだけ",
"responses": {
"204": {
"description": "応答"
}
}
}
}
},
"definitions": {
"errorResult": {
"type": "object",
"required": [
"error_code",
"message"
],
"properties": {
"error_code": {
"type": "string",
"description": "エラーコード(詳細は別資料参照)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"commonDocumentIdObject": {
"type": "object",
"required": [
"document_id"
],
"properties": {
"document_id": {
"description": "ドキュメントID",
"type": "string"
}
}
},
"commonFolderIdObject": {
"type": "object",
"required": [
"folder_id"
],
"properties": {
"folder_id": {
"description": "フォルダーID",
"type": "string"
}
}
},
"commonValueObject": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"description": "状態値/設定値",
"type": "string"
}
}
},
"commonEntryListObjectResult": {
"type": "object",
"required": [
"count",
"entry_list_hash",
"entry_list"
],
"properties": {
"count": {
"description": "検索条件に合致する結果の全件数。（entry_listの件数とは必ずしも一致しない。）",
"type": "integer"
},
"entry_list_hash": {
"description": "検索条件に合致する結果リストのハッシュ値。取得対象のフォルダー配下のリストに関する更新有無のチェックに使用可能。",
"type": "string"
},
"entry_list": {
"description": "指定条件に基づいて取得されたエントリーのリスト。ゼロ件の場合はsizeゼロのリストを返却。",
"type": "array",
"items": {
"$ref": "#/definitions/commonEntryObjectResult"
}
}
}
},
"commonEntryObjectResult": {
"type": "object",
"required": [
"entry_id",
"entry_name",
"entry_path",
"entry_type",
"created_date",
"is_new"
],
"properties": {
"entry_id": {
"description": "本体側で発行したドキュメント/フォルダーのID
\n※ルートフォルダーの場合は'root'という値で返却",
"type": "string"
},
"entry_name": {
"description": "エントリー名 (ファイル名/フォルダー名)",
"type": "string"
},
"entry_path": {
"description": "エントリーのフルパス ※ルートフォルダーは'Document/'と表現される",
"type": "string"
},
"entry_type": {
"description": "エントリー項目の種別（ファイル:'document', フォルダー:'folder'）",
"type": "string"
},
"created_date": {
"description": "エントリー作成日時(ISO8601 フォーマット)",
"type": "string"
},
"modified_date": {
"description": "エントリー更新日時(ISO8601 フォーマット) ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"mime_type": {
"description": "ファイルのMimeType ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"file_size": {
"description": "ファイルサイズ(単位：byte)
\n※entry_typeがフォルダーの場合はnull
\n※本項目により取得したサイズは、実際のファイルサイズと異なる場合がある（クライアントが本項目の値をWeb APIにより取得する前後のタイミングで本体上で対象ドキュメントが編集中であったり、別クライアントからファイルが更新される場合等）。",
"type": "string"
},
"document_type": {
"description": "ドキュメント種別（通常ドキュメント:'normal', ノート:'note'）※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"author": {
"description": "ドキュメントの著者名 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"title": {
"description": "ドキュメントのタイトル ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"total_page": {
"description": "ドキュメントのページ数 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"current_page": {
"description": "ドキュメントの直近で開かれていたページ番号 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"reading_date": {
"description": "ドキュメントの最終閲覧日時(ISO8601 フォーマット) ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"parent_folder_id": {
"description": "このエントリーが格納されているフォルダーのID
\n※ルートフォルダーの場合は'root'
\n※ルートフォルダーの親は存在しないので、その場合はnull",
"type": "string"
},
"is_new": {
"description": "エントリーが新規に追加されたものか 新規:'true',新規でない:'false'",
"type": "string"
},
"document_source": {
"description": "エントリーの配付元等の情報 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"file_hash": {
"description": "ドキュメントのファイルハッシュ（クライアント側で計算されたもの）。 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"file_revision": {
"description": "ドキュメントのリビジョン（本体側で計算されたもの）。 ※entry_typeがフォルダーの場合はnull",
"type": "string"
}
}
},
"commonApListObject": {
"type": "object",
"required": [
"aplist"
],
"properties": {
"aplist": {
"description": "アクセスポイントのリスト",
"type": "array",
"items": {
"$ref": "#/definitions/commonApObject"
}
}
}
},
"commonApObject": {
"type": "object",
"required": [
"state"
],
"properties": {
"ssid": {
"description": "SSID を BASE64 encode したもの、文字コードは UTF-8",
"type": "string"
},
"security": {
"description": "暗号化方式 ['nonsec'/'psk'/'eap']",
"type": "string"
},
"state": {
"description": "ネットワークの状態
\n- 'none': 状態なし(未登録のアクセスポイント)
\n- 'connecting': 接続処理中
\n- 'connected': 接続完了
\n- 'saved': 接続はしていないが、設定は保存されている状態
\n- 'disabled': 何らかの原因で接続できない状態 (例: パスワード間違い)",
"type": "string"
},
"frequency_band": {
"description": "周波数帯 ['2.4ghz'/'5ghz']",
"type": "string"
},
"rssi_level": {
"description": "電波強度 (0～3 の4段階、-1 は圏外を示す)",
"type": "string"
}
}
},
"commonCertificatesListObject": {
"type": "object",
"required": [
"cert"
],
"properties": {
"cert": {
"description": "証明書名",
"type": "array",
"items": {
"$ref": "#/definitions/commonCertificatesObject"
}
}
}
},
"commonCertificatesObject": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "証明書名",
"type": "string"
}
}
},
"commonNonceObjectResult": {
"type": "object",
"required": [
"nonce"
],
"properties": {
"nonce": {
"type": "string",
"description": "Nonce (ワンタイムトークン)"
}
}
},
"documentsPostRequest": {
"type": "object",
"required": [
"parent_folder_id",
"file_name",
"document_source"
],
"properties": {
"parent_folder_id": {
"description": "作成先のフォルダーID ※ルートフォルダーは'root'と指定する",
"type": "string"
},
"file_name": {
"description": "作成するドキュメントのファイル名",
"type": "string"
},
"document_source": {
"description": "ドキュメントの配付元等の情報 ※Polaris1.0では''(空文字)固定",
"type": "string"
}
}
},
"commonFileUploadResult": {
"type": "object",
"required": [
"received_bytes",
"current_bytes",
"completed",
"file_revision"
],
"properties": {
"received_bytes": {
"description": "サーバーで受信したアップロードデータのサイズ(単位:byte)",
"type": "string"
},
"current_bytes": {
"description": "以前の分割アップロードで受信したデータも含めた累積サイズ(単位:byte)",
"type": "string"
},
"completed": {
"description": "サーバ側でアップロードが完了したと判定したら 'yes' / まだ分割アップロードの途中と判定したら 'no'",
"type": "string"
},
"file_revision": {
"description": "ドキュメントのリビジョン（本体側で計算されたもの）",
"type": "string"
}
}
},
"documentsDocumentIdPutRequest": {
"type": "object",
"properties": {
"parent_folder_id": {
"description": "変更後の親フォルダーのID ※NULLの場合は変更しない。ルートフォルダーは'root'と指定する。",
"type": "string"
},
"file_name": {
"description": "変更後のドキュメントのファイル名 ※NULLの場合は変更しない",
"type": "string"
}
}
},
"documentsDocumentIdCopyPostRequest": {
"type": "object",
"required": [
"parent_folder_id"
],
"properties": {
"parent_folder_id": {
"description": "複製先の親フォルダーのID ※ルートフォルダーは'root'と指定する。",
"type": "string"
},
"file_name": {
"description": "コピー後のドキュメントのファイル名 ※NULLの場合はコピー元のファイル名をそのまま使用する",
"type": "string"
}
}
},
"foldersPostRequest": {
"type": "object",
"required": [
"parent_folder_id",
"folder_name"
],
"properties": {
"parent_folder_id": {
"description": "作成先のフォルダーID ※ルートフォルダーは'root'と指定する",
"type": "string"
},
"folder_name": {
"description": "作成するフォルダー名",
"type": "string"
}
}
},
"foldersFolderIdPutRequest": {
"type": "object",
"properties": {
"parent_folder_id": {
"description": "移動先のフォルダーID ※NULLの場合は変更しない。ルートフォルダーは'root'と指定する。",
"type": "string"
},
"folder_name": {
"description": "ドキュメントのファイル名 ※NULLの場合は変更しない",
"type": "string"
}
}
},
"documentsViewInfoObject": {
"type": "object",
"properties": {
"order_type": {
"description": "一覧のソート順指定 [閲覧日時降順: 'reading_date_desc' / 更新日時降順:'modified_date_desc']",
"type": "string"
}
}
},
"viewerStatusPresetMarksGetResult": {
"type": "object",
"required": [
"pattern_list"
],
"properties": {
"pattern_list": {
"description": "プリセットのパターンリスト。ゼロ件の場合はsizeゼロのリストを返却。",
"type": "array",
"items": {
"$ref": "#/definitions/commonPresetMarkObjectResult"
}
}
}
},
"commonPresetMarkObjectResult": {
"type": "object",
"required": [
"pattern"
],
"properties": {
"pattern": {
"description": "プリセットのパターン文字列",
"type": "string"
}
}
},
"viewerConfigsNoteTemplateGetResult": {
"type": "object",
"required": [
"template_list"
],
"properties": {
"template_list": {
"description": "ノートテンプレート情報のリスト。デフォルトノートテンプレートも含む。",
"type": "array",
"items": {
"$ref": "#/definitions/commonTemplateObjectResult"
}
}
}
},
"commonTemplateObjectResult": {
"type": "object",
"required": [
"note_template_id",
"template_name",
"created_date",
"is_modifiable"
],
"properties": {
"note_template_id": {
"description": "ノートテンプレートID",
"type": "string"
},
"template_name": {
"description": "ノートテンプレート名",
"type": "string"
},
"created_date": {
"description": "ノートテンプレート作成日時(ISO8601 フォーマット)",
"type": "string"
},
"is_modifiable": {
"description": "ノートテンプレート編集可否 可:'true',不可:'false'",
"type": "string"
}
}
},
"viewerConfigsNoteTemplatePostRequest": {
"type": "object",
"required": [
"template_name"
],
"properties": {
"template_name": {
"description": "作成するノートテンプレート名",
"type": "string"
}
}
},
"viewerConfigsNoteTemplatePostResult": {
"type": "object",
"required": [
"note_template_id"
],
"properties": {
"note_template_id": {
"description": "作成されたノートテンプレートのID",
"type": "string"
}
}
},
"viewerConfigsNoteTemplateTemplateIdPutRequest": {
"type": "object",
"properties": {
"template_name": {
"description": "変更後のノートテンプレート名 ※NULLの場合は変更しない",
"type": "string"
}
}
},
"viewerControlsOpenPutRequest": {
"type": "object",
"required": [
"document_id"
],
"properties": {
"document_id": {
"description": "開く対象のドキュメントのID",
"type": "string"
}
}
},
"documentsDocumentIdDeleteRequest": {
"type": "object",
"properties": {
"target_revision": {
"description": "削除対象のリビジョン。クライアント側で把握した最新のリビジョンを指定する。クライアント側で把握した以降に本体内でドキュメントが更新され、管理するリビジョンの値が指定されたtarget_revisionと異なる状態になっている場合にはエラーを返却する。指定無しの場合は、当該リビジョンチェックを行わない。",
"type": "string"
}
}
},
"foldersFolderIdDeleteRequest": {
"type": "object",
"properties": {
"force_delete_flag": {
"description": "削除対象フォルダー配下にエントリーが存在した場合、強制的に削除するかを指定するフラグ。'true'：強制的に削除する、'false'：配下にエントリーが存在したら削除しない。指定無しの場合、デフォルト'true'として扱う。",
"type": "string"
}
}
},
"configsListResult": {
"type": "object",
"properties": {
"timezone": {
"description": "タイムゾーン設定値",
"$ref": "#/definitions/commonValueObject"
},
"date_format": {
"description": "日付の表示形式",
"$ref": "#/definitions/commonValueObject"
},
"time_format": {
"description": "時刻の表示形式",
"$ref": "#/definitions/commonValueObject"
},
"initialized_flag": {
"description": "初期化済なら 'initialized' 初期化していない場合は 'none'",
"$ref": "#/definitions/commonValueObject"
},
"timeout_to_standby": {
"description": "設定時間(分単位)、スリープに入らない時は 'never'",
"$ref": "#/definitions/commonValueObject"
},
"owner": {
"description": "設定されている所有者名(JSONエスケープ)",
"$ref": "#/definitions/commonValueObject"
}
}
},
"configsListResult2": {
"type": "object",
"properties": {
"timezone": {
"description": "タイムゾーン設定値",
"$ref": "#/definitions/commonValueObject"
},
"date_format": {
"description": "日付の表示形式",
"$ref": "#/definitions/commonValueObject"
},
"time_format": {
"description": "時刻の表示形式",
"$ref": "#/definitions/commonValueObject"
},
"initialized_flag": {
"description": "初期化済なら 'initialized' 初期化していない場合は 'none'",
"$ref": "#/definitions/commonValueObject"
},
"timeout_to_sleep": {
"description": "設定時間(分単位)、スリープに入らない時は 'never'",
"$ref": "#/definitions/commonValueObject"
},
"owner": {
"description": "設定されている所有者名(JSONエスケープ)",
"$ref": "#/definitions/commonValueObject"
},
"use_mode": {
"description": "設定されている利用形態情報",
"$ref": "#/definitions/configsUseModeObject"
},
"regulation_voltage": {
"description": "設定されている規制電圧値 (単位 mV)",
"$ref": "#/definitions/commonValueObject"
},
"pen_grip_style": {
"description": "設定されているペンの持ち方情報 ['right_standard'/'right_hooked'/'left_standard'/'left_hooked']",
"$ref": "#/definitions/commonValueObject"
}
}
},
"configsUseModeObject": {
"type": "object",
"required": [
"use_mode"
],
"properties": {
"use_mode": {
"description": "利用形態情報 [個人用途:'personal' / 共用:'shared']",
"type": "string"
}
}
},
"statusStorageResult": {
"type": "object",
"required": [
"capacity",
"available"
],
"properties": {
"capacity": {
"description": "ストレージの最大容量 (byte単位)",
"type": "string"
},
"available": {
"description": "ストレージの空き容量 (byte 単位)",
"type": "string"
}
}
},
"updateFirmwarePrecheckResult": {
"type": "object",
"required": [
"image_file",
"battery"
],
"properties": {
"image_file": {
"description": "ファームウェアのイメージファイルが転送済みなら'ok', まだなら'ng'",
"type": "string"
},
"battery": {
"description": "電池残量がファームウェアアップデートするのに十分なら'ok', 不足なら'ng'",
"type": "string"
}
}
},
"statusFirmwareVersionResult": {
"type": "object",
"required": [
"value",
"model_name"
],
"properties": {
"value": {
"description": "ファームウェアバージョン番号",
"type": "string"
},
"model_name": {
"description": "モデル名",
"type": "string"
}
}
},
"apConfigureListObject": {
"type": "object",
"required": [
"aplist"
],
"properties": {
"aplist": {
"description": "登録済みアクセスポイントのリスト",
"type": "array",
"items": {
"$ref": "#/definitions/apConfigureObject"
}
}
}
},
"apConfigureObject": {
"type": "object",
"required": [
"ssid",
"security",
"dhcp",
"proxy"
],
"properties": {
"ssid": {
"description": "SSID を BASE64 encode したもの、文字コードは UTF-8",
"type": "string"
},
"security": {
"description": "暗号化方式 ['nonsec'/'psk'/'eap']",
"type": "string"
},
"passwd": {
"description": "アクセスポイントのアクセスパスワード",
"type": "string"
},
"dhcp": {
"description": "DHCPを利用する時'true'、未使用なら'false'",
"type": "string"
},
"static_address": {
"description": "IPアドレスの指定、DHCP未使用時",
"type": "string"
},
"gateway": {
"description": "ゲートウェイアドレスの指定、DHCP未使用時",
"type": "string"
},
"network_mask": {
"description": "ネットワークプレフィックス長の指定(0-32)、DHCP未使用時",
"type": "string"
},
"dns1": {
"description": "プライマリDNSアドレス、DHCP未使用時",
"type": "string"
},
"dns2": {
"description": "セカンダリDNSアドレス(指定しない場合は空文字)、DHCP未使用時",
"type": "string"
},
"proxy": {
"description": "proxy を利用する時'true'、未使用なら'false'",
"type": "string"
},
"proxy_host": {
"description": "proxy のアドレス、proxy使用時",
"type": "string"
},
"proxy_port": {
"description": "proxy のポート、proxy使用時",
"type": "string"
},
"eap": {
"description": "EAP 方式の指定 ['peap'/'tls']",
"type": "string"
},
"eap_phase2": {
"description": "EAP フェーズ2認証方式の指定 ['none'/'gtc'/'pap'/'mschap'/'mschapv2']",
"type": "string"
},
"eap_id": {
"description": "EAP ログインID",
"type": "string"
},
"eap_anid": {
"description": "EAP 匿名ID",
"type": "string"
},
"eap_cacert": {
"description": "EAP CA証明書名",
"type": "string"
},
"eap_cert": {
"description": "EAP クライアント証明書名",
"type": "string"
}
}
},
"caCertificatesFileObject": {
"type": "object",
"required": [
"file",
"filename"
],
"properties": {
"file": {
"description": "証明書ファイルの中身を base64 encode したもの",
"type": "string"
},
"filename": {
"description": "証明書の元ファイル名",
"type": "string"
},
"name": {
"description": "証明書につける名前",
"type": "string"
}
}
},
"clientCertificatesFileObject": {
"type": "object",
"required": [
"file",
"filename",
"password"
],
"properties": {
"file": {
"description": "証明書ファイルの中身を base64 encode したもの",
"type": "string"
},
"filename": {
"description": "証明書の元ファイル名",
"type": "string"
},
"name": {
"description": "証明書につける名前",
"type": "string"
},
"password": {
"description": "証明書のパスワード",
"type": "string"
}
}
},
"commonRegisterObject": {
"type": "object",
"properties": {
"a": {
"type": "string",
"description": "別紙 'クライアント登録用WebAPI補足.pptx' 参照"
},
"b": {
"type": "string",
"description": "別紙 'クライアント登録用WebAPI補足.pptx' 参照"
},
"c": {
"type": "string",
"description": "別紙 'クライアント登録用WebAPI補足.pptx' 参照"
},
"d": {
"type": "string",
"description": "別紙 'クライアント登録用WebAPI補足.pptx' 参照"
},
"e": {
"type": "string",
"description": "別紙 'クライアント登録用WebAPI補足.pptx' 参照"
}
}
},
"deviceInformationResult": {
"type": "object",
"required": [
"serial_number",
"sku_code",
"device_color",
"model_name"
],
"properties": {
"serial_number": {
"description": "シリアル番号",
"type": "string"
},
"sku_code": {
"description": "仕向け (ソニー社内で規定された識別規格仕様コード)",
"type": "string"
},
"device_color": {
"description": "筐体色 (カラーコード表現 #rrggbb)",
"type": "string"
},
"model_name": {
"description": "モデル名",
"type": "string"
}
}
},
"authPutRequest": {
"type": "object",
"required": [
"client_id",
"nonce_signed"
],
"properties": {
"client_id": {
"type": "string",
"description": "クライアントの識別子"
},
"nonce_signed": {
"type": "string",
"description": "Nonce (ワンタイムトークン)の電子署名結果をBase64エンコードしたもの"
}
}
},
"specialAuthPutRequest": {
"type": "object",
"required": [
"nonce_signed"
],
"properties": {
"nonce_signed": {
"type": "string",
"description": "Nonce (ワンタイムトークン)の電子署名結果をBase64エンコードしたもの"
}
}
},
"extensionsStatusGetResult": {
"type": "object",
"properties": {
"item1": {
"description": "状態項目1",
"$ref": "#/definitions/commonValueObject"
},
"item2": {
"description": "状態項目2",
"$ref": "#/definitions/commonValueObject"
}
}
},
"extensionConfigsGetResult": {
"type": "object",
"properties": {
"item1": {
"description": "設定項目1",
"$ref": "#/definitions/commonValueObject"
},
"item2": {
"description": "設定項目2",
"$ref": "#/definitions/commonValueObject"
}
}
},
"commonDocumentIdObject2": {
"type": "object",
"required": [
"document_id"
],
"properties": {
"document_id": {
"description": "ドキュメントID",
"type": "string"
}
}
},
"commonFolderIdObject2": {
"type": "object",
"required": [
"folder_id"
],
"properties": {
"folder_id": {
"description": "フォルダーID",
"type": "string"
}
}
},
"commonEntryListObjectResult2": {
"type": "object",
"required": [
"count",
"entry_list_hash",
"entry_list"
],
"properties": {
"count": {
"description": "検索条件に合致する結果の全件数。（entry_listの件数とは必ずしも一致しない。）",
"type": "integer"
},
"entry_list_hash": {
"description": "検索条件に合致する結果リストのハッシュ値。取得対象のフォルダー配下のリストに関する更新有無のチェックに使用可能。",
"type": "string"
},
"entry_list": {
"description": "指定条件に基づいて取得されたエントリーのリスト。ゼロ件の場合はsizeゼロのリストを返却。",
"type": "array",
"items": {
"$ref": "#/definitions/commonEntryObjectResult2"
}
}
}
},
"commonEntryObjectResult2": {
"type": "object",
"required": [
"entry_id",
"entry_name",
"entry_path",
"entry_type",
"created_date",
"is_new",
"document_source",
"ext_id"
],
"properties": {
"entry_id": {
"description": "本体側で発行したドキュメント/フォルダーのID
\n※ルートフォルダーの場合は'root'という値で返却",
"type": "string"
},
"entry_name": {
"description": "エントリー名 (ファイル名/フォルダー名)",
"type": "string"
},
"entry_path": {
"description": "エントリーのフルパス ※ルートフォルダーは'Document/'と表現される",
"type": "string"
},
"entry_type": {
"description": "エントリー項目の種別（ファイル:'document', フォルダー:'folder'）",
"type": "string"
},
"created_date": {
"description": "エントリー作成日時(ISO8601 フォーマット)",
"type": "string"
},
"modified_date": {
"description": "エントリー更新日時(ISO8601 フォーマット) ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"mime_type": {
"description": "ファイルのMimeType ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"file_size": {
"description": "ファイルサイズ(単位：byte) ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"document_type": {
"description": "ドキュメント種別（通常ドキュメント:'normal', ノート:'note'）※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"author": {
"description": "ドキュメントの著者名 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"title": {
"description": "ドキュメントのタイトル ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"total_page": {
"description": "ドキュメントのページ数 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"current_page": {
"description": "ドキュメントの直近で開かれていたページ番号 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"reading_date": {
"description": "ドキュメントの最終閲覧日時(ISO8601 フォーマット) ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"parent_folder_id": {
"description": "このエントリーが格納されているフォルダーのID
\n※ルートフォルダーの場合は'root'
\n※ルートフォルダーの親は存在しないので、その場合はnull",
"type": "string"
},
"is_new": {
"description": "エントリーが新規に追加されたものか 新規:'true',新規でない:'false'",
"type": "string"
},
"document_source": {
"description": "このエントリーを作成したクライアントの識別子 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"ext_id": {
"description": "外部ID",
"type": "string"
},
"file_hash": {
"description": "ドキュメントのファイルハッシュ（クライアント側で計算されたもの）。 ※entry_typeがフォルダーの場合はnull",
"type": "string"
},
"file_revision": {
"description": "ドキュメントのリビジョン（本体側で計算されたもの）。 ※entry_typeがフォルダーの場合はnull",
"type": "string"
}
}
},
"documentsPostRequest2": {
"type": "object",
"required": [
"parent_folder_id",
"file_name"
],
"properties": {
"parent_folder_id": {
"description": "作成先のフォルダーID ※ルートフォルダーは'root'と指定する",
"type": "string"
},
"file_name": {
"description": "作成するドキュメントのファイル名",
"type": "string"
},
"ext_id": {
"description": "外部ID",
"type": "string"
}
}
},
"documentsDocumentIdPutRequest2": {
"type": "object",
"properties": {
"parent_folder_id": {
"description": "変更後の親フォルダーのID ※NULLの場合は変更しない。ルートフォルダーは'root'と指定する。",
"type": "string"
},
"file_name": {
"description": "変更後のドキュメントのファイル名 ※NULLの場合は変更しない",
"type": "string"
},
"ext_id": {
"description": "変更後の外部ID ※NULLの場合は変更しない",
"type": "string"
}
}
},
"foldersPostRequest2": {
"type": "object",
"required": [
"parent_folder_id",
"folder_name"
],
"properties": {
"parent_folder_id": {
"description": "作成先のフォルダーID ※ルートフォルダーは'root'と指定する",
"type": "string"
},
"folder_name": {
"description": "作成するフォルダー名",
"type": "string"
},
"ext_id": {
"description": "外部ID",
"type": "string"
}
}
},
"foldersFolderIdPutRequest2": {
"type": "object",
"properties": {
"parent_folder_id": {
"description": "移動先のフォルダーID ※NULLの場合は変更しない。ルートフォルダーは'root'と指定する。",
"type": "string"
},
"folder_name": {
"description": "ドキュメントのファイル名 ※NULLの場合は変更しない",
"type": "string"
},
"ext_id": {
"description": "変更後の外部ID ※NULLの場合は変更しない",
"type": "string"
}
}
},
"viewerStatusCurrentViewingGetResult2": {
"type": "object",
"required": [
"views"
],
"properties": {
"orientation": {
"description": "画面の向き ['portlait'/'landscape']",
"type": "string"
},
"view_mode": {
"description": "表示モード ['single'/'double']",
"type": "string"
},
"views": {
"description": "各表示面情報のリスト",
"type": "array",
"items": {
"$ref": "#/definitions/viewerStatusViewInfo2"
}
}
}
},
"viewerStatusViewInfo2": {
"type": "object",
"required": [
"entry_id",
"entry_path",
"total_page",
"current_page",
"document_source",
"ext_id",
"display_mode"
],
"properties": {
"entry_id": {
"description": "ドキュメントのID",
"type": "string"
},
"entry_path": {
"description": "ドキュメントのフルパス ※ルートフォルダーは'Document/'と表現される",
"type": "string"
},
"title": {
"description": "ドキュメントのタイトル",
"type": "string"
},
"total_page": {
"description": "ドキュメントのページ数(整数値)",
"type": "string"
},
"current_page": {
"description": "ドキュメントの直近で開かれていたページ番号(整数値)",
"type": "string"
},
"document_source": {
"description": "このエントリーを作成したクライアントの識別子",
"type": "string"
},
"ext_id": {
"description": "外部ID",
"type": "string"
},
"position": {
"description": "画面内の表示位置 ['left'/'right'] ※表示モードが'single'の場合はNULL",
"type": "string"
},
"display_mode": {
"description": "ページ描画モード [単ページ:'single' / 見開き:'two_page_spread' / 俯瞰:'thumbnail']",
"type": "string"
},
"thumbnail_current_page": {
"description": "ページ描画モードに応じた基準のページ番号(整数値)",
"type": "string"
}
}
},
"viewerControlsOpenPutRequest2": {
"type": "object",
"required": [
"document_id"
],
"properties": {
"document_id": {
"description": "開く対象のドキュメントのID",
"type": "string"
},
"page": {
"description": "開くページ番号(整数値)",
"type": "string"
}
}
},
"viewerControlsOpenPutRequest2Confirm": {
"type": "object",
"required": [
"document_id"
],
"properties": {
"document_id": {
"description": "開く対象のドキュメントのID",
"type": "string"
},
"page": {
"description": "開くページ番号(整数値)",
"type": "string"
},
"confirm_dialog_params": {
"description": "表示する確認ダイアログの各種パラメーター",
"$ref": "#/definitions/twoButtonsDialogParametersObject"
}
}
},
"statusBatteryResult2": {
"type": "object",
"required": [
"level",
"icon_type",
"status",
"health",
"plugged",
"pen"
],
"properties": {
"level": {
"description": "バッテリー残量パーセンテージ (0～100)",
"type": "string"
},
"icon_type": {
"description": "バッテリーアイコンの種類 ['level_bar_0'/'level_bar_1'/'level_bar_2'/'level_bar_3'/'level_bar_4'/'charging'/'full']",
"type": "string"
},
"status": {
"description": "バッテリー状態 [充電中:'charging'/放電中:'discharging'/満タン:'full'/充電中でない:'not_charging'/不明:'unknown']",
"type": "string"
},
"health": {
"description": "バッテリーの健全性 [正常:'good'/過冷却:'cold'/過熱:'overheat'/過電圧:'over_voltage'/上がっている:'dead'/不明:'unknown'/予期せぬ状況:'unspecified_failure'",
"type": "string"
},
"plugged": {
"description": "電源供給手段 [ACアダプタ:'ac'/USB:'usb'/無線:'wireless'/なし:'not_plugged'",
"type": "string"
},
"pen": {
"description": "付属ペンのバッテリー残量パーセンテージ (0～100)",
"type": "string"
}
}
},
"indicationInfoObject2": {
"type": "object",
"required": [
"dialog_params"
],
"properties": {
"dialog_params": {
"description": "ダイアログ各種パラメーター",
"$ref": "#/definitions/dialogParametersObject"
},
"show_animation": {
"description": "処理中アニメーションを表示するか 表示する:'true', 表示しない:'false' (省略時'false')",
"type": "string"
}
}
},
"dialogParametersObject": {
"type": "object",
"required": [
"title",
"message",
"button_caption"
],
"properties": {
"title": {
"description": "ダイアログタイトル",
"type": "string"
},
"message": {
"description": "ダイアログに表示するメッセージ",
"type": "string"
},
"button_caption": {
"description": "非表示にするためのボタンの文字列",
"type": "string"
}
}
},
"twoButtonsDialogParametersObject": {
"type": "object",
"required": [
"title",
"message",
"positive_button_caption",
"negative_button_caption"
],
"properties": {
"title": {
"description": "ダイアログタイトル",
"type": "string"
},
"message": {
"description": "ダイアログに表示するメッセージ",
"type": "string"
},
"positive_button_caption": {
"description": "肯定的なリアクションをするためのボタンの文字列",
"type": "string"
},
"negative_button_caption": {
"description": "否定的なリアクションをするためのボタンの文字列",
"type": "string"
}
}
},
"documentAttributeObject2": {
"type": "object",
"properties": {
"action_entry": {
"description": "アクション項目情報のリスト",
"type": "array",
"items": {
"$ref": "#/definitions/actionEntryObject2"
}
},
"action_performer": {
"description": "アクション実行情報のリスト",
"type": "array",
"items": {
"$ref": "#/definitions/actionPerformerObject2"
}
}
}
},
"actionEntryObject2": {
"type": "object",
"required": [
"index",
"by_user"
],
"properties": {
"index": {
"description": "インデックス(整数値) ※項目表示順序に影響",
"type": "string"
},
"by_user": {
"description": "ユーザーが選択できるアクションの設定項目",
"$ref": "#/definitions/actionEntryByUserObject2"
},
"performers": {
"description": "アクション項目に対応するアクション実行情報のインデックスのリスト",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"actionEntryByUserObject2": {
"type": "object",
"required": [
"caption"
],
"properties": {
"caption": {
"description": "アクション一覧に表示する文字列",
"type": "string"
},
"confirm_dialog_params": {
"description": "アクション実行時に表示する確認ダイアログの各種パラメーター (省略時は確認を行わない)",
"$ref": "#/definitions/twoButtonsDialogParametersObject"
}
}
},
"actionPerformerObject2": {
"type": "object",
"required": [
"index"
],
"properties": {
"index": {
"description": "インデックス(整数値)",
"type": "string"
},
"request": {
"description": "HTTPリクエストを投げる場合の設定項目",
"$ref": "#/definitions/actionPerformerRequestObject2"
},
"indicate": {
"description": "各種通知用ダイアログを表示する場合の設定項目",
"$ref": "#/definitions/actionPerformerIndicateObject2"
},
"result": {
"description": "一連のアクションの成功や失敗を通知する場合の設定項目",
"$ref": "#/definitions/actionPerformerResultObject2"
}
}
},
"actionPerformerRequestObject2": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"description": "HTTPリクエストを投げるURL",
"type": "string"
},
"restrict": {
"description": "HTTPリクエストを投げている間、ユーザーの操作を制限するか 制限する:'true', 制限しない:'false' (省略時'false')",
"type": "string"
}
}
},
"actionPerformerIndicateObject2": {
"type": "object",
"required": [
"dialog_params"
],
"properties": {
"dialog_params": {
"description": "ダイアログの各種パラメーター",
"$ref": "#/definitions/dialogParametersObject"
},
"indication_id": {
"description": "ダイアログの識別子 (UUID 形式)",
"type": "string"
},
"show_animation": {
"description": "処理中アニメーションを表示するか 表示する:'true', 表示しない:'false' (省略時'false')",
"type": "string"
}
}
},
"actionPerformerResultObject2": {
"type": "object",
"properties": {
"success_dialog_params": {
"description": "一連のアクション実行が成功した際に表示するダイアログの各種パラメーター
省略時は成功してもダイアログを表示しない",
"$ref": "#/definitions/dialogParametersObject"
},
"failure_dialog_params": {
"description": "一連のアクション実行のどれかが失敗した際に表示するダイアログの各種パラメーター
省略時は失敗してもダイアログを表示しない",
"$ref": "#/definitions/dialogParametersObject"
}
}
},
"kittingRegisterCodeRequest": {
"type": "object",
"required": [
"host",
"register_code"
],
"properties": {
"host": {
"description": "DCSS の ホスト名 もしくは IPアドレス",
"type": "string"
},
"port": {
"description": "DCSS の Web API に HTTP アクセスするポート番号 (省略時80)",
"type": "string"
},
"register_code": {
"description": "DCSS 登録シーケンスで参照される登録コード",
"type": "string"
}
}
},
"transferWizardInfoObject": {
"type": "object",
"required": [
"wizard_id_list"
],
"properties": {
"wizard_id_list": {
"description": "ウィザード画面識別子の配列",
"type": "array",
"items": {
"type": "string"
}
},
"next_screen": {
"description": "ウィザードが終了した後に遷移する画面の情報",
"$ref": "#/definitions/transferWizardNextScreenInfoObject"
}
}
},
"transferWizardNextScreenInfoObject": {
"type": "object",
"properties": {
"document_open": {
"description": "ドキュメントを開く際のパラメーター",
"$ref": "#/definitions/viewerControlsOpenPutRequest2"
},
"documents_view": {
"description": "ドキュメント一覧画面に遷移する際のパラメーター",
"$ref": "#/definitions/documentsViewInfoObject"
},
"folder_view": {
"description": "フォルダー画面に遷移する際のパラメーター",
"$ref": "#/definitions/commonFolderIdObject"
}
}
},
"transferTimeoutInfoObject": {
"type": "object",
"required": [
"socket_timeout",
"transfer_loop_timeout"
],
"properties": {
"socket_timeout": {
"description": "ソケットの読み書きのタイムアウト時間 (秒単位) 1～3600",
"type": "string"
},
"transfer_loop_timeout": {
"description": "ファイル転送処理の進捗変化に対するタイムアウト時間 (秒単位) 1～3600",
"type": "string"
}
}
}
}
}