ワークフロー 管理者用マニュアル...r akumoワークフロー管理者マニュアル 7 この画面でワークフロー管理画面にアクセスするユーザー(ワークフロー管理者)を登録します。ワ
SPA Ver. 10.1 Web APIリファレンス...SPA製品ガイド...
Transcript of SPA Ver. 10.1 Web APIリファレンス...SPA製品ガイド...
目次
2
目次
目次 ..................................................................................................................................................... 2 本マニュアルについて .......................................................................................................................... 7 第 1 章 SPA Web API リファレンス ................................................................................................... 10
1 認証 ..................................................................................................................................................... 21 Auth Login .......................................................................................................................................... 22 Auth Logout ........................................................................................................................................ 24 Auth Password.................................................................................................................................... 25 Auth Password Change ...................................................................................................................... 27
2 検索 ..................................................................................................................................................... 29 Search Documents(Ver. 5) ............................................................................................................. 30 Search In-document .......................................................................................................................... 50 Search Cancel ..................................................................................................................................... 53
3 プレビュー .......................................................................................................................................... 54 Preview Get(Ver. 3) ........................................................................................................................ 55 Highlight Get(Ver. 2) ...................................................................................................................... 59
4 ダウンロード ....................................................................................................................................... 67 Download Document ......................................................................................................................... 68 Download Raw Document ................................................................................................................. 72 Download Print Document ................................................................................................................ 74 Download Packed Documents .......................................................................................................... 77 Download Packed Raw Documents .................................................................................................. 81 Download Packed Print Documents ................................................................................................. 84
5 ファイル操作 ....................................................................................................................................... 88 Documents Lookup ............................................................................................................................ 89 Documents List(Ver. 5) .................................................................................................................. 92 Documents Get(Ver. 5) ................................................................................................................ 104 Documents Image Verify .................................................................................................................. 115 Documents Rename ........................................................................................................................ 118 Documents Move List(Ver. 2) ...................................................................................................... 121 Documents Delete List ..................................................................................................................... 125 Documents History List ................................................................................................................... 129 Documents Restore .......................................................................................................................... 133
6 リンク操作 ........................................................................................................................................ 136 Links List Get .................................................................................................................................... 137 Links Create ...................................................................................................................................... 140
目次
3
Links Set ........................................................................................................................................... 145 7 マルチリンク ..................................................................................................................................... 152
Multi Links Page Get ......................................................................................................................... 153 Multi Links Set .................................................................................................................................. 156 Multi Links Update ........................................................................................................................... 160
8 文書のコメント ................................................................................................................................. 165 Documents Comments Get ............................................................................................................. 166 Documents Comments Add ............................................................................................................ 169
9 ページメモ ........................................................................................................................................ 171 PageMemo Get(Ver. 2) ................................................................................................................. 172 PageMemo Update ........................................................................................................................... 175
10 フォルダー操作 ............................................................................................................................... 179 Folders Lookup ................................................................................................................................ 180 Folders All(Ver. 2) ......................................................................................................................... 183 Folders List(Ver. 2) ....................................................................................................................... 187 Folders Open List(Ver. 2) ............................................................................................................. 191 Folders Get(Ver. 2) ....................................................................................................................... 198 Folders Info Get ................................................................................................................................ 201 Folders Create(Ver. 2) .................................................................................................................. 204 Folders Rename(Ver. 2) ............................................................................................................... 207
11 フォルダーショートカット ............................................................................................................. 211 Shortcuts List(Ver. 2) ................................................................................................................... 212 Shortcuts Create(Ver. 2) .............................................................................................................. 215 Shortcuts Rename ........................................................................................................................... 219 Shortcuts Delete ............................................................................................................................... 221
12 ごみ箱 ............................................................................................................................................. 223 Trashbox List(Ver. 3) .................................................................................................................... 224 Trashbox Restore .............................................................................................................................. 228 Trashbox Clear(Ver. 2) ................................................................................................................. 230
13 ユーザー情報操作 ........................................................................................................................... 232 Users Lookup .................................................................................................................................... 233 Users List(Ver. 2) .......................................................................................................................... 236 Users Group List(Ver. 2) ............................................................................................................... 241 Users Get(Ver. 2) .......................................................................................................................... 245 Users Authorities(Ver. 4) ............................................................................................................. 248 Users Create(Ver. 2) ..................................................................................................................... 253 Users Update(Ver. 2) .................................................................................................................... 258 Users Delete...................................................................................................................................... 262
目次
4
14 グループ情報操作 ........................................................................................................................... 264 Groups Lookup ................................................................................................................................. 265 Groups List(Ver. 2) ....................................................................................................................... 268 Groups Role List(Ver. 2) ............................................................................................................... 272 Groups Get(Ver. 2) ....................................................................................................................... 275 Groups Create(Ver. 2) .................................................................................................................. 278 Groups Update(Ver. 2) ................................................................................................................. 283 Groups Delete ................................................................................................................................... 288
15 ロール情報操作 ............................................................................................................................... 290 Roles Lookup .................................................................................................................................... 291 Roles List(Ver. 4) .......................................................................................................................... 294 Roles Get(Ver. 4) .......................................................................................................................... 300 Roles Create(Ver. 4) ..................................................................................................................... 305 Roles Update(Ver. 4) .................................................................................................................... 314 Roles Delete ...................................................................................................................................... 321
16 ドメイン情報操作 ........................................................................................................................... 323 Domains List(Ver. 2) .................................................................................................................... 324 Domains Create(Ver. 2)................................................................................................................ 330 Domains Update(Ver. 2) .............................................................................................................. 335 Domains Default Update ................................................................................................................. 340 Domains Delete ................................................................................................................................ 342
17 アクセス権 ...................................................................................................................................... 344 Permission Get(Ver. 3) ................................................................................................................. 345 Permission Update(Ver. 3) .......................................................................................................... 351
18 透かし設定 ...................................................................................................................................... 359 Watermark Get ................................................................................................................................. 360 Watermark Image Get ...................................................................................................................... 364 Watermark Update ........................................................................................................................... 366
19 暗号化設定 ...................................................................................................................................... 371 Encryption Get ................................................................................................................................. 372 Encryption Update ........................................................................................................................... 376
20 フォルダーへの文書管理ポリシー設定 ........................................................................................... 381 FolderPolicy Get(Ver. 2) ............................................................................................................... 382 FolderPolicy Update(Ver. 3) ........................................................................................................ 387
21 データの保存先情報取得 ................................................................................................................ 393 Storage Settings Get ........................................................................................................................ 394
22 カスタムプロパティ操作 ................................................................................................................ 398 Custom Properties List(Ver. 2) .................................................................................................... 399
目次
5
Custom Properties Create(Ver. 2) ............................................................................................... 405 Custom Property Documents Set.................................................................................................... 413 Custom Properties Update(Ver. 2) .............................................................................................. 417 Custom Properties Delete ................................................................................................................ 423 カスタムプロパティ一括更新用ファイルの書式 .............................................................................. 425
23 マスク情報取得 ............................................................................................................................... 429 Masks List ......................................................................................................................................... 430
24 レビューテンプレート情報取得 ...................................................................................................... 433 Review Templates List(Ver. 2) ..................................................................................................... 434
25 アーカイブ ...................................................................................................................................... 447 Archives Add(Ver. 2) ..................................................................................................................... 448
26 文書定義 .......................................................................................................................................... 457 DocType Lookup .............................................................................................................................. 458 DocType List(Ver. 2) ..................................................................................................................... 461 DocType Get(Ver. 2) ..................................................................................................................... 465 DocType Get(Ver. 3) ..................................................................................................................... 471 DocType Create(Ver. 2) ................................................................................................................ 477 DocType Create(Ver. 3) ................................................................................................................ 484 DocType Update(Ver. 3) .............................................................................................................. 491 DocType Update(Ver. 4) .............................................................................................................. 499 DocType Delete ................................................................................................................................ 507
27 タイムスタンプ操作 ........................................................................................................................ 509 Timestamp Verify ............................................................................................................................. 510
28 マスクの適用 ................................................................................................................................... 514 Mask Apply(Ver. 2) ....................................................................................................................... 515 Mask Apply Search Result ................................................................................................................ 520
29 SVF 検索フィールド ........................................................................................................................ 530 SearchFields List .............................................................................................................................. 531 SearchFields Get .............................................................................................................................. 537 SearchFields Parse PDF ................................................................................................................... 541 SearchFields Parse Form ................................................................................................................. 544
30 SVF 検索フィールドデータの CSV ファイル出力 ........................................................................... 547 Request Search Data Csv From Documents(Ver. 4) ................................................................... 548 Request Search Data Csv From Documents(Ver. 5) ................................................................... 555 Request Search Data Csv From Search Results(Ver. 4) .............................................................. 563 Request Search Data Csv From Search Results(Ver. 5) .............................................................. 581 Output Search Data Csv Status ....................................................................................................... 600 Output Search Data Csv Get ............................................................................................................ 604
目次
6
31 追跡記録 .......................................................................................................................................... 606 Records List(Ver. 2) ...................................................................................................................... 607
32 削除記録 .......................................................................................................................................... 613 DeleteRecords List(Ver. 3) ........................................................................................................... 614
33 証跡確認 .......................................................................................................................................... 618 Upload File Trail Get......................................................................................................................... 619 Trail Get............................................................................................................................................. 623 Trail Update ...................................................................................................................................... 626
34 セッション管理 ............................................................................................................................... 629 Session Current Get(Ver. 2) ......................................................................................................... 630
35 メンテナンスモード設定 ................................................................................................................ 632 Maintenance Mode Status Get......................................................................................................... 633 Maintenance Mode Status Update .................................................................................................. 635
36 サーバー情報の取得 ........................................................................................................................ 637 Config Version .................................................................................................................................. 638 Config Activation .............................................................................................................................. 643
37 フォルダーへの通知の設定 ............................................................................................................. 646 Event Notification Get ...................................................................................................................... 647 Event Notification Update ............................................................................................................... 660
38 ページ操作 ...................................................................................................................................... 666 Pages Rotate ..................................................................................................................................... 667
39 Bridge サービス設定 ....................................................................................................................... 671 Bridge Service Installer Get ............................................................................................................. 672
第 2 章 Web アプリケーションの拡張 ............................................................................................. 675 1 文書を指定してプレビュー画面を開く ............................................................................................. 676 2 フォルダーを指定してユーザー画面を開く ..................................................................................... 678 3 POST で送信されたログイン情報で自動ログインする .................................................................... 680
改訂履歴 ........................................................................................................................................... 681
本マニュアルについて
7
本マニュアルについて
本マニュアルは、SPA が提供する Web API のリファレンスです。
SPA が提供する Web API を使用すると、アプリケーションから SPA のさまざまな機能を利用することができ
ます。
▌マニュアルの体系
SPA には以下のマニュアルがあります。
マニュアル名 概要 対象読者
SPA 製品ガイド SPA を理解する上で必要な概念や、設定、運用に関する手
順について説明します。
開発者、システム管理者、
運用管理者
セットアップガイド SPA、および Bridge サービス、Document Converter のセ
ットアップ手順について説明します。
開発者、システム管理者
Web API リファレンス SPA が提供する Web API のリファレンスです。 開発者
Web 利用者操作ガイド SPA に保存されている文書を利用して、Web ブラウザー
から一般利用者が操作できることを説明します。
一般利用者
タブレット利用者ガイド SPA に保存されている文書を、タブレットから利用する手
順について説明します。
一般利用者
SPA Enterprise 設定ガイド SPA Enterprise の導入方法と設定、運用について説明しま
す。
開発者、システム管理者
シナリオで学ぶ機能活用 SPA でよく使われる機能の設定について、目的別にまとめ
たチュートリアルです。
開発者、システム管理者、
運用管理者
マイグレーションガイド 旧バージョンの SPA のデータを SPA Ver. 10.1 で利用する
ために必要な作業や、マイグレーションの仕様について説
明します。
開発者、システム管理者
本マニュアルについて
8
■ 対象読者
本マニュアルでは、対象読者となるユーザーを次のように定義しています。
ユーザー 説明
開発者 SPA の運用環境を作成するユーザー。
管理者 システム管理者 SPA のユーザー、グループの追加や定義類の作成など、アーカイブ前に必要な管理業務を行
うユーザー。主に、管理画面での設定を行う。
運用管理者 SPA でのアーカイブや、アーカイブされた文書類を業務の中で利用するための管理業務を行
うユーザー。主に、ユーザー画面での設定を行う。
一般利用者 SPA にアーカイブされた文書を Web ブラウザーおよびタブレットから利用するユーザー。
▌マニュアル内で使用する表記
マニュアル内で使用する表記について説明します。
■ 注意、参考、制限
マニュアル内では、注意、参考、制限を次のように区別して記載しています。
注意
操作によって元の状態に戻れなくなる場合や、元の状態に戻るのが難しい場合に、このパーツで示します。
参考
製品を使用する上での補足情報をこのパーツで示します。
制限事項
製品の制限をこのパーツで示します。
■ 記号
マニュアル内で使用する記号の意味は、次のとおりです。
記
号
表記例 意味
[] [ファイル]メニュー 製品画面に表示されている項目名やメニュー名を表します。OS や他
社製品の項目名やメニュー名も同様に表します。
<> http://<IP アドレスまたはサーバー名> URL やファイル名の一部など、環境によって変わる文字列を表しま
す。
本マニュアルについて
9
▌商標
本製品では、ABBYY 社の OCR エンジンを使用しています。
本製品では、EduLab 社の OCR サービスを使用しています。
本製品では、Cogent Labs 社の OCR サービス(別途有償)を使用しています。
本マニュアルに記載されている社名および商品名等の名称は、各社の商標または登録商標です。
▌著作権
(C) 2013 WingArc1st Inc. All rights reserved.
▌その他
本マニュアルの内容は予告なく変更することがあります。
▌発行
2018 年 6 月 29 日 初版
2019 年 3 月 29 日 第 4 版(Ver. 10.1.0.3 対応)
▌改訂履歴
マニュアル修正(誤記や誤解を招く表記の修正)の履歴については、下記のページを参照してください。
改訂履歴(P.681)
第 1 章 SPA Web API リファレンス
10
第 1 章 SPA Web API リファレンス
SPA Web API は、SPA の機能をユーザーアプリケーションで利用できる Web API として提供するものです。
本章では、提供する各 Web API の詳細を説明します。
▌使用例について
Web API の使用例については、製品添付のサンプルを参照してください。
なお、サンプルプログラムをコンパイルするには以下の指定が必要です。
• コンパイルオプションとして「-encoding UTF-8」を指定
• <INSTALL_DIR>¥archiver¥sample フォルダー内の以下の JAR ファイルをクラスパスに指定
(<INSTALL_DIR>は、SPA のインストール先のフォルダーです)
○ jackson-annotations-2.8.11.jar
○ jackson-core-2.8.11.jar
○ jackson-databind-2.8.11.1.jar
▌提供する Web API 一覧
提供する Web API は以下のとおりです。
Web API は、SPA 本体への機能の追加に応じて新たに追加されたり、バージョンがあがったりします。本
Web API リファレンスでは、複数のバージョンがある Web API については、SPA Ver. 10.0 以降で対応する
Web API のみを記載しています。ユーザーアプリケーションには、Ver. 9.3 でバージョンアップした Web API
も使用できますが、新機能(追加された機能)には対応しません。ユーザープログラムにおいて下記に記載
されていないバージョンの Web API を使用する場合は、Ver. 9.3 の Web API リファレンスを参照してくださ
い。
参考
アクセスログには、Web API のバージョンは出力されません。アクセスログについては、『SPA 製品ガイド』の「サー
バーの運用と設定」の「3-4 アクセスログ」を参照してください。
第 1 章 SPA Web API リファレンス
11
■ 認証
Web API 対応バージョン 概要
Auth Login(P.22) - SPA にログインします。
Auth Logout(P.24) - SPA からログアウトします。
Auth Password(P.25) - SPA へのログインパスワードを設定します。
Auth Password Change(P.27) - ログイン中のユーザーのパスワードを変更します。
■ 検索
Web API 対応バージョン 概要
Search Documents(Ver. 5)(P.30) - 検索項目を指定して、文書を検索します。
Search In-document(P.50) - 文書内を全文検索します。
Search Cancel(P.53) - 現在のセッションで実行中の検索処理を中止(キャンセ
ル)します。
■ プレビュー
Web API 対応バージョン 概要
Preview Get(Ver. 3)(P.55) - プレビュー用の画像を取得します。
Highlight Get(Ver. 2)(P.59) - 指定したページに対するハイライト用の注釈を取得します。
■ ダウンロード
Web API 対応バージョン 概要
Download Document(P.68) - 指定した単一のファイルをダウンロードします。
Download Raw Document(P.72) - 指定した単一のファイルを無加工ダウンロードしま
す。
Download Print Document(P.74) - 指定した単一の印刷用ファイルをダウンロードしま
す。
Download Packed Documents(P.77) - 指定した複数のファイルをダウンロードします。
Download Packed Raw Documents(P.81) - 指定した複数のファイルを無加工ダウンロードしま
す。
Download Packed Print Documents(P.84) - 指定した複数の印刷用ファイルをダウンロードしま
す。
第 1 章 SPA Web API リファレンス
12
■ ファイル操作
Web API 対応バージョン 概要
Documents Lookup(P.89) - ファイル名から ID を取得します。
Documents List(Ver. 5)(P.92) - 指定したフォルダー直下のファイル、リンク、フォルダ
ーの一覧を取得します。取得する情報は、パラメーター
で選択できます。
Documents Get(Ver. 5)(P.104) - 指定した文書の詳細情報(メタ情報)とカスタムプロパ
ティの情報を取得します。
Documents Image Verify(P.115) - PDF ファイルに埋め込まれている画像の解像度と色深度
を検証します。
Documents Rename(P.118) - ファイル名を変更します。
Documents Move List(Ver. 2)(P.121) - 指定したファイルとフォルダーをまとめて別のフォルダ
ーに移動します。
Documents Delete List(P.125) - 指定したファイルとフォルダーをまとめて削除します。
Documents History List(P.129) - 指定した文書のバージョン管理の履歴一覧を取得しま
す。
Documents Restore(P.133) - 指定したバージョンの文書に復元します。
■ リンク操作
Web API 対応バージョン 概要
Links List Get(P.137) - 指定された文書を参照しているリンクの一覧を取得します。
Links Create(P.140) - リンクの作成とカスタムプロパティ値の更新を行います。
Links Set(P.145) - 1 つの文書から複数のリンクを作成します。
■ マルチリンク
Web API 対応バージョン 概要
Multi Links Page Get(P.153) - マルチリンクのページ情報を取得します。
Multi Links Set(P.156) - マルチリンクを作成します。
Multi Links Update(P.160) - マルチリンクの構成を変更します。
第 1 章 SPA Web API リファレンス
13
■ 文書のコメント
Web API 対応バージョン 概要
Documents Comments Get(P.166) - 指定した文書のコメントを取得します。
Documents Comments Add(P.169) - 指定した文書にコメントを追加します。
■ ページメモ
Web API 対応バージョン 概要
PageMemo Get(Ver. 2)(P.172) - 指定したページのページメモの情報を取得します。
PageMemo Update(P.175) - 指定したページのページメモの情報を更新します。
■ フォルダー操作
Web API 対応バージョン 概要
Folders Lookup(P.180) - フォルダー名からフォルダーID を取得します。
Folders All(Ver. 2)(P.183) - すべてのフォルダー情報のリストを取得します。
Folders List(Ver. 2)(P.187) - 指定したフォルダー直下にあるフォルダーのリストを取得
します。
Folders Open List(Ver. 2)(P.191) - 指定したフォルダーまで展開したフォルダーのリストを取
得します。
Folders Get(Ver. 2)(P.198) - 指定したパスのフォルダー情報を取得します。
Folders Info Get(P.201) - 指定したフォルダー内に含まれるフォルダーやファイルな
どの概要情報を取得します。
Folders Create(Ver. 2)(P.204) - フォルダーを作成します。
Folders Rename(Ver. 2)(P.207) - フォルダーの名称を変更します。
■ フォルダーショートカット
Web API 対応バージョン 概要
Shortcuts List(Ver. 2)(P.212) - ログインしているユーザーのフォルダーショートカットの
一覧を取得します。
Shortcuts Create(Ver. 2)(P.215) - ログインしているユーザーのフォルダーショートカットを
作成します。
第 1 章 SPA Web API リファレンス
14
Web API 対応バージョン 概要
Shortcuts Rename(P.219) - ログインしているユーザーの、指定されたフォルダーショ
ートカットの名前を変更します。
Shortcuts Delete(P.221) - ログインしているユーザーの、指定されたフォルダーショ
ートカットを削除します。
■ ごみ箱
Web API 対応バージョン 概要
Trashbox List(Ver. 3)(P.224) - ログインしているユーザーのごみ箱にあるフォルダーおよび
ファイルの一覧を取得します。
Trashbox Restore(P.228) - ログインしているユーザーのごみ箱から、指定したフォルダ
ーまたはファイルを戻します。
Trashbox Clear(Ver. 2)(P.230) - ログインしているユーザーのごみ箱を空にします。
■ ユーザー情報操作
Web API 対応バージョン 概要
Users Lookup(P.233) - ドメイン名とユーザー名からユーザーID を取得します。
Users List(Ver. 2)(P.236) - ユーザー情報のリストを取得して返します。
Users Group List(Ver. 2)(P.241) - 指定されたグループに含まれるユーザー情報のリストを返
します。
Users Get(Ver. 2)(P.245) - 指定された対象ユーザーの内部 ID(ユーザーID)を持つユ
ーザーの情報を取得します。
Users Authorities(Ver. 4)(P.248) - 指定されたユーザーに許可されたすべての操作の権限 ID 番
号を取得します。
Users Create(Ver. 2)(P.253) - 指定されたユーザーを作成し、指定されたグループに登録
します。
Users Update(Ver. 2)(P.258) - 指定された内容でユーザー情報を更新します。
Users Delete(P.262) - 指定されたユーザーID を持つユーザー情報を削除します。
■ グループ情報操作
Web API 対応バージョン 概要
Groups Lookup(P.265) - ドメイン名とグループ名からグループの ID を取得します。
第 1 章 SPA Web API リファレンス
15
Web API 対応バージョン 概要
Groups List(Ver. 2)(P.268) - グループ情報のリストを取得して返します。
Groups Role List(Ver. 2)(P.272) - 指定されたロールが含まれるグループ情報のリストを返し
ます。
Groups Get(Ver. 2)(P.275) - 指定された ID を持つグループの情報を取得します。
Groups Create(Ver. 2)(P.278) - 指定されたグループを作成します。
Groups Update(Ver. 2)(P.283) - 指定された内容でグループ情報を更新します。
Groups Delete(P.288) - 指定された ID を持つグループの情報を削除します。
■ ロール情報操作
Web API 対応バージョン 概要
Roles Lookup(P.291) - ロール名からロールの ID を取得します。
Roles List(Ver. 4)(P.294) - カスタムロールの詳細情報のリストを取得して返します。
Roles Get(Ver. 4)(P.300) - 指定された ID を持つロールの情報を取得します。
Roles Create(Ver. 4)(P.305) - 指定されたロールを作成します。
Roles Update(Ver. 4)(P.314) - 指定された内容でロールの権限に関する情報を更新します。
Roles Delete(P.321) - 指定された ID を持つロールの情報を削除します。
■ ドメイン情報操作
Web API 対応バージョン 概要
Domains List(Ver. 2)(P.324) - ドメイン名のリストを取得します。
Domains Create(Ver. 2)(P.330) - ドメイン設定を作成します。
Domains Update(Ver. 2)(P.335) - 指定されたドメイン設定を更新します。
Domains Default Update(P.340) - デフォルトドメインの ID を設定します。
Domains Delete(P.342) - 指定されたドメイン設定を削除します。
■ アクセス権
Web API 対応バージョン 概要
Permission Get(Ver. 3)(P.345) - 指定したフォルダーのアクセス権の情報を取得します。
第 1 章 SPA Web API リファレンス
16
Web API 対応バージョン 概要
Permission Update(Ver. 3)(P.351) - 指定したフォルダーのアクセス権をすべてのグループおよ
びすべてのユーザーに一括して設定します。
■ 透かし設定
Web API 対応バージョン 概要
Watermark Get(P.360) - 指定したフォルダーの透かしに関する設定を取得します。
Watermark Image Get(P.364) - 指定したフォルダーに透かし画像が設定されていた場合、その画
像を取得します。
Watermark Update(P.366) - 指定したフォルダーに透かしを設定します。
■ 暗号化設定
Web API 対応バージョン 概要
Encryption Get(P.372) - 指定したフォルダーの暗号化設定に関する情報を取得します。
Encryption Update(P.376) - フォルダー内の PDF ファイルに適用するセキュリティ情報(パスワ
ード、暗号化など)を、フォルダーに設定します。
■ フォルダーへの文書管理ポリシー設定
Web API 対応バージョン 概要
FolderPolicy Get(Ver. 2)(P.382) - 指定したフォルダーの文書管理ポリシーの設定情報を取
得します。
FolderPolicy Update(Ver. 3)(P.387) - 指定した内容で、フォルダーの文書管理ポリシーの設定
を変更します。
■ データの保存先情報取得
Web API 対応バージョン 概要
Storage Settings Get(P.394) - データの保存先の設定情報を取得します。
■ カスタムプロパティ操作
Web API 対応バージョン 概要
Custom Properties List(Ver. 2)(P.399) - 存在するすべてのカスタムプロパティの構成情報
のリストを返します。
第 1 章 SPA Web API リファレンス
17
Web API 対応バージョン 概要
Custom Properties Create(Ver. 2)(P.405) - カスタムプロパティを作成します。
Custom Property Documents Set(P.413) - 指定した文書に対して、カスタムプロパティのす
べての値を更新します。
Custom Properties Update(Ver. 2)(P.417) - 指定されたカスタムプロパティの属性を変更しま
す。
Custom Properties Delete(P.423) - 指定されたカスタムプロパティを削除します。
■ マスク情報取得
Web API 対応バージョン 概要
Masks List(P.430) - マスク(マスクのパターン)の一覧を取得します。
■ レビューテンプレート情報取得
Web API 対応バージョン 概要
Review Templates List(Ver. 2)(P.434) - すべてのレビューテンプレートの情報を取得します。
■ アーカイブ
Web API 対応バージョン 概要
Archives Add(Ver. 2)(P.448) - 文書を指定したフォルダーにアーカイブします。
■ 文書定義
Web API 対応バージョン 概要
DocType Lookup(P.458) - 文書定義 ID から文書定義管理 ID(文書定義に自動で割り振
られる固有の ID)を取得します。
DocType List(Ver. 2)(P.461) - 文書定義の一覧を取得します。
DocType Get(Ver. 2)(P.465) - 指定した文書定義を取得します。
DocType Get(Ver. 3)(P.471) Ver. 10.1.0.3 指定した文書定義を取得します。
DocType Create(Ver. 2)(P.477) - 指定した文書定義を作成します。
DocType Create (Ver. 3)(P.484) Ver. 10.1.0.3 指定した文書定義を作成します。
第 1 章 SPA Web API リファレンス
18
Web API 対応バージョン 概要
DocType Update(Ver. 3)(P.491) - 指定した文書定義の内容を更新します。また、その文書定
義に属するすべての SVF 検索フィールドの情報も一括で更
新します。
DocType Update(Ver. 4)(P.499) Ver. 10.1.0.3 指定した文書定義の内容を更新します。また、その文書定
義に属するすべての SVF 検索フィールドの情報も一括で更
新します。
DocType Delete(P.507) - 指定した文書定義を削除します。また、その文書定義に属
する SVF 検索フィールドもすべて削除されます。
■ タイムスタンプ操作
Web API 対応バージョン 概要
Timestamp Verify(P.510) - 指定した文書に対してタイムスタンプのベリファイを実行します。
■ マスクの適用
Web API 対応バージョン 概要
Mask Apply(Ver. 2)(P.515) - マスク(マスクのパターン)または任意の矩形情報を指定し
て、マスクを文書に適用します。
Mask Apply Search Result(P.520) - 検索条件に合致した部分にマスクを適用します。
■ SVF 検索フィールド
Web API 対応バージョン 概要
SearchFields List(P.531) - 指定した条件に合致する SVF 検索フィールドの一覧を取得しま
す。
SearchFields Get(P.537) - 指定した条件に合致する SVF 検索フィールドを取得します。
SearchFields Parse PDF(P.541) - PDF ファイルを解析して SVF 検索フィールドを取得します。
SearchFields Parse Form(P.544) - 様式ファイルを解析して SVF 検索フィールドを取得します。
■ SVF 検索フィールドデータの CSV ファイル出力
Web API 対応バージョン 概要
Request Search Data Csv From
Documents(Ver. 4)(P.548)
- 指定した文書内にある SVF 検索フィールドデータを対象とし
て、CSV データの作成を依頼します。
第 1 章 SPA Web API リファレンス
19
Web API 対応バージョン 概要
Request Search Data Csv From
Documents(Ver. 5)(P.555)
Ver. 10.1 指定した文書内にある SVF 検索フィールドデータを対象とし
て、CSV データの作成を依頼します。
Request Search Data Csv From
Search Results(Ver. 4)(P.563)
- 検索でヒットした文書内にある SVF 検索フィールドデータを
対象として、CSV データの作成を依頼します。
Request Search Data Csv From
Search Results(Ver. 5)(P.581)
Ver. 10.1 検索でヒットした文書内にある SVF 検索フィールドデータを
対象として、CSV データの作成を依頼します。
Output Search Data Csv
Status(P.600)
- ログインしているユーザーの CSV データ作成状況の一覧を取
得します。
Output Search Data Csv
Get(P.604)
- 指定した受付番号に対応する、SVF 検索フィールドデータの
CSV ファイル(ZIP ファイルに圧縮されたもの)を取得しま
す。
■ 追跡記録
Web API 対応バージョン 概要
Records List(Ver. 2)(P.607) - 指定された文書の追跡記録を取得します。
■ 削除記録
Web API 対応バージョン 概要
DeleteRecords List(Ver. 3)(P.614) - 削除履歴の一覧を取得します。
■ 証跡確認
Web API 対応バージョン 概要
Upload File Trail Get(P.619) - PDF ファイルをアップロードし、埋め込まれている証跡情報を取
得します。
Trail Get(P.623) - ダウンロード時に埋め込む証跡情報に関する設定値を取得します。
Trail Update(P.626) - ダウンロード時に埋め込む証跡情報について設定します。
■ セッション管理
Web API 対応バージョン 概要
Session Current Get(Ver. 2)(P.630) - 現在ログイン中のユーザーに関するセッション情報を取得
します。
第 1 章 SPA Web API リファレンス
20
■ メンテナンスモード設定
Web API 対応バージョン 概要
Maintenance Mode Status Get(P.633) - メンテナンスモードの状態を取得します。
Maintenance Mode Status Update(P.635) - メンテナンスモードの状態を更新します。
■ サーバー情報の取得
Web API 対応バージョン 概要
Config Version(P.638) - SPA(アーカイブサーバー、Web サーバー、検索サーバー、Loader サ
ーバー)のバージョンを取得します。
Config Activation(P.643) - SPA のアクティベーション情報を取得します。
■ フォルダーへの通知の設定
Web API 対応バージョン 概要
Event Notification Get(P.647) - 指定したフォルダーの通知の設定を取得します。
Event Notification Update(P.660) - 指定したフォルダーの通知の設定を変更します。
■ ページ操作
Web API 対応バージョン 概要
Pages Rotate(P.667) - 指定したページの回転について設定します。
■ Bridge サービス設定
Web API 対応バージョン 概要
Bridge Service Installer Get(P.672) - 指定した Bridge サービスのインストーラーを取得します。
第 1 章 SPA Web API リファレンス
21
1 認証 認証に関する API は、次のとおりです。
• Auth Login(P.22)
• Auth Logout(P.24)
• Auth Password(P.25)
• Auth Password Change(P.27)
第 1 章 SPA Web API リファレンス
22
Auth Login SPA にログインします。
URI
http://<hostname>:44230/spa/service/auth/login
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
user ユーザー名
domain ドメイン名 未指定の場合は「local」が指定されたものとします。
password ログインパスワード
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-User ログインしたユーザーID 値は URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
第 1 章 SPA Web API リファレンス
23
HTTP ステータス エラーコード 備考
401 -1 ユーザー認証に失敗した場合に出力されます。
401 -3 自動ログインでのユーザー認証に失敗した場合に出力されます。自動ログイ
ンのためのユーザー認証情報が不正な場合です。
403 -20012 ログイン済みの状態で別のユーザーID を使ってログインしようとした場合に
出力されます。
403 -9800 ライセンスエラーが発生した場合に出力されます。
403 -9801 ライセンスの有効期限切れの場合に出力されます。
403 -9803 タブレットオプションがないにもかかわらず、タブレットからログインしよ
うとした場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
24
Auth Logout SPA からログアウトします。
URI
http://<hostname>:44230/spa/service/auth/logout
HTTP メソッド
POST
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-User ログアウトしたユーザーID 値は URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
25
Auth Password SPA へのログインパスワードを設定します。
URI
http://<hostname>:44230/spa/service/auth/password/<id>
• キー
キー 必須 値 備考
id 変更対象のユーザーの内部 ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
password 新しいログインパスワード
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
26
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -11 ログイン済みのユーザーがログイン状態のまま削除された場合に出力されま
す。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20014 次のいずれかの場合に発生します。
• パスワードの指定がない場合
• パスワードに使用できない文字を指定した場合
• パスワードに使用可能な長さを超えた場合
400 -20505 ユーザーID が指定されていない場合に出力されます。ユーザーID に負の値が
指定された場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500
Internal Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
27
Auth Password Change ログイン中のユーザーのパスワードを変更します。
URI
http://<hostname>:44230/spa/service/auth/password
HTTP メソッド
PUT
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
password 現在のログインパスワード
newPassword 新しいログインパスワード
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
28
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
400 -1 ユーザー認証に失敗した場合に出力されます。現在のログインパスワードの指定
が間違っている場合です。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。本 API では、ロ
グイン中のユーザーが「ユーザープロファイル」の操作権限がない場合に出力さ
れます。
400 -11 ログイン済みのユーザーがログイン状態のまま削除された場合に出力されます。
本 API では、ログイン中のユーザーが削除された場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20014 次のいずれかの場合に発生します。
• パスワードの指定がない場合
• パスワードに使用できない文字を指定した場合
• パスワードに使用可能な長さを超えた場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
29
2 検索 検索に関する API は、次のとおりです。
• Search Documents(Ver. 5)(P.30)
• Search In-document(P.50)
• Search Cancel(P.53)
第 1 章 SPA Web API リファレンス
30
Search Documents(Ver. 5) 検索項目を指定して、文書を検索します。
URI
http://<hostname>:44230/spa/service/search_v5/<id>
• キー
キー 必須 値 備考
id 検索対象フォルダーの ID
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"searchWord": "type == 1",
"operator": "AND",
"recursive": true,
"conditions": [
{
"conditionType": "system",
"name": "name",
"value": "document.pdf",
"type": "equals"
},
{
"conditionType": "system",
第 1 章 SPA Web API リファレンス
31
オブジェクトの例(JSON 形式)
"name": "filetype",
"value": "file"
},
...
{
"conditionType": "custom",
"id": "1",
"value": "true"
},
{
"conditionType": "custom",
"id": "2",
"value": "text",
"type": "equals"
},
...
{
"conditionType": "svfField",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "date",
"dateFormat": 1,
"from": "19700101090000",
"to": "19700101180000",
"offset": "9"
},
{
"conditionType": "svfField",
"name": "field2",
"docTypeId": "1",
"formName": "form1",
"dataType": "date",
第 1 章 SPA Web API リファレンス
32
オブジェクトの例(JSON 形式)
"dateFormat": 1,
"anyValue": true
},
{
"conditionType": "svfField",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "numeric",
"min": "1",
"max": "10"
},
...
{
"conditionType": "details",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "date",
"dateFormat": 1,
"offset": "9",
"detailsConditions": [
{
"from": "19700101090000",
"to": "19700101180000"
},
{
"from": "19710101090000",
"to": "19710101180000"
},
...
]
},
第 1 章 SPA Web API リファレンス
33
オブジェクトの例(JSON 形式)
{
"conditionType": "details",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "numeric",
"detailsConditions": [
{
"min": "1",
"max": "10",
},
{
"min": "100",
"max": "110",
},
...
]
},
...
{
"conditionType": "pageContent",
"name": "annotation",
"value": "annotation text",
"type": "contains",
"exact": "true"
}
...
],
"properties": [
"name",
"docpath",
"hitpages",
...
第 1 章 SPA Web API リファレンス
34
オブジェクトの例(JSON 形式)
],
"customProperties": [
"1",
"2",
...
]
}
■ データ内容
• 指定する要素の種類
キー 必須 値 備考
searchWord (*1) 文字列 全文検索の対象となる文字列を指定します。
operator AND conditions 要素の各検索条件の連結方法を「すべてに一致」とし
ます。
指定されていない場合は、AND が指定されたものとします。
OR conditions 要素の各検索条件の連結方法を「いずれかに一致」と
します。
recursive true サブフォルダーも検索します。
指定されていない場合は、true が指定されたものとします。
false サブフォルダーは検索しません。
conditions (*1) 各検索条件のリスト
検索条件の種類は、conditionType の値で指定します。
• system
文書プロパティ
• custom
カスタムプロパティ
• svfField
SVF 検索フィールド
• details
明細検索
第 1 章 SPA Web API リファレンス
35
キー 必須 値 備考
• pageContent
ページコンテンツ(注釈、ページメモ)
properties 検索結果で取得するシステムプロパティの項目のリスト
指定されていない場合は、すべてのシステムプロパティを取得し
ます。
customProperties 検索結果で取得するカスタムプロパティの ID のリスト
指定がない場合は取得しません。
*1 どちらか 1 つの指定が必須です。
• 文書プロパティの検索条件の指定方法について
文書プロパティの検索条件で指定する name キーの値は、次のとおりです。
name キーの値 詳細条件の種類 備考
name ファイル名 value キーに検索の対象となる文字列を指定します。
filetype 種類 value キーを指定します。指定できるキーは次のとおりです。
指定されていない場合は、file が指定されたものとします。
• file
PDF ファイルと PDF ファイル以外のファイルです。
• link
リンク
• pagelink
ページリンク
• multilink
マルチリンク
archivedate 初回アーカイブの
日時
日時の開始と終了、または、いずれか一方を指定できます。
archiveuser 初回アーカイブし
たユーザーの ID
value キーに検索の対象となる文字列を指定します。
updatedate アーカイブ(上書
きアーカイブ含
む)された日時
日時の開始と終了、または、いずれか一方を指定できます。
第 1 章 SPA Web API リファレンス
36
name キーの値 詳細条件の種類 備考
updateuser アーカイブ(上書
きアーカイブ含
む)したユーザー
の ID
value キーに検索の対象となる文字列を指定します。
pagecount ページ数 数値の最小値と最大値、または、いずれか一方を指定できま
す。
size ファイルサイズ
(KB)
数値の最小値と最大値、または、いずれか一方を指定できま
す。
title タイトル value キーに検索の対象となる文字列を指定します。
subject サブタイトル value キーに検索の対象となる文字列を指定します。
keywords キーワード value キーに検索の対象となる文字列を指定します。
author PDF 作成者 value キーに検索の対象となる文字列を指定します。
creator 作成アプリケーシ
ョン
value キーに検索の対象となる文字列を指定します。
producer PDF 変換 value キーに検索の対象となる文字列を指定します。
createdate PDF 作成日時 日時の開始と終了、または、いずれか一方を指定できます。
modifydate PDF 更新日時 日時の開始と終了、または、いずれか一方を指定できます。
doctype_id 文書定義管理 ID value キーに検索の対象となる文書定義管理 ID を指定します。
comment 文書のコメント value キーに検索の対象となる文字列を指定します。
review_status レビューステータ
ス
value キーに次の文字列で指定します。
• 0
起票前
• 1
起票
• 2
処理中
• 3
完了
annotation_existence 注釈の有無 true、false のいずれか一方を指定できます。
• true
注釈がある
第 1 章 SPA Web API リファレンス
37
name キーの値 詳細条件の種類 備考
• false
注釈がない
選択した name キーによって、検索条件として指定できるキーは異なります。「 」は、指定できるこ
とを示します。「 」については「type キー(P.38)」を参照してください。空欄は指定できないことを
示します。
name キーの値 指定可能なキー
value from to min max type exact empty
name
filetype
archivedate
archiveuser
updatedate
updateuser
pagecount
size
title
subject
keywords
author
creator
producer
createdate
modifydate
doctype_id
comment
review_status
annotation_existence
第 1 章 SPA Web API リファレンス
38
○ from/to キー
日時指定のフォーマットは、DateFormat クラスで解析可能な「yyyy-MM-dd'T'HH:mm:ss.SSSZ」
形式で記述してください。
例
2016-07-17T07:25:48.000+0900
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
• SVF 検索フィールドの検索条件の指定方法について
SVF 検索フィールドの検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定
します。
name キーの値 dataType キーの値 備考
SVF 検索フィールド
の検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できま
す。
第 1 章 SPA Web API リファレンス
39
name キーの値 dataType キーの値 備考
text value キーに検索の対象となる文字列を指定します。
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定可能なキーは異なります。「 」は、指定できることを示し
ます。「 」については「type キー(P.39)」を参照してください。空欄は指定できないことを示しま
す。
dataType
キーの値
指定可能なキー
docTypeId formName from to min max value type dateFormat exact offset anyValue
numeric
text
date
○ docTypeID キー
SVF 検索フィールドの検索において利用する文書定義管理 ID を指定します。docTypeId キー自体
を記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された
場合は、文書定義管理 ID の指定なしとして検索します。また、値に null が指定された場合は、文
書定義管理 ID の横断検索を行います。
○ formName キー
SVF 検索フィールドの検索において利用する様式ファイル名を指定します。formName キー自体を
記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された場
合は、様式ファイル名の「指定なし」として検索します。また、値に null が指定された場合は、様
式ファイル名の横断検索を行います。
○ from/to キー(SVF 検索フィールドの検索条件)
日時指定のフォーマットについては、「dateFormat キー(P.40)」を参照してください。文書プロパ
ティの日時指定と異なるので注意が必要です。
○ min/max キー(SVF 検索フィールドの検索条件)
指定可能な数値の範囲は、-9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)です。
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
第 1 章 SPA Web API リファレンス
40
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ dateFormat キー
from キーや to キーの値を指定する際のフォーマットを指定します。以下の 1 から 7 までの 7 種類
の数値が指定できます。この値は、検索対象の SVF 検索フィールドの日付のフォーマットと一致し
ている必要があります。
指定できる値 備考
1 yyyyMMddHHmmss(年月日時分秒)
2 yyyyMMddHHmm(年月日時分)
3 yyyyMMdd(年月日)
4 MMddHHmm(月日時分)
5 MMdd(月日)
6 HHmmss(時分秒)
7 HHmm(時分)
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
SVF 検索フィールドでは常に値が存在するため、「値が存在しないこと」を条件とする empty キー
は指定できません。
第 1 章 SPA Web API リファレンス
41
○ offset キー
SVF 検索フィールドの dataType キーの値が「date」の場合、かつ、dateFormat キーの値が「1」
または「2」のとき(つまり、年月日時分秒または年月日時分を使った日時検索のとき)、指定した
日時にタイムゾーンも考慮して検索を行いたい場合に指定します。
指定できる値は、協定世界時との差(UTC offset)の数値(-12 から 14 まで)です。
■ 指定例
▫ 日本は、UTC +9:00 なので「offset=9」
▫ ベネズエラは、UTC -4:30 なので「offset=-4.5」
▫ ニュージーランドのチャタム諸島は、UTC +12:45 なので、「offset=12.75」
■ 詳細説明
SVF 検索フィールドの日付型のデータには、内部的に「タイムゾーンつき」のデータと「タイム
ゾーンなし」のデータの 2 種類が存在しています。offset キーを指定しない場合は、「タイムゾ
ーンなし」の日付型データのみを検索対象とし、offset キーを指定すると、「タイムゾーンな
し」と「タイムゾーンつき」の両方の日付型データを検索対象とします。
■ 検索例
▫ offset キーなし
from="20141011103000" to="20141022235959" (2014 年 10 月 11 日 10 時 30 分 00 秒か
ら 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンなし」のデー
タから上記の期間に該当するデータを抽出します。
▫ offset キーつき
from="20141011103000" to="20141022235959" offset="9" (2014 年 10 月 11 日 10 時 30
分 00 秒から 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンな
し」のデータから上記の期間に該当するデータを抽出し、「タイムゾーンつき」のデータから
も上記の期間に該当するデータを抽出します。
日本標準時(JST)の「2014-10-22T23:59:59.000+0900」(「2014-10-22T14:59:59.000+0000」
と同じ)で登録されている「タイムゾーンつき」データが抽出されます。
米国カリフォルニア(太平洋標準時(PST))の「2014-10-22T06:59:59.000-0800」(「2014-10-
22T14:59:59.000+0000」と同じ)で登録されている「タイムゾーンつき」データが抽出され
ます。
○ anyValue キー
指定可能な値は「true」のみです。
第 1 章 SPA Web API リファレンス
42
指定された項目に値が存在するものを抽出します。「true」に指定された場合には、他の検索用キー
の指定の有無にかかわらず、値の有無だけが抽出の条件となります。
• 明細検索の検索条件の指定方法について
明細検索の検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定します。基
本的には SVF 検索フィールドと同様のキーを指定しますが、検索条件に関する部分については
detailsConditions キーの値として複数指定できます。
name キーの値 dataType キーの値 備考
SVF 検索フィールド
の検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できま
す。
text value キーに検索の対象となる文字列を指定します。
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定できるキーが異なります。「 」は、指定できることを示し
ます。空欄は指定できないことを示します。
dataType キーの
値
指定可能なキー
docTypeId formName dateFormat offset datailsConditions
numeric
text
date
○ detailsConditions キー
detailsConditions キーには、検索条件をリストで指定します。detailsConditions キー内に指定す
るキーは、次のとおりです。
「 」は、指定できることを示します。「 」については「type キー(P.39)」を参照してください。
空欄は指定できないことを示します。
dataType キーの値 指定可能なキー
from to min max value type exact
numeric *1
text *2
date *3
■ *1 数値の最小値と最大値、または、いずれか一方を指定できます。
■ *2 value キーに検索の対象となる文字列を指定します。
第 1 章 SPA Web API リファレンス
43
■ *3 日時の開始と終了、または、いずれか一方を指定できます。
• カスタムプロパティの検索条件の指定方法について
カスタムプロパティの検索条件で指定する id キーの値には、カスタムプロパティのデータの型を指定
します。
id キーの値 カスタムプロパティのデータの
型
備考
カスタムプロ
パティ ID
数値型 数値の最小値と最大値、または、いずれか一方を指定で
きます。
文字列型 value キーに検索の対象となる文字列を指定します。
日付型 日時の開始と終了、または、いずれか一方を指定できま
す。
Boolean 型 true/false のどちらかを指定できます。
ハイパーリンク型 value キーに検索の対象となる文字列を指定します。
選択したカスタムプロパティのデータの型により、指定できるキーは異なります。「 」は、指定でき
ることを示します。「 」については「type キー(P.44)」を参照してください。空欄は指定できないこ
とを示します。
カスタムプロパティのデータの型 指定可能なキー
from to min max value type exact empty
数値型
文字列型
日付型
Boolean 型
ハイパーリンク型
○ from/to キー
日付指定のフォーマットについては、「dateFormat キー(P.40)」を参照してください。文書プロパ
ティの日時指定と異なるので注意が必要です。
○ min/max キー
数値型の種類により指定可能な範囲は異なります。
数値の種類 指定可能な範囲
整数のみの数値 -9,223,372,036,854,775,808~9,223,372,036,854,775,807
第 1 章 SPA Web API リファレンス
44
数値の種類 指定可能な範囲
小数を含んだ数値 -9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)
小数点には「.(ピリオド)」のみ使用できます。
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
• ページコンテンツの検索条件の指定方法について
ページコンテンツの検索条件で指定する name キーの値は、次のとおりです。
name キーの
値
検索対象 備考
annotation 注釈 value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指
定した文字列そのもので検索します。
pagememo ページメモ value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指
定した文字列そのもので検索します。
第 1 章 SPA Web API リファレンス
45
選択した name キーによって、検索条件として指定できるキーは異なります。「 」は、指定できる
ことを示します。空欄は指定できないことを示します。
name キーの値 指定可能なキー
value type exact empty
annotation
pagememo
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
46
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在
しなかった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新
をしようとした場合に出力されます。
400 -700 検索実行時、プレビューでのハイライト表示時、検索データ作成時に何らか
のエラーが発生した場合に出力されます。
400 -701 検索結果が管理画面の[最大検索ファイル数]の設定値を超える場合に出力
されます。
204 -702 検索処理を中止した(検索がユーザーによりキャンセルされた)場合に出力
されます。
400 -705 検索の際、ヒット数が多すぎる場合に出力されます。
400 -707 全文検索機能がオフに設定されている状態で、全文検索または文書内検索を
実行しようとした場合に発生します。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
47
HTTP ステータス エラーコード 備考
400 -20703 全文検索の検索条件に 1,025 バイト以上の文字を指定した場合、または、文
書内検索の検索条件に 257 バイト以上の文字列を指定した場合に出力されま
す。
400 -20705 全文検索の対象となる文字列の指定に問題がある場合に出力されます。
400 -20706 検索条件の指定において、括弧の使い方が正しくない場合に出力されます。
400 -20707 検索条件の指定において、ダブルクォーテーションが閉じられていない場合
に出力されます。
400 -20708 検索条件の指定において、演算子の位置が誤っている場合に出力されます。
400 -20709 全文検索以外の検索文字列で最大文字数(256)を超えている、検索条件の指
定が 1 つもないなどの場合に出力されます。たとえば、以下のような場合に
出力されます。
• 「最小値」に「最大値」よりも大きな値が指定されている場合
• 日時の指定形式に誤りがある場合
• 256 字を超える文字を指定している場合(全文検索を除く)
• 正しい検索条件が 1 つも指定されていない場合
• カスタムプロパティの数値型の種類と合わない指定がされている場合
• 「detailsConditions」キーが指定されていない場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。指定された日付のフ
ォーマット(dateFormat キー)の値と、指定された日時の組み合わせが正し
くない場合などです。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"resultList": [
{
第 1 章 SPA Web API リファレンス
48
出力例(JSON 形式)
"type": "document",
"id": "10",
"parentId": "2",
"properties": {
"name": "document.pdf",
"author": "hayami.y",
"hitpages": "1,2"
},
"linkId": "1",
"propertyEntityVersion": 2,
"documentEntityVersion": 1,
"annotationEntityVersion": 1,
"pagememoEntityVersion": 1,
"svffieldEntityVersion": 1,
"customProperties": {
"1": "document.pdf",
"2": 1
}
},
{
"type": "document",
"id": "2",
"parentId": "1",
"properties": {
"name": "document2.pdf",
"author": "hasegawa.k",
"hitpages": "2,5"
},
"linkId": "1",
"propertyEntityVersion": 2,
"documentEntityVersion": 1,
"annotationEntityVersion": 1,
"pagememoEntityVersion": 1,
第 1 章 SPA Web API リファレンス
49
出力例(JSON 形式)
"svffieldEntityVersion": 1,
"customProperties": {
"1": "document2.pdf",
"2": "2"
}
}
]
}
■ データ内容
• resultList に検索結果の文書情報がリストで含まれます。文書情報は、「Documents Get(Ver. 5)
(P.104)」の結果と同様です。
• properties 内の hitpages の値に、ヒットしたページ情報がカンマ区切りで設定されます。設定される
値については「指定可能なプロパティ情報の項目名(P.93)」を参照してください。
• 数値型のカスタムプロパティの値は文字列で返します。
第 1 章 SPA Web API リファレンス
50
Search In-document 文書内を全文検索します。
URI
http://<hostname>:44230/spa/service/search/documents/<id>
• キー
キー 必須 値 備考
id 検索対象文書の ID
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
searchWord 検索対象となる文字列
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
51
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -700 検索実行時、プレビューでのハイライト表示時、検索データ作成時に何らかのエ
ラーが発生した場合に出力されます。
400 -705 検索の際、ヒット数が多すぎる場合に出力されます。
400 -707 全文検索機能がオフに設定されている状態で、全文検索または文書内検索を実行
しようとした場合に発生します。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20703 全文検索の検索条件に 1,025 バイト以上の文字を指定した場合、または、文書内
検索の検索条件に 257 バイト以上の文字列を指定した場合に出力されます。
400 -20705 全文検索の対象となる文字列の指定に問題がある場合に出力されます。
400 -20706 検索条件の指定において、括弧の使い方が正しくない場合に出力されます。
400 -20707 検索条件の指定において、ダブルクォーテーションが閉じられていない場合に出
力されます。
400 -20708 検索条件の指定において、演算子の位置が誤っている場合に出力されます。
400 -20709 全文検索の際に指定する文字列が空文字や null の場合など、全文検索以外の検索
文字列で最大文字数(256)を超えている、検索条件の指定が 1 つもないなどの
場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
52
▌出力例
出力例(JSON 形式)
{
"resultPages": [
1,
2,
3
]
}
■ データ内容
キー 値 備考
resultPages 検索条件にヒットしたページ情報のリスト
第 1 章 SPA Web API リファレンス
53
Search Cancel 現在のセッションで実行中の検索処理を中止(キャンセル)します。
URI
http://<hostname>:44230/spa/service/search/cancel
HTTP メソッド
GET
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
54
3 プレビュー プレビューに関する API は、次のとおりです。
• Preview Get(Ver. 3)(P.55)
• Highlight Get(Ver. 2)(P.59)
第 1 章 SPA Web API リファレンス
55
Preview Get(Ver. 3) プレビュー用の画像を取得します。
URI
http://<hostname>:44230/spa/service/preview_v3/<id>/<page>
• キー
キー 必
須
値 備考
id 取得対象文書の ID
page ページ番号 指定がない場合または、0 以下が指定された場合は先頭ページになります。
HTTP メソッド
GET
▌パラメーター
キー 必須 値 備考
version 取得対象となる文
書のバージョン
文書がバージョン管理対象の場合に指定します。version キー自体の指定が
ない場合は、最新バージョンが指定されたものとします。
rotateType 取得対象となるペ
ージの回転につい
ての情報
取得する文書のページの回転についての情報を指定します。指定した値に応
じて、回転した状態のプレビュー画像が取得されます。
値として、アーカイブ直後の文書のページを基準にした絶対値を指定しま
す。一度保存した状態からの相対値ではありません。なお、メジャーバージ
ョンアップした場合は、バージョンアップ直後のページが基準となります。
値 説明
(なし) 保存されている情報を利用する
0 基準から変更なし/基準に戻す
1 時計回りで 90 度加えた角度(右へ 90 度回転)
2 時計回りで 180 度加えた角度(180 度回転)
3 時計回りで 270 度加えた角度(左へ 90 度回転)
第 1 章 SPA Web API リファレンス
56
▌その他の注意事項
• ログインしている必要があります。
• Highlight Get(指定したページに対するハイライト用の注釈を取得する API)は、ページの回転に対応
していません。このためページを回転した文書に対しハイライトを行う場合は、ユーザープログラム
でページの回転角度を考慮してハイライトの位置を変換する必要があります。
ハイライトの回転を考慮する必要があるのは、次の場合です。
○ Preview Get で回転角度を指定して取得した画像にハイライトする場合
○ ページを回転して保存した文書に対し、Preview Get で取得した画像にハイライトする場合
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type image/png
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-Preview-Width 指定したページの幅 単位はポイント(72dpi)です。
X-Spa-Preview-Height 指定したページの高さ 単位はポイント(72dpi)です。
X-Spa-Preview-Dpi プレビュー画像の解像度
X-Spa-Page-RotateType 基準からの回転についての情報 アーカイブ直後の文書のページを基準にした以下の値で
す。
• 0
情報がない
• 1
時計回りで 90 度回転(右へ 90 度回転)
• 2
時計回りで 180 度回転(180 度回転)
• 3
時計回りで 270 度回転(左へ 90 度回転)
第 1 章 SPA Web API リファレンス
57
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
500 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問
題がある場合に出力されます。
500 -102 PDF ファイルが暗号化されているため解析できない場合、または、復号時の
ファイル操作でエラーが発生した場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
404 -413 マルチリンクの一部のページが存在しない場合に出力されます。
404 -423 指定したバージョンが存在しない場合に出力されます。
404 -424 指定した文書がバージョン管理の対象外の場合や、バージョン管理の対象外
の文書に version キーを指定した場合に出力されます。
500 -1120 マスクの適用に失敗した文書を出力(プレビュー、印刷、ダウンロード)し
ようとした場合に出力されます。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイ
ルを指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指
定した場合に出力されます。
400 -2201 リンク、ページリンク、マルチリンクに対して rotateType を指定した場合に
出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、次のよう
な場合です。
• version キーに正しくない値が指定された場合
• rotateType キーに正しくない値が指定された場合
第 1 章 SPA Web API リファレンス
58
HTTP ステータス エラーコード 備考
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
59
Highlight Get(Ver. 2) 指定したページに対するハイライト用の注釈を取得します。
URI
http://<hostname>:44230/spa/service/highlight_v2/<id>/<page>
• キー
キー 必須 値 備考
id 取得対象文書の ID
page ページ番号
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"highlightColor": "#0000FF",
"pageHighlightColor": "#FF0000",
"highlightOpacity": 0.8,
"pageHighlightOpacity": 0.5,
"conditions": {
"searchWord": "type == 1",
"operator": "AND",
"conditions": [
{
"conditionType": "svfField",
"name": "field1",
第 1 章 SPA Web API リファレンス
60
オブジェクトの例(JSON 形式)
"docTypeId": "1",
"formName": "form1",
"dataType": "date",
"dateFormat": 1,
"from": "19700101090000",
"to": "19700101180000",
"offset": "9"
},
{
"conditionType": "svfField",
"name": "field2",
"docTypeId": "1",
"formName": "form1",
"dataType": "date",
"dateFormat": 1,
"anyValue": true
},
...
]
},
"searchWordInDocument": "abc"
}
■ データ内容
キー 必須 値 備考
highlightColor 文字列 文書内検索以外のハイライトの色です。RGB 値(0~255)を 16
進表記(#000000~#FFFFFF)で指定します。
指定がない場合は#FFFF00 になります。
pageHighlightColor 文字列 文書内検索時のハイライトの色です。RGB 値(0~255)を 16 進
表記(#000000~#FFFFFF)で指定します。
指定がない場合は#0000FF になります。
highlightOpacity 数値 文書内検索時を除くハイライトの透過度です。0~1.0 で指定しま
す。1.0 で不透明になります。
第 1 章 SPA Web API リファレンス
61
キー 必須 値 備考
指定がない場合は 0.4 になります。
pageHighlightOpacity 数値 文書内検索時のハイライトの透過度です。0~1.0 で指定します。
1.0 で不透明になります。
指定がない場合は 0.4 になります。
conditions (*1) 文書検索時のハイライトを行う検索条件
指定がない場合、文書検索によるハイライトは行いません。
「Search Documents(Ver. 5)(P.30)」の「指定する要素の種
類」にある次のキーの値を指定します。
• searchWord
• operator
• conditions
○ svfField
○ details
○ pageContent
searchWordInDocument (*1) 文字列 文書内検索時のハイライトを行う検索文字列です。256 バイト以
内で指定します。
指定がない場合文書内検索によるハイライトは行いません。
*1 どちらか 1 つの指定が必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
第 1 章 SPA Web API リファレンス
62
キー 値の内容 備考
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
404 -413 マルチリンクの一部のページが存在しない場合に出力されます。
400 -700 検索実行時、プレビューでのハイライト表示時、検索データ作成時に何らか
のエラーが発生した場合に出力されます。
400 -707 全文検索機能がオフに設定されている状態で、全文検索または文書内検索を
実行しようとした場合に発生します。
400 -1052 SVF 検索フィールドの情報を取得する際、指定した条件に合致する SVF 検索
フィールドが存在しなかった場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイ
ルを指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指
定した場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20703 全文検索の検索条件に 1,025 バイト以上の文字を指定した場合、または、文
書内検索の検索条件に 257 バイト以上の文字列を指定した場合に出力されま
す。
400 -20705 全文検索の対象となる文字列の指定に問題がある場合に出力されます。
400 -20706 検索条件の指定において、括弧の使い方が正しくない場合に出力されます。
400 -20707 検索条件の指定において、ダブルクォーテーションが閉じられていない場合
に出力されます。
第 1 章 SPA Web API リファレンス
63
HTTP ステータス エラーコード 備考
400 -20708 検索条件の指定において、演算子の位置が誤っている場合に出力されます。
400 -20709 全文検索以外の検索文字列で最大文字数(256)を超えている、検索条件の指
定が 1 つもないなどの場合に出力されます。たとえば、次のような場合で
す。
• 「最小値」に「最大値」よりも大きな値が指定されている
• 日時の指定形式に誤りがある
• 最大文字数(256 バイト)を超える文字列が指定されている(全文検索
以外)
• 正しい検索条件が 1 つも指定されていない
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、指定され
た日付のフォーマット(dateFormat キー)の値と指定された日時の値の組み
合わせが正しくない、指定した検索キーワードが存在しない場合などです。
400 -29002 ページ番号の指定に問題がある場合に出力されます。たとえば、指定された
ページ番号が実ページ数を超えた場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"pageNum": 1,
"highlights": [
"freeWord": [
[
{
"type": "rect",
"pageNum": 1,
"appearance": {
"visible": true
第 1 章 SPA Web API リファレンス
64
出力例(JSON 形式)
},
"options": {
"toolType": "rect"
},
"referencePoint": {
"x": "10.0",
"y": "20.0"
},
"rect": {
"x": "0.0",
"y": "0.0",
"width": "100.0",
"height": "200.0"
},
"strokeWidth": "0.0",
"strokeColor": "#FF0000",
"strokeOpacity": "0.4",
"fillColor": "#FF0000",
"fillOpacity": "0.4"
},
...
],
...
],
"svfField": [
[
...
],
...
],
"hitWord": [
[
...
第 1 章 SPA Web API リファレンス
65
出力例(JSON 形式)
],
...
],
"detail": [
[
...
],
...
],
"annotation": [
[
...
],
...
]
]
}
■ データ内容
キー 値 備考
pageNum 数値 ページ番号です。
highlights ハイライト一覧の情報
freeWord 「矩形注釈部分の説明(P.66)」を参照してください。 全文検索のヒット箇所
svfField SVF 検索フィールド検索のヒット箇所
hitWord 文書内検索のヒット箇所
detail 明細検索のヒット箇所
annotation 注釈のヒット箇所
第 1 章 SPA Web API リファレンス
66
矩形注釈部分の説明
座標は、ページ左上を原点座標とします。
キー1 キー2 値 備考
type rect 注釈の種別です。
pageNum 数値 ページ番号です。
appearance visible true 注釈を表示するかどうかです。
options toolType rect 注釈の詳細な種別です。
referencePoint x 数値(ピクセル) 注釈の基準点(x 座標)です。
y 数値(ピクセル) 注釈の基準点(y 座標)です。
rect x 数値(ピクセル) 矩形領域の x 座標(referencePoint からの相対座標)です。
y 数値(ピクセル) 矩形領域の y 座標(referencePoint からの相対座標)です。
width 数値(ピクセル) 矩形領域の幅です。
height 数値(ピクセル) 矩形領域の高さです。
strokeWidth 0 矩形枠線の太さです。
strokeColor fillColor と同じ値 矩形枠線の色です。
strokeOpacity fillOpacity と同じ
値
矩形枠線の不透明度です。
fillColor 文字列 ハイライトの色です。RGB の数値(#000000~#FFFFFF)を指定
します。
fillOpacity 0~1 の数値 ハイライトの透過度です。1 の場合不透明で、0 の場合完全に透
過です。
第 1 章 SPA Web API リファレンス
67
4 ダウンロード 文書のダウンロードに関する API は、次のとおりです。
• Download Document(P.68)
• Download Raw Document(P.72)
• Download Print Document(P.74)
• Download Packed Documents(P.77)
• Download Packed Raw Documents(P.81)
• Download Packed Print Documents(P.84)
第 1 章 SPA Web API リファレンス
68
Download Document 指定した単一のファイルをダウンロードします。
URI
http://<hostname>:44230/spa/service/download/<id>
• キー
キー 必須 値 備考
id 取得対象の文書の ID
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
pages 取得対象ページの指定 カンマ区切りによるページ指定、ハイフンによる範囲指定が可能です。
指定がない場合は全ページが対象となります。
setAnnotation ダウンロードする PDF に注釈を付与するかどうか
• true(デフォルト)
付与する
• false
付与しない
forceDownload 対象がマルチリンクで、一部のリンク元のファイルが削除されていた場合でもダウンロードするかどうか
第 1 章 SPA Web API リファレンス
69
キー 必須 値 備考
• true
ダウンロードする
• false(デフォルト)
ダウンロードしない
newUserPassword 暗号化で設定する新しい文書を開くパ
スワード
暗号化設定の status が「OFF」の場合、
ondemand が「SETTING」の場合は、指定し
ても無視されます。
半角英数字および半角記号以外は使用できませ
ん。
▌その他の注意事項
• ログインしている必要があります。
• HTTP リクエストの Accept ヘッダーを「application/pdf」とします。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type application/pdf
Content-Disposition ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となります。
attachment; filename*=utf-8''<ファイル名の URL エンコード>
ファイル名が「document 1.pdf」の場合の例
attachment; filename*=utf-8''document%201.pdf
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
70
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
500 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問題がある場合に出力されます。
500 -250 復号できない PDF ファイル、または解析できない PDF ファイルのため、タイムスタンプが埋め込めない場合に出力されます。
500 -251 タイムスタンプの埋め込みに失敗した PDF ファイルをダウンロードした場合に出力します。何らかの原因でタイムスタンプを埋め込めなかった場合です。
500 -253 タイムスタンプの付与に時間がかかり、ダウンロード処理がタイムアウトし
た場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
404 -413 マルチリンクの一部のページが存在しない場合に出力されます。
404 -414 マルチリンクのダウンロードの際、すべてのページが存在しない場合に出力
されます。
400 -421 パスワードが使用できない場合に出力されます。暗号化設定で ondemand が
「ONDEMAND」、かつ、newUserPassword の値が空、または、権限パスワ
ード(ownerPassword)と同じ値が指定されている場合です。
500 -1120 マスクの適用に失敗した文書を出力(プレビュー、印刷、ダウンロード)し
ようとした場合に出力されます。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイ
ルを指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指
定した場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
71
HTTP ステータス エラーコード 備考
400 -29001 パラメーターの指定に誤りがある場合に出力されます。次のいずれかの場合です。
• 取得対象ページの指定が 2,097,152 文字を超えた場合
• パスワードとして無効な値が指定されていた場合
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-5000 を返します。
第 1 章 SPA Web API リファレンス
72
Download Raw Document 指定した単一のファイルを無加工ダウンロードします。
URI
http://<hostname>:44230/spa/service/download/raw/<id>
• キー
キー 必須 値 備考
id 取得対象の文書の ID
HTTP メソッド
GET
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type • application/pdf
PDF ファイルの場合
• application/octet-stream
PDF ファイル以外のファイルの
場合
Content-
Disposition
ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となります。
attachment; filename*=utf-8''<ファイル名の URL エン
コード>
ファイル名が「document 1.pdf」の場合の例
attachment; filename*=utf-8''document%201.pdf
第 1 章 SPA Web API リファレンス
73
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-
Message
エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
500 -250 復号できない PDF ファイル、または解析できない PDF ファイルのため、タイ
ムスタンプが埋め込めない場合に出力されます。
500 -251 タイムスタンプの埋め込みに失敗した PDF ファイルをダウンロードした場合
に出力します。何らかの原因でタイムスタンプを埋め込めなかった場合で
す。
500 -253 タイムスタンプの付与に時間がかかり、ダウンロード処理がタイムアウトし
た場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -402 リンクを元文書としてリンクを作成した場合に出力されます。リンクの無加
工ダウンロードはできません。
400 -406 ページリンクを無加工ダウンロードしようとした場合に出力されます。ペー
ジリンクの無加工ダウンロードはできません。
400 -415 マルチリンクを無加工ダウンロードしようとした場合に出力されます。マル
チリンクの無加工ダウンロードはできません。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
74
Download Print Document 指定した単一の印刷用ファイルをダウンロードします。
印刷用 PDF ファイルでは、ダウンロードした PDF ファイルを開いた際に印刷ダイアログを表示します。
URI
http://<hostname>:44230/spa/service/download/print/<id>
• キー
キー 必須 値 備考
id 取得対象の文書の ID
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
pages 取得対象ページの指定 カンマ区切りによるページ指定、ハイフンによる範囲指定が可能です。
指定がない場合は全ページが対象となります。
setAnnotation ダウンロードする PDF に注釈を付与するかどうか
• true(デフォルト)
付与する
• false
付与しない
forceDownload 対象がマルチリンクで、リンク元の一部のファイルが削除されていた場合でもダウンロードするかどうか
第 1 章 SPA Web API リファレンス
75
キー 必須 値 備考
• true
ダウンロードする
• false(デフォルト)
ダウンロードしない
▌その他の注意事項
• ログインしている必要があります。
• HTTP リクエストの Accept ヘッダーを「application/pdf」とします。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type application/pdf
Content-Disposition ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となります。
attachment; filename*=utf-8''<ファイル名の URL エンコード>
ファイル名が「document 1.pdf」の場合の例
attachment; filename*=utf-8''document%201.pdf
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
500 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問
題がある場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
第 1 章 SPA Web API リファレンス
76
HTTP ステータス エラーコード 備考
404 -401 指定したファイルが存在しない場合に出力されます。
404 -413 マルチリンクの一部のページが存在しない場合に出力されます。
404 -414 マルチリンクのダウンロードの際、すべてのページが存在しない場合に出力
されます。
500 -1120 マスクの適用に失敗した文書を出力(プレビュー、印刷、ダウンロード)し
ようとした場合に出力されます。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイ
ルを指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指
定した場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。取得対象ページの指
定が 2,097,152 文字を超えた場合です。
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
77
Download Packed Documents 指定した複数のファイルをダウンロードします。
URI
http://<hostname>:44230/spa/service/download/packed
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
ids 取得対象の文書 ID カンマ区切りで複数指定できます。
name ZIP ファイル名
charset ZIP ファイル内のファイル名で
使う文字セット
指定しない場合は「UTF-8」で動作します。
setAnnotation ダウンロードする PDF に注釈
を付与するかどうか
• true(デフォルト)
付与する
• false
付与しない
forceDownload 対象がマルチリンクで、一部の
リンク元のファイルが削除され
ていた場合でもダウンロードす
るかどうか
• true
ダウンロードする
ダウンロードした場合は、ZIP ファイルに、リンク
元がないために削除したページの情報を記録したフ
ァイル「error_pages.xml」が含まれます。
第 1 章 SPA Web API リファレンス
78
キー 必須 値 備考
• false(デフォルト)
ダウンロードしない
newUserPassword 暗号化で設定する新しい文書を
開くパスワード
暗号化設定の status が「OFF」の場合、ondemand
が「SETTING」の場合は、指定しても無視されま
す。
半角英数字および半角記号以外は使用できません。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/zip」とします。
• ログインしている必要があります。
• 異なるフォルダーにある同一名の文書が指定された場合、括弧つきの数値が名称に挿入されます。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type application/zip
Content-Disposition ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となります。
attachment; filename*=utf-8''<ファイル名の URL エンコード>
ファイル名が「document 3.zip」の場合の例
attachment; filename*=utf-8''document%203.zip
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
79
HTTP ステータス エラーコード 備考
500 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問
題がある場合に出力されます。
500 -250 復号できない PDF ファイル、または解析できない PDF ファイルのため、タイ
ムスタンプが埋め込めない場合に出力されます。
500 -251 タイムスタンプの埋め込みに失敗した PDF ファイルをダウンロードした場合
に出力します。何らかの原因でタイムスタンプを埋め込めなかった場合で
す。
500 -253 タイムスタンプの付与に時間がかかり、ダウンロード処理がタイムアウトし
た場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -412 一括でダウンロード可能なファイル数を超えた場合に出力されます。
404 -413 マルチリンクの一部のページが存在しない場合に出力されます。
404 -414 マルチリンクのダウンロードの際、すべてのページが存在しない場合に出力
されます。
400 -421 パスワードが使用できない場合に出力されます。暗号化設定で ondemand が
「ONDEMAND」、かつ、newUserPassword の値が空、または、権限パスワ
ード(ownerPassword)と同じ値が指定されている場合です。
500 -1120 マスクの適用に失敗した文書を出力(プレビュー、印刷、ダウンロード)し
ようとした場合に出力されます。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイ
ルを指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指
定した場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。次のいずれかの場合です。
第 1 章 SPA Web API リファレンス
80
HTTP ステータス エラーコード 備考
• ZIP ファイル名の指定がないか不正な文字列を含む場合
• パスワードとして無効な値が指定されていた場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-5000 を返します。
第 1 章 SPA Web API リファレンス
81
Download Packed Raw Documents 指定した複数のファイルを無加工ダウンロードします。
URI
http://<hostname>:44230/spa/service/download/packed/raw
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
ids 取得対象の文書 ID カンマ区切りで複数指定できます。
name ZIP ファイル名
charset ZIP ファイル内のファイル名で使う文字セット 指定しない場合は「UTF-8」で動作します。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/zip」とします。
• ログインしている必要があります。
• 異なるフォルダーにある同一名の文書が指定された場合、括弧つきの数値が名称に挿入されます。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type application/zip
第 1 章 SPA Web API リファレンス
82
キー 値の内容 備考
Content-Disposition ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となります。
attachment; filename*=utf-8''<ファイル名の URL エンコード>
ファイル名が「document 3.zip」の場合の例
attachment; filename*=utf-8''document%203.zip
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
500 -250 復号できない PDF ファイル、または解析できない PDF ファイルのため、タイ
ムスタンプが埋め込めない場合に出力されます。
500 -251 タイムスタンプの埋め込みに失敗した PDF ファイルをダウンロードした場合
に出力します。何らかの原因でタイムスタンプを埋め込めなかった場合で
す。
500 -253 タイムスタンプの付与に時間がかかり、ダウンロード処理がタイムアウトし
た場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -402 リンクを元文書としてリンクを作成した場合に出力されます。リンクの無加
工ダウンロードはできません。
400 -406 ページリンクを無加工ダウンロードしようとした場合に出力されます。ペー
ジリンクの無加工ダウンロードはできません。
400 -412 一括でダウンロード可能なファイル数を超えた場合に出力されます。
400 -415 マルチリンクを無加工ダウンロードしようとした場合に出力されます。マル
チリンクの無加工ダウンロードはできません。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
第 1 章 SPA Web API リファレンス
83
HTTP ステータス エラーコード 備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。ZIP ファイル名の指定
がない、または、不正な文字列を含む場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
84
Download Packed Print Documents 指定した複数の印刷用ファイルをダウンロードします。
URI
http://<hostname>:44230/spa/service/download/packed/print
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"documents": [
{
"id": 1,
"pages": ""
},
{
"id": 2,
"pages": "1,2"
}
],
"setAnnotation": true,
"insertBlank": true
}
第 1 章 SPA Web API リファレンス
85
■ データ内容
キー 必須 値 備考
documents 取得対象文書の情報
id 取得対象文書の ID です。
pages 取得対象文書のページです。
カンマ区切りによるページ指定、ハイフンによる範囲指定が可能です。
指定がない場合は全ページが指定されたものとします。
setAnnotation true ダウンロードする PDF ファイルに注釈を付与します。
指定されていない場合は、true が指定されたものとします。
false ダウンロードする PDF ファイルに注釈を付与しません。
forceDownload true 対象がマルチリンクで、一部のリンク元のファイルが削除されていた場合でもダウ
ンロードします。
false 対象がマルチリンクで、一部のリンク元のファイルが削除されていた場合はダウン
ロードしません。
指定されていない場合は、false が指定されたものとします。
insertBlank true 次の条件をすべて満たす場合に、白紙ページを挿入します。
• 「全ページ」を指定する
• 対象の文書の総ページ数が奇数である
false 次の条件をすべて満たす場合に、白紙ページを挿入しません。指定されていない場
合は、false が指定されたものとします。
• 「全ページ」を指定する
• 対象の文書の総ページ数が奇数である
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/pdf」とします。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
86
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type application/pdf
Content-Disposition ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となります。
attachment; filename*=utf-8''<ファイル名の URL エンコード>
ファイル名が「document 1.pdf」の場合の例
attachment; filename*=utf-8''document%201.pdf
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
500 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問
題がある場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
404 -413 マルチリンクの一部のページが存在しない場合に出力されます。
404 -414 マルチリンクのダウンロードの際、すべてのページが存在しない場合に出力
されます。
500 -1120 マスクの適用に失敗した文書を出力(プレビュー、印刷、ダウンロード)し
ようとした場合に出力されます。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイ
ルを指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指
定した場合に出力されます。
第 1 章 SPA Web API リファレンス
87
HTTP ステータス エラーコード 備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。取得対象ページの指
定が 2,097,152 文字を超えた場合に出力されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
88
5 ファイル操作 ファイル操作に関する API は、次のとおりです。
• Documents Lookup(P.89)
• Documents List(Ver. 5)(P.92)
• Documents Get(Ver. 5)(P.104)
• Documents Image Verify(P.115)
• Documents Rename(P.118)
• Documents Move List(Ver. 2)(P.121)
• Documents Delete List(P.125)
• Documents History List(P.129)
• Documents Restore(P.133)
第 1 章 SPA Web API リファレンス
89
Documents Lookup ファイル名から ID を取得します。
URI
http://<hostname>:44230/spa/service/documents/lookup
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"lookupTableList": [
{
"name": "/folder1/document1.pdf"
},
{
"name": "/folder2/document2.pdf"
},
...
]
}
■ データ内容
キー 必須 値 備考
lookupTableList ファイル名情報
name 文字列 ファイル名をフルパスで指定します。
第 1 章 SPA Web API リファレンス
90
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"lookupTableList": [
{
"name": "/folder1/document1.pdf",
第 1 章 SPA Web API リファレンス
91
出力例(JSON 形式)
"id": "10"
},
{
"name": "/folder2/document2.pdf",
"id": null
},
...
]
}
■ データ内容
キー 値 備考
lookupTableList ファイル名情報
name 文字列 ファイル名です。
id 文字列 ファイル名から取得した ID です。ファイルが存在しない場合は null になります。
ファイルが置かれているフォルダーのアクセス権がない場合、ファイルが存在しないもの
として扱います。
第 1 章 SPA Web API リファレンス
92
Documents List(Ver. 5) 指定したフォルダー直下のファイル、リンク、フォルダーの一覧を取得します。取得する情報は、パラメー
ターで選択できます。
URI
http://<hostname>:44230/spa/service/documents_v5/<id>/list
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
folder フォルダー情報を取得するかどうか
• true
フォルダー情報を取得する
• false(デフォルト)
フォルダー情報を取得しない
• 省略された場合は、false とします。
properties 値の取得対象となるプロパティ情報の項目名
• properties 要素内で必要な値の項目名をカンマ区切りで列挙します。項目については「指定可能なプロパティ情報の項目名(P.93)」を参照してください。
• properties キー自体の指定がない場合は、すべての項目について値の取得を試みます。
第 1 章 SPA Web API リファレンス
93
キー 必須 値 備考
customProperties 値の取得対象となるカスタムプロパティの ID
• customProperties 要素内で必要な値のカスタムプロパティ ID をカンマ区切りで列挙します。
• customProperties キー自体の指定がない場合は、カスタムプロパティの値を取得しません。
■ 指定可能なプロパティ情報の項目名
値 備考
name 文書名です。
filetype 文書の種類です。
• 0
PDF ファイルと PDF ファイル以外のファイルです。
• 1
リンク
• 2
ページリンク
• 3
マルチリンク
title • PDF ファイルの場合
タイトルです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
空が返ります。
subject • PDF ファイルの場合
サブタイトルです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
空が返ります。
第 1 章 SPA Web API リファレンス
94
値 備考
keywords • PDF ファイルの場合
キーワードです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
空が返ります。
author • PDF ファイルの場合
作成者です。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
Document Converter 実行ユーザー(Windows GUI ログインユーザー)です。
creator • PDF ファイルの場合
作成アプリケーションです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
Document Converter とバージョンが返ります。「Document Converter 9.3.4.1」の
形式となります。
producer • PDF ファイルの場合
PDF 変換です。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
Document Converter とバージョンが返ります。「Document Converter 9.3.4.1」の
形式となります。
createdate • PDF ファイルの場合
作成日です。
• PDF ファイル以外のファイルの場合
第 1 章 SPA Web API リファレンス
95
値 備考
空が返ります。
• Document Converter により変換された PDF ファイルの場合
システム時刻(秒単位)です。タイムゾーンはシステムロケールに従います。
「D:20170313172423+09'00'」の形式となり、タイムゾーンオフセットはシステム
ロケールに従います。
modifydate • PDF ファイルの場合
更新日です。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
システム時刻(秒単位)です。タイムゾーンはシステムロケールに従います。
「D:20170313172423+09'00'」の形式となり、タイムゾーンオフセットはシステム
ロケールに従います。
size ファイルサイズです。
pagecount • PDF ファイルの場合
ページ数です。
• PDF ファイル以外のファイルの場合
0 が返ります。
• Document Converter により変換された PDF ファイルの場合
変換された「ページ数」です。
adduser 作成ユーザー(初回アーカイブしたユーザー)です。
adduserdomain 作成ユーザーが属するドメイン名です。
adddate 作成日時(初回アーカイブした日時)です。
updateuser アーカイブユーザー名 (上書きアーカイブ含む)です。
updateuserdomain アーカイブユーザーが属するドメイン名です。
updatedate アーカイブ日時(上書きアーカイブ含む)です。
doctype_key 文書定義管理 ID です。
doctype_id 文書定義 ID です。
doctype_dispname 文書定義名です。
第 1 章 SPA Web API リファレンス
96
値 備考
viewdate • PDF ファイルの場合
最終閲覧日時です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効な値が返ります。それまでは空が返ります。
viewuser • PDF ファイルの場合
最終閲覧者のユーザー名です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
viewuserdomain • PDF ファイルの場合
最終閲覧者のドメインです。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
printdate • PDF ファイルの場合
最終印刷日時です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
printuser • PDF ファイルの場合
最終印刷者のユーザー名です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
printuserdomain • PDF ファイルの場合
最終印刷者のドメインです。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
downloaddate 最終ダウンロード日時です。
downloaduser 最終ダウンロードユーザーの名前です。
downloaduserdomain 最終ダウンロードユーザーのドメインです。
parsed_status 文書解析ステータスまたは解析結果です。
第 1 章 SPA Web API リファレンス
97
値 備考
値 文書解析ステータス 解析結果
0 解析中 -
1 解析中(検索インデックス作成中) -
2 解析完了 マスク適用失敗
3 解析完了 解析不能ファイル
4 解析完了 暗号化ファイル
5 解析完了 解析可能ファイル(本文検索不可)
6 解析完了 解析可能ファイル(本文検索一部不可)
7 解析完了 検索可能ファイル
docpath 文書の置かれているフォルダーのパスです。
linkpath リンク元ファイルのパスです。リンク元ファイルが設定されない場合は null になりま
す。
hitpages ヒットしたページの情報です。検索時のみ、ヒットしたページの情報がカンマ区切りで設
定されます。それ以外の場合は null になります。
stamp タイムスタンプ付与のステータスです。Ver. 10.1 以降では、リンクおよびページリンク
の場合は、リンク元文書の情報です。
値 ステータス
0 タイムスタンプを付与しない文書
1 タイムスタンプ付与待ち
2 タイムスタンプ付与済み
3 タイムスタンプ付与失敗。または、付与できないファイル
4 マスク適用待ち
5 タイムスタンプ対象外
stamped_image_info タイムスタンプが付与された文書のイメージ情報です。Ver. 10.1 以降では、リンクおよ
びページリンクの場合は、リンク元文書の情報です。
stamp の値が 2 以外の場合は null になります。
review_status レビューのステータスです。
第 1 章 SPA Web API リファレンス
98
値 備考
値 ステータス
null 対応するレビューがない
0 起票前
1 起票
2 処理中
3 完了
svffield_editable_status SVF 検索フィールドの解析ステータス、解析結果、キャッシュデータ作成ステータスで
す。
値 解析ステータス 解析結果 キャッシュデータ作成ステータス
0 解析中 - -
1 解析不能 - -
2 解析完了 SVF 検索フィールドなし -
3 解析完了 SVF 検索フィールドあり キャッシュなし
4 解析完了 SVF 検索フィールドあり キャッシュ作成中
5 解析完了 SVF 検索フィールドあり キャッシュ作成完了
annotation_existence 注釈の有無です。
• true
注釈がある
• false
注釈がない
convert_doc_status Document Converter で PDF ファイル以外のファイルを PDF ファイルに変換する際のス
テータスです。
値 ステータス
0 適用外
1 待機中
2 変換中
3 完了
4 失敗
第 1 章 SPA Web API リファレンス
99
値 備考
doc_convert_error Document Converter で PDF ファイル以外のファイルを PDF ファイルに変換する際のエ
ラーコードです。エラーがない場合は null が返ります。
値 内容
-30 印刷アプリケーションを実行する変換プロセスが起動できない場合に発生し
ます。
-40 タイムアウト時間内にファイルを読み込めない場合や印刷時に何らかの原因
で処理が停止した場合に発生します。
-50 文書ファイルをオープンしてから印刷するまでにエラーが発生しています。
-60 文書ファイルの印刷中に印刷ドライバー内部でエラーが発生しています。
-70 プリンター「SPA Convert Printer」が「通常使うプリンター」に設定されて
いない場合に発生します。
-80 変換対象のファイルの拡張子が印刷アプリケーションに正しく関連付けされ
ていない場合に発生します。
-2110 Document Converter への接続に失敗した場合に出力されます。
-9999 原因が不明なエラーの場合に発生します。
doc_convert_connection Document Converter の接続情報です。
{
"protocol": "http",
"host": "10.97.8.8",
"port": 44250,
"convId": "rep6295028295274961575tmp",
"sessionId":
"JSESSIONID=5785C1952FFE41B84792AF34AE343C46;Version=1;Path=/spapd-
webapp;HttpOnly"
}
content_type コンテンツタイプです。PDF ファイルか PDF ファイル以外のファイルかを示します。
• 0
PDF ファイル以外のファイル
• 1
PDF ファイル
第 1 章 SPA Web API リファレンス
100
値 備考
direct_url URL リンクです。
document_version 文書のバージョンです。バージョン管理対象外の場合は null になります。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在しな
かった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
101
HTTP ステータ
ス
エラーコー
ド
備考
400 -29001 パラメーターの指定に誤りがある場合に出力されます。存在しないプロパティを
取得対象とした場合などです。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"documentList": [
{
"type": "folder",
"id": 2,
"parentId": 1,
"properties": {
"name": "folder1"
},
"folderType": "PUBLIC"
},
{
"type": "document",
"id": 1,
"linkId": -1,
"parentId": 1,
"propertyEntityVersion": 2,
"documentEntityVersion": 1,
"annotationEntityVersion": 1,
"pagememoEntityVersion": 1,
"svffieldEntityVersion": 1,
"properties": {
第 1 章 SPA Web API リファレンス
102
出力例(JSON 形式)
"name": "doc1.pdf",
"filetype": "0",
"svffield_editable_status": "5",
"direct_url": "http://<サーバー名または IP アドレス>:44230/spa/preview.jsp?docId=1",
"document_version": "1.0"
...
},
"customProperties": {
"1": "column1",
"2": "column2",
"3":"1234.2345"
...
}
}
]
}
■ データ内容
キー 値 備考
documentList ファイル情報
「ファイル情報に関するキーについて(P.102)」を参照してください。
ファイル情報に関するキーについて
キー 値 備考
type document ファイルを示します。
folder フォルダーを示します。フォルダーに関する他のキーについては、「10 フォ
ルダー操作」の API の「フォルダー情報に関するキーについて(P.189)」を参
照してください。
id 文字列 文書の ID です。
parentId 文字列 親フォルダーの ID です。
linkId 文字列 リンク元ファイルの ID です。
propertyEntityVersion 数値 プロパティのエンティティバージョンです。
第 1 章 SPA Web API リファレンス
103
キー 値 備考
documentEntityVersion 数値 文書のエンティティバージョンです。
annotationEntityVersion 数値 注釈のエンティティバージョンです。
pagememoEntityVersion 数値 ページメモのエンティティバージョンです。
svffieldEntityVersion 数値 SVF 検索フィールドの編集用データのエンティティバージョンです。
properties プロパティ情報
キーはプロパティ名、値はプロパティの値を示します。キーについては、
「指定可能なプロパティ情報の項目名(P.93)」を参照してください。
customProperties カスタムプロパティの情報
キーはカスタムプロパティの ID、値はカスタムプロパティの値を示しま
す。なお、数値型のカスタムプロパティの値は、文字列で返します。
第 1 章 SPA Web API リファレンス
104
Documents Get(Ver. 5) 指定した文書の詳細情報(メタ情報)とカスタムプロパティの情報を取得します。
URI
http://<hostname>:44230/spa/service/documents_v5/<id>
• キー
キー 必須 値 備考
id 処理対象文書の ID
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必
須
値 備考
properties 値の取得対象と
なるプロパティ
情報の項目名
• properties 要素内で必要な値の項目名をカンマ区切りで列挙し
ます。項目については「指定可能なプロパティ情報の項目名
(P.105)」を参照してください。
• properties キー自体の指定がない場合は、すべての項目につい
て値の取得を試みます。
customProperties 値の取得対象と
なるカスタムプ
ロパティの ID
• customProperties 要素内で必要な値のカスタムプロパティ ID を
カンマ区切りで列挙します。
• customProperties キー自体の指定がない場合は、カスタムプロ
パティの値を取得しません。
version 値の取得対象と
なる文書のバー
ジョン
文書がバージョン管理対象の場合に指定します。version キー自体の
指定がない場合は、最新バージョンが指定されたものとします。
第 1 章 SPA Web API リファレンス
105
■ 指定可能なプロパティ情報の項目名
値 備考
name 文書名です。
filetype 文書の種類です。
• 0
PDF ファイルと PDF ファイル以外のファイルです。
• 1
リンク
• 2
ページリンク
• 3
マルチリンク
title • PDF ファイルの場合
タイトルです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
空が返ります。
subject • PDF ファイルの場合
サブタイトルです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
空が返ります。
keywords • PDF ファイルの場合
キーワードです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
空が返ります。
第 1 章 SPA Web API リファレンス
106
値 備考
author • PDF ファイルの場合
作成者です。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
Document Converter 実行ユーザー(Windows GUI ログインユーザー)です。
creator • PDF ファイルの場合
作成アプリケーションです。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
Document Converter とバージョンが返ります。「Document Converter 9.3.4.1」の
形式となります。
producer • PDF ファイルの場合
PDF 変換です。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
Document Converter とバージョンが返ります。「Document Converter 9.3.4.1」の
形式となります。
createdate • PDF ファイルの場合
作成日です。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
システム時刻(秒単位)です。タイムゾーンはシステムロケールに従います。
「D:20170313172423+09'00'」の形式となり、タイムゾーンオフセットはシステム
ロケールに従います。
第 1 章 SPA Web API リファレンス
107
値 備考
modifydate • PDF ファイルの場合
更新日です。
• PDF ファイル以外のファイルの場合
空が返ります。
• Document Converter により変換された PDF ファイルの場合
システム時刻(秒単位)です。タイムゾーンはシステムロケールに従います。
「D:20170313172423+09'00'」の形式となり、タイムゾーンオフセットはシステム
ロケールに従います。
size ファイルサイズです。
pagecount • PDF ファイルの場合
ページ数です。
• PDF ファイル以外のファイルの場合
0 が返ります。
• Document Converter により変換された PDF ファイルの場合
変換された「ページ数」です。
adduser 作成ユーザー(初回アーカイブしたユーザー)です。
adduserdomain 作成ユーザーが属するドメイン名です。
adddate 作成日時(初回アーカイブした日時)です。
updateuser アーカイブユーザー名 (上書きアーカイブ含む)です。
updateuserdomain アーカイブユーザーが属するドメイン名です。
updatedate アーカイブ日時(上書きアーカイブ含む)です。
doctype_key 文書定義管理 ID です。
doctype_id 文書定義 ID です。
doctype_dispname 文書定義名です。
viewdate • PDF ファイルの場合
最終閲覧日時です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効な値が返ります。それまでは空が返ります。
第 1 章 SPA Web API リファレンス
108
値 備考
viewuser • PDF ファイルの場合
最終閲覧者のユーザー名です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
viewuserdomain • PDF ファイルの場合
最終閲覧者のドメインです。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
printdate • PDF ファイルの場合
最終印刷日時です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
printuser • PDF ファイルの場合
最終印刷者のユーザー名です。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
printuserdomain • PDF ファイルの場合
最終印刷者のドメインです。
• Document Converter により変換された PDF ファイルの場合
PDF ファイルに変換後、有効となります。それまでは空が返ります。
downloaddate 最終ダウンロード日時です。
downloaduser 最終ダウンロードユーザーの名前です。
downloaduserdomain 最終ダウンロードユーザーのドメインです。
parsed_status 文書解析ステータスまたは解析結果です。
値 文書解析ステータス 解析結果
0 解析中 -
1 解析中(検索インデックス作成中) -
2 解析完了 マスク適用失敗
第 1 章 SPA Web API リファレンス
109
値 備考
3 解析完了 解析不能ファイル
4 解析完了 暗号化ファイル
5 解析完了 解析可能ファイル(本文検索不可)
6 解析完了 解析可能ファイル(本文検索一部不可)
7 解析完了 検索可能ファイル
docpath 文書の置かれているフォルダーのパスです。
linkpath リンク元ファイルのパスです。リンク元ファイルが設定されない場合は null になりま
す。
hitpages ヒットしたページの情報です。検索時のみ、ヒットしたページの情報がカンマ区切りで設
定されます。それ以外の場合は null になります。
stamp タイムスタンプ付与のステータスです。Ver. 10.1 以降では、リンクおよびページリンク
の場合は、リンク元文書の情報です。
値 ステータス
0 タイムスタンプを付与しない文書
1 タイムスタンプ付与待ち
2 タイムスタンプ付与済み
3 タイムスタンプ付与失敗。または、付与できないファイル
4 マスク適用待ち
5 タイムスタンプ対象外
stamped_image_info タイムスタンプが付与された文書のイメージ情報です。Ver. 10.1 以降では、リンクおよ
びページリンクの場合は、リンク元文書の情報です。
stamp の値が 2 以外の場合は null になります。
review_status レビューのステータスです。
値 ステータス
null 対応するレビューがない
0 起票前
1 起票
2 処理中
第 1 章 SPA Web API リファレンス
110
値 備考
3 完了
svffield_editable_status SVF 検索フィールドの解析ステータス、解析結果、キャッシュデータ作成ステータスで
す。
値 解析ステータス 解析結果 キャッシュデータ作成ステータス
0 解析中 - -
1 解析不能 - -
2 解析完了 SVF 検索フィールドなし -
3 解析完了 SVF 検索フィールドあり キャッシュなし
4 解析完了 SVF 検索フィールドあり キャッシュ作成中
5 解析完了 SVF 検索フィールドあり キャッシュ作成完了
annotation_existence 注釈の有無です。
• true
注釈がある
• false
注釈がない
convert_doc_status Document Converter で PDF ファイル以外のファイルを PDF ファイルに変換する際のス
テータスです。
値 ステータス
0 適用外
1 待機中
2 変換中
3 完了
4 失敗
doc_convert_error Document Converter で PDF ファイル以外のファイルを PDF ファイルに変換する際のエ
ラーコードです。エラーがない場合は null が返ります。
値 内容
-30 印刷アプリケーションを実行する変換プロセスが起動できない場合に発生し
ます。
第 1 章 SPA Web API リファレンス
111
値 備考
-40 タイムアウト時間内にファイルを読み込めない場合や印刷時に何らかの原因
で処理が停止した場合に発生します。
-50 文書ファイルをオープンしてから印刷するまでにエラーが発生しています。
-60 文書ファイルの印刷中に印刷ドライバー内部でエラーが発生しています。
-70 プリンター「SPA Convert Printer」が「通常使うプリンター」に設定されて
いない場合に発生します。
-80 変換対象のファイルの拡張子が印刷アプリケーションに正しく関連付けされ
ていない場合に発生します。
-2110 Document Converter への接続に失敗した場合に出力されます。
-9999 原因が不明なエラーの場合に発生します。
doc_convert_connection Document Converter の接続情報です。
{
"protocol": "http",
"host": "10.97.8.8",
"port": 44250,
"convId": "rep6295028295274961575tmp",
"sessionId":
"JSESSIONID=5785C1952FFE41B84792AF34AE343C46;Version=1;Path=/spapd-
webapp;HttpOnly"
}
content_type コンテンツタイプです。PDF ファイルか PDF ファイル以外のファイルかを示します。
• 0
PDF ファイル以外のファイル
• 1
PDF ファイル
direct_url URL リンクです。
document_version 文書のバージョンです。バージョン管理対象外の場合は null になります。
第 1 章 SPA Web API リファレンス
112
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
404 -423 指定したバージョンが存在しない場合に出力されます。
404 -424 指定した文書がバージョン管理の対象外の場合や、バージョン管理の対象外
の文書に version キーを指定した場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在
しなかった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新
をしようとした場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
113
HTTP ステータス エラーコード 備考
400 -29001 パラメーターの指定に誤りがある場合に出力されます。version キーに正しく
ない値が指定された場合や存在しないプロパティを取得対象とした場合など
に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"type": "document",
"id": 1,
"linkId": -1,
"parentId": 1,
"propertyEntityVersion": 2,
"documentEntityVersion": 1,
"annotationEntityVersion": 1,
"pagememoEntityVersion": 1,
"svffieldEntityVersion": 1,
"properties": {
"name": "doc1.pdf",
"filetype": "0",
"svffield_editable_status": "5",
"direct_url": "http://<サーバー名または IP アドレス>:44230/spa/preview.jsp?docId=1",
"document_version": "1.0"
...
},
"customProperties": {
"1": "column1",
"2": "column2",
"3":"1234.2345"
第 1 章 SPA Web API リファレンス
114
出力例(JSON 形式)
...
}
}
■ データ内容
キー 値 備考
type document ファイルを示します。
folder フォルダーを示します。
id 文字列 文書の ID です。
parentId 文字列 親フォルダーの ID です。
linkId 文字列 リンク元ファイルの ID です。
propertyEntityVersion 数値 プロパティのエンティティバージョンです。
documentEntityVersion 数値 文書のエンティティバージョンです。
annotationEntityVersion 数値 注釈のエンティティバージョンです。
pagememoEntityVersion 数値 ページメモのエンティティバージョンです。
svffieldEntityVersion 数値 SVF 検索フィールドの編集用データのエンティティバージョンです。
properties プロパティ情報
キーはプロパティ名、値はプロパティの値を示します。キーについては、
「指定可能なプロパティ情報の項目名(P.105)」を参照してください。
customProperties カスタムプロパティの情報
キーはカスタムプロパティの ID、値はカスタムプロパティの値を示しま
す。なお、数値型のカスタムプロパティの値は、文字列で返します。
第 1 章 SPA Web API リファレンス
115
Documents Image Verify PDF ファイルに埋め込まれている画像の解像度と色深度を検証します。
URI
http://<hostname>:44230/spa/service/documents/image/verify
HTTP メソッド
POST
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必須 値 備考
verifyImageDpi 画像の解像度(dpi)のしきい
値
verifyImageDpi か verifyImageBpp のどちらかを必ず指
定する必要があります。
verifyImageBpp 画像の色深度(bpp)のしき
い値
verifyImageDpi か verifyImageBpp のどちらかを必ず指
定する必要があります。
isVerifyAllPage すべてのページを検証するか
どうか
• true(デフォルト)
すべてのページを検証す
る
• false
エラーが発生した時点で
検証を中止する
password 暗号化された PDF ファイルの
パスワード • 複数指定はできません。
• UTF-8 でエンコーディングします。
• password を指定しない場合は、パスワードなしと
して処理します。
第 1 章 SPA Web API リファレンス
116
キー 必須 値 備考
file 検証する PDF ファイル • 複数指定はできません。単一の PDF ファイルのみ
が対象です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• ページ内に複数の画像がある場合、PDF ファイル内部で先に記述されている画像が検証対象となり、
それ以外の画像は検証されません。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
400 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問
題がある場合に出力されます。
400 -103 指定されたファイルが PDF ファイルではない場合に出力されます。
400 -105 暗号化された PDF ファイルを復号できない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
117
HTTP ステータス エラーコード 備考
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"imageDpiVerifyErrorPages": [],
"imageBppVerifyErrorPages": [
1,
3,
9
]
}
■ データ内容
キー 値 備考
imageDpiVerifyErrorPages 数値 画像の解像度(dpi)の検証でエラーになったページです。
imageBppVerifyErrorPages 数値 画像の色深度(bpp)の検証でエラーになったページです。
第 1 章 SPA Web API リファレンス
118
Documents Rename ファイル名を変更します。
URI
http://<hostname>:44230/spa/service/documents/<id>
• キー
キー 必須 値 備考
id 処理対象文書の ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
新しいファイル名は、properties キー内で name キーの値として指定します。
オブジェクトの例(JSON 形式)
{
"type": "document",
"properties": {
"name": "doc1.pdf"
},
"condition": {
"usePropertyEntityVersion": true,
"propertyEntityVersion": 1
}
}
第 1 章 SPA Web API リファレンス
119
■ データ内容
キー 必須 値 備考
type document ファイルを示します。必須です。
properties プロパティ情報
キーにはプロパティ名、値はプロパティの値を指定します。ファイ
ル名の変更では、「name」キーのみを指定します。
name 文字列 ファイル名です。
condition ファイル名の更新条件
条件を指定しない場合は省略可能です。
usePropertyEntityVersion true プロパティのエンティティバージョンを指定します。
false プロパティのエンティティバージョンを指定しません。
指定されていない場合は、false が指定されたものとします。
propertyEntityVersion 数値 更新するプロパティのエンティティバージョンです。最新バージョ
ンと一致しない場合はエラーとなります。
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
第 1 章 SPA Web API リファレンス
120
HTTP ステータス エラーコード 備考
403 -400 同名のファイルがすでに存在している場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -403 ファイル名に誤りがあります。次のいずれかの場合に出力されます。
• ファイル名が半角ドットから始まっている
• ファイル名に¥ / : * ? " < > |が使用されている
• ファイル名が 250 バイトを超えている
400 -458 プロパティ値の更新時にバージョンを更新条件としたが、指定したバージョ
ンと一致しなかった場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
121
Documents Move List(Ver. 2) 指定したファイルとフォルダーをまとめて別のフォルダーに移動します。
URI
http://<hostname>:44230/spa/service/documents_v2/moveList
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"documentList": [
{
"type": "folder",
"id": "2"
},
{
"type": "document",
"id": "1"
}
],
"toFolderId": "10"
"addTimestamp": true,
"applyMask": true
}
第 1 章 SPA Web API リファレンス
122
■ データ内容
キー 必須 値 備考
documentList 移動するファイル、フォルダーの情報
「ファイル情報に関するキーについて(P.122)」を参照してください。
toFolderId 文字列 移動先フォルダーの ID です。
addTimestamp true 移動先フォルダーの文書管理ポリシーに従って、移動された文書にタイムスタンプを付与します。
指定されていない場合は、true が指定されたものとします。
false 移動先フォルダーの文書管理ポリシーにかかわらず、移動された文書にはタイムスタンプを付与しません。
applyMask true 移動先フォルダーの文書管理ポリシーに従って、移動された文書にマスクを適用します。
指定されていない場合は、true が指定されたものとします。
false 移動先フォルダーの文書管理ポリシーにかかわらず、移動された文書にはマスクを適用しません。
ファイル情報に関するキーについて
キー 必須 値 備考
type document ファイルを示します。
folder フォルダーを示します。
id 文字列 文書の ID またはフォルダーの ID です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
第 1 章 SPA Web API リファレンス
123
キー 値の内容 備考
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -302 すでに同名のフォルダーが存在している場合に出力されます。
400 -304 フォルダーの階層が管理画面の[フォルダーの最大階層数]に設定された値を超える場合に出力されます。
400 -305 フォルダーの階層が管理画面の[フォルダー内の最大サブフォルダー数]に設定された値を超える場合に出力されます。
400 -306 フォルダー内のファイル数が管理画面の[フォルダー内の最大ファイル数]に設定された値を超える場合に出力されます。
400 -310 移動先のフォルダーと移動元のフォルダーの関係に問題がある場合に出力されます。移動元と移動先が同じフォルダーの場合や、移動先が移動元フォルダーのサブフォルダー配下の場合です。
400 -400 同名のファイルがすでに存在している場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。
たとえば次のような場合です。
• 移動先のフォルダーが、次のフォルダーの場合
○ パブリックのルートフォルダー
○ ユーザールートフォルダー
○ ドメインルートフォルダー
○ ログインしているユーザーのホームフォルダー
• ファイルの最終的な移動先が、次のフォルダーの場合
○ ユーザールートフォルダー
第 1 章 SPA Web API リファレンス
124
HTTP ステータス エラーコード 備考
○ ドメインルートフォルダー(または、ユーザールートフォルダー配
下のドメインルートフォルダーと同階層のフォルダーの場合)
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。次のいずれかの場合
です。
• 移動先のフォルダーID が指定されていなかったり、移動先のフォルダー
ID に誤りがあった場合
• 文書またはフォルダーの ID に、数字以外の文字列が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
125
Documents Delete List 指定したファイルとフォルダーをまとめて削除します。
URI
http://<hostname>:44230/spa/service/documents/deleteList
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"physicalDelete": false,
"documentList": [
{
"type": "folder",
"id": "2"
},
{
"type": "document",
"id": "1"
}
]
}
第 1 章 SPA Web API リファレンス
126
■ データ内容
キー 必須 値 備考
physicalDelete true ファイル、フォルダーを物理削除します。
false ファイル、フォルダーをごみ箱に移動します。
指定を省略した場合は「false」で動作します。
documentList 削除するファイル、フォルダーの情報
「ファイル情報に関するキーについて(P.126)」を参照してください。
ファイル情報に関するキーについて
キー 必須 値 備考
type document ファイルを示します。ファイル名の変更時には必須です。
folder フォルダーを示します。Documents List、Documents Delete List
で有効です。フォルダーに関する他のキーについては、フォルダー
の操作に関する API のフォルダー情報に関するキーについてを参照
してください。
id 文字列 ファイルの ID です。
parentId 文字列 親フォルダーの ID です。ファイル名の変更時には不要です。
linkId 文字列 リンク元ファイルの ID です。Documents List では無効です。ファ
イル名の変更時には不要です。
propertyEntityVersion 数値 プロパティのエンティティバージョンです。ファイル名の変更時に
は不要です。
documentEntityVersion 数値 文書のエンティティバージョンです。ファイル名の変更時には不要
です。
annotationEntityVersion 数値 注釈のエンティティバージョンです。ファイル名の変更時には不要
です。
pagememoEntityVersion 数値 ページメモのエンティティバージョンです。ファイル名の変更時に
は不要です。
properties プロパティ情報
キーにはプロパティ名、値はプロパティの値を指定します。キーに
ついては、「指定可能なプロパティ情報の項目名」を参照してくださ
い。
ファイル名の変更時には「name」のみ必要がです。Documents
Move List、Documents Delete List では不要です。
第 1 章 SPA Web API リファレンス
127
キー 必須 値 備考
customProperties カスタムプロパティの情報
キーにはカスタムプロパティの ID、値にはカスタムプロパティの値
を指定します。
ファイル名の変更時には不要です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -411 文書定義で削除が禁止されている文書を削除しようとした場合に出力されま
す。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。パスにルート(「/」)が指定さ
れた場合や、システムフォルダーを削除しようとした場合です。
第 1 章 SPA Web API リファレンス
128
HTTP ステータス エラーコード 備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。ファイルの ID に、数
字以外の文字列を指定した場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
第 1 章 SPA Web API リファレンス
129
Documents History List 指定した文書のバージョン管理の履歴一覧を取得します。
URI
http://<hostname>:44230/spa/service/documents/<id>/historyList
• キー
キー 必須 値 備考
id 処理対象文書の ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
第 1 章 SPA Web API リファレンス
130
HTTP ステータス エラーコード 備考
404 -401 指定したファイルが存在しない場合に出力されます。
404 -424 指定した文書がバージョン管理の対象外の場合や、バージョン管理の対象外
の文書に version キーを指定した場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"versionList": [
{
"id": "1",
"documentId": "1001",
"majorVersion": 1,
"minorVersion": 0,
"documentHistoryId": "1",
"type": "OverwriteFile",
"note": "",
"createDate": "2017-04-12T12:11:32.813+0900",
"createUser": "1",
"createUserName": "yamada",
"customPropertyVersion": 1,
"annotationVersion": 1,
"pagememoVersion": 1,
"versionComment": "",
},
{
"id": "2",
第 1 章 SPA Web API リファレンス
131
出力例(JSON 形式)
"documentId": "1001",
"majorVersion": 2,
"minorVersion": 0,
"documentHistoryId": "2",
"type": "Restore",
"note": "1.0",
"createDate": "2017-04-13T14:09:44.887+0900",
"createUser": "2",
"createUserName": "t.sato",
"customPropertyVersion": 1,
"annotationVersion": 1,
"pagememoVersion": 1,
"versionComment": "",
},
...
]
}
■ データ内容
キー 値 備考
versionList バージョン管理の情報
id 文字列 履歴に割り当てられるシステムで一意の番号(ID)です。
documentId 文字列 文書の ID です。
majorVersion 数値 メジャーバージョンです。
minorVersion 数値 マイナーバージョンです。
documentHistoryId 文字列 文書ごとの履歴に割り当てられるシステムで一意の番号(ID)です。
type 文字列 履歴が作成された動作の種類です。
種類については「バージョン管理の動作の種類(P.132)」を参照してください。
note 文字列 履歴が作成された動作の種類の補足情報です。
復元したときのバージョン番号などです。
createDate 文字列 履歴が作成された日です。
ISO8601 RFC3339 W3CDTF(日付と時刻を T でつなげる)に準拠しています。
第 1 章 SPA Web API リファレンス
132
キー 値 備考
createUser 文字列 履歴が作成された動作を実施したユーザーに割り当てられるシステムで一意の
番号です。
createUserName 文字列 履歴が作成された動作を実施したユーザー名です。
customPropertyVersion 数値 カスタムプロパティのバージョンです。
annotationVersion 数値 注釈のバージョンです。
pagememoVersion 数値 ページメモのバージョンです。
versionComment 文字列 現在は使用されていません。
バージョン管理の動作の種類
バージョン管理の動作の種類は次のとおりです。
type 動作の種類
Restore 復元
ArchiveFile アーカイブ
FileLink リンクの作成
PageLink ページリンクの作成
MultiLink マルチリンクの作成
OverwriteFile 上書きアーカイブ
Annotation 注釈の更新
PageMemo ページメモの更新
AutoMask マスクの自動適用
ManualMask マスクの手動適用
CustomProperty カスタムプロパティ値の更新
Timestamp タイムスタンプの付与
SearchMask 検索結果へのマスク適用
Policy バージョン管理
SvfFieldData SVF 検索フィールドの編集
PageRotate 回転
第 1 章 SPA Web API リファレンス
133
Documents Restore 指定したバージョンの文書に復元します。
URI
http://<hostname>:44230/spa/service/documents/<id>/restore
• キー
キー 必須 値 備考
id 処理対象文書の ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
version 復元する文書のバージョン
addTimestamp 復元後の文書管理ポリシーに従って、復元された文書にタイムスタンプを付与するかどうか
• true
付与する
• false(デフォルト)
付与しない
applyMask 復元後の文書管理ポリシーに従って、復元された文書にマスクを付与するかどうか
• true
付与する
• false(デフォルト)
付与しない
第 1 章 SPA Web API リファレンス
134
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
パラメーターで指定した文書のバージョンが最新バージョンと同じ場合は復元を
行わず、0 を返します。この場合、文書のバージョンは変わりません。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
404 -423 指定したバージョンが存在しない場合に出力されます。
404 -424 指定した文書がバージョン管理の対象外の場合や、バージョン管理の対象外の文
書に version キーを指定した場合に出力されます。
403 -425 復元が許可されていない文書を指定した場合に出力されます。
500 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。version キーに正しくな
い値が指定された場合に出力されます。
第 1 章 SPA Web API リファレンス
135
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
136
6 リンク操作 リンク操作に関する API は、次のとおりです。
• Links List Get(P.137)
• Links Create(P.140)
• Links Set(P.145)
第 1 章 SPA Web API リファレンス
137
Links List Get 指定された文書を参照しているリンクの一覧を取得します。
URI
http://<hostname>:44230/spa/service/links/list
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
ids リンク元文書の ID 一覧 カンマ区切りで複数指定できます。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
138
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。リンク元文書の指定がな
い、または、リンク元文書の ID が数値でない場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"linkInfos": [
{
"srcId": "1",
"linkList": [
{
"documentId": "2",
"documentName": "doc1",
"folderId": "3",
"linkType": 1,
"srcPath": "/aaa/doc1"
},
{
"documentId": "4",
"documentName": "doc2",
"folderId": "5",
第 1 章 SPA Web API リファレンス
139
出力例(JSON 形式)
"linkType": 2,
"srcPath": "Unknown"
},
...
]
},
...
]
}
■ データ内容
キー 値 説明
linkInfos リンクの情報
srcId 文字列 リンクの元となった文書の ID です。
linkList リンク先の情報
documentId 文字列 作成されたリンクの文書 ID です。
documentName 文字列 作成されたリンクの文書名です。
folderId 文字列 リンクが作成されたフォルダーの ID です。
linkType 1 リンクです。
2 ページリンクです。
3 マルチリンクです。
srcPath 文字列 リンクが作成されたパスです。
アクセス権の問題で参照できなかった場合は「Unknown」が出力されます。
第 1 章 SPA Web API リファレンス
140
Links Create リンクの作成とカスタムプロパティ値の更新を行います。
URI
http://<hostname>:44230/spa/service/links/<srcId>
• キー
キー 必須 値 備考
srcId 処理対象文書の ID
HTTP メソッド
POST
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必
須
値 備考
destFolderId リンクの出力先(フ
ォルダー)の ID
destFolderId か destFolderPath のどちらかを必ず指定する必要
があります。
destFolderPath リンクの出力先(フ
ォルダー)の絶対パ
ス文字列
destFolderId か destFolderPath のどちらかを必ず指定する必要
があります。
name リンク名 指定がない場合は、リンク元ファイルの名前でリンクを作成し
ます。
overwrite 強制的に上書きする
かどうか
• true
上書きする
リンクの作成先(フォルダー)に、すでに同名のファイルまた
はリンクが存在している場合、強制的に上書きするかどうかの
指定です。
false を指定し、すでにファイルまたはリンクが存在している場
合は-400 エラーが返ります。
第 1 章 SPA Web API リファレンス
141
キー 必
須
値 備考
• false(デフォル
ト)
上書きしない
mkdirs リンク作成時にフォ
ルダーも作成するか
どうか
• true(デフォル
ト)
作成する
• false
作成しない
true の場合、必要なフォルダーを親フォルダーも含めてすべて
作成します。false の場合 destFolderPath で指定された親フォ
ルダーが存在しない場合、エラーになります。
customProperties カスタムプロパティ
一括更新用ファイル
カスタムプロパティ一括更新用ファイルについては、「カスタム
プロパティ一括更新用ファイルの書式(P.425)」を参照してくだ
さい。
カスタムプロパティの更新に 1 つでも失敗があった場合、リン
ク作成もエラーとなります。
• リンク作成時に customProperties の指定がない場合、リンク元のカスタムプロパティの値はカスタム
プロパティ作成時に定義した「linkto」の値に従って次のいずれかの動作になります。
○ 自動的に複製される
○ 既定値がセットされる
○ 値はセットされない
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• リンク先の文書に対するカスタムプロパティの値の変更は、リンク元の文書へは反映されません。
• カスタムプロパティ作成の Web API(Custom Properties Create(Ver. 2))の「edit」パラメーター
(カスタムプロパティの編集可否)の指定が false であっても、新たにリンクを作成する時には、
第 1 章 SPA Web API リファレンス
142
「customProperties」パラメーターで指定された「カスタムプロパティ一括更新用ファイル」の内容
に従って、すべての値が設定されます。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Location URL 処理に成功した場合、そのリソースを表す URL を付加します。
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-Error-Property-Id ID カスタムプロパティ値の更新に失敗した場合、最初に失敗したカ
スタムプロパティの ID を付加します。
X-Spa-Error-Property-Code エラーコード カスタムプロパティ値の更新に失敗した場合、失敗の内容につい
てのエラーコードを付加します。
X-Spa-Error-Property-
Message
エラーメッセージ • カスタムプロパティ値の更新に失敗した場合、失敗の内容
についてのエラーメッセージを付加します。
• URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。「mkdir」パラメーターに
「false」が指定された場合のみ出力されます。
400 -302 すでに同名のフォルダーが存在している場合に出力されます。「overwrite」パラ
メーターが true でもエラーになります。
400 -304 フォルダーの階層が管理画面の[フォルダーの最大階層数]に設定された値を超
える場合に出力されます。
400 -308 パス名に誤りがあります。次のいずれかの場合に出力されます。
• フルパスが「/」から始まっていない
第 1 章 SPA Web API リファレンス
143
HTTP ステータ
ス
エラーコー
ド
備考
• 個々のフォルダー名に誤りがある(個々のフォルダー名が-307 エラーの条
件に該当する)
• フルパスが 250 バイトを超えている
リンクを作成するフォルダーの指定がなかった場合も含みます。
400 -309 フォルダー数が、管理画面の[最大フォルダー数]に設定された値を超える場合
に出力されます。
400 -400 同名のファイルがすでに存在している場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -402 リンクを元文書としてリンクを作成した場合に出力されます。
400 -422 リンクの出力先パスがリンク元ファイルのパスと同じ場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 出力先に次のフォルダーが指定された場合など、指定した値に誤りがある場合に
出力されます。
• 「/」フォルダー
• ユーザールートフォルダー
• ドメインルートフォルダー(またはユーザールートフォルダー配下のドメイ
ンルートフォルダーと同階層のフォルダー)
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20804 アーカイブ、リンク作成、ページリンク作成において、カスタムプロパティ値の
更新に失敗した場合に出力されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Id」の値に最初に失敗したカ
スタムプロパティの ID が付加されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Code」の値に、エラーコー
ドが付加されます。
第 1 章 SPA Web API リファレンス
144
HTTP ステータ
ス
エラーコー
ド
備考
• レスポンスヘッダーの「X-Spa-Error-Property-Message」の値に、エラー
メッセージが付加されます。
400 -29001 「customProperties」が指定されていない場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "10",
"documentEntityVersion": 0,
"propertyEntityVersion": 0
}
■ データ内容
キー 値 備考
id 文字列 作成したリンクの ID です。
documentEntityVersion 数値 文書のエンティティバージョンです。
propertyEntityVersion 数値 文書プロパティのエンティティバージョンです。
第 1 章 SPA Web API リファレンス
145
Links Set 1 つの文書から複数のリンクを作成します。
URI
http://<hostname>:44230/spa/service/links/
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクト例(JSON 形式)
{
"overwrite": "true",
"mkdirs": "true",
"id": "1",
"links": [
{
"type": "2",
"pages": [
{ "from": "1", "to": "3" }
],
"folderPath": "リンクを作成するフォルダーのパス 1",
"customProperties": {
"1": "値 1AAA",
"2": "値 2AAA"
}
},
{
第 1 章 SPA Web API リファレンス
146
オブジェクト例(JSON 形式)
"type": "1",
"folderId": "20",
"name": "リンク名 1",
"customProperties": {
"1": "値 1AAA"
}
},
{
"type": "1",
"folderPath": "リンクを作成するフォルダーのパス 2",
"name": "リンク名 2"
}
]
}
■ データ内容
キー 必須 値 備考
overwrite *1 true リンク作成先のパスにすでにファイルまたはリンクが存在している場合
に、強制的に上書きします。
false リンク作成先のパスにすでに同名のファイルまたはリンクが存在している
場合は、エラーコード-400(同名のファイルがすでに存在している)が返
ります。
指定されていない場合は、false が指定されたものとします。
mkdirs true 指定されたリンク作成先パスのフォルダーが未作成の場合に、自動的にフ
ォルダーを作成します。
指定されていない場合は、true が指定されたものとします。
false 指定されたフォルダーが未作成の場合は、エラーコード-301(フォルダー
が存在しない)が返ります。
id 文字列 リンク元ファイルの ID です。必須です。
links リンク先の情報
複数のリンク作成先定義をまとめる要素です。必須です。
type 1 通常のリンクです。「1」か「2」を必ず指定する必要があります。
第 1 章 SPA Web API リファレンス
147
キー 必須 値 備考
2 ページリンクです。「1」か「2」を必ず指定する必要があります。
folderId (*2) 文字列 リンクを作成するフォルダーの ID です。folderId と folderPath のいずれ
か 1 つが必須です。
folderPath (*2) 文字列 リンクを作成するフォルダーのパスです。folderId の指定がない場合のみ
利用されます。folderId と folderPath のいずれか 1 つが必須です。
name 文字列 リンク名です。指定がない場合、リンク元と同じ名前でリンクが作成され
ます。
pages (*3) ページリンク情報
ページリンク時のページ定義をまとめる要素です。リンク種別がページリ
ンクのときのみ必須です。
同一 pages 要素内の page 要素に指定されているページ番号に重複があっ
た場合はエラーになります。
from (*3) 文字列 ページリンク時の開始ページ番号として、元文書のページ番号を指定しま
す。リンク種別がページリンクのときのみ必須です。
先頭ページは「1」として指定します。
to (*3) 文字列 ページリンク時の終了ページ番号として、元文書のページ番号を指定しま
す。リンク種別がページリンクのときのみ必須です。
最終ページ(最大値)は、ファイルのプロパティで表示される「ページ
数」です。
customProperties カスタムプロパティの更新内容
書式は、カスタムプロパティ一括更新用ファイルと同じです。
カスタムプロパティ一括更新用ファイルについては、「カスタムプロパティ
一括更新用ファイルの書式(P.425)」を参照してください。
*1 「overwrite」パラメーターの指定は、カスタムプロパティ作成の Web API(Custom Properties Create
(Ver. 2))の「edit」パラメーター(カスタムプロパティの編集可否)の指定を上回ります。overwrite を
true とした場合は、編集不可としたカスタムプロパティの値も指定された値ですべて更新されます。
*2 どちらか 1 つの指定が必須です。
*3 「type」が「2(ページリンク)」の場合に必須です。
第 1 章 SPA Web API リファレンス
148
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• 複数指定されているリンクのうち、1 つでも作成に失敗した場合はすべてのリンクが作成されません。
• カスタムプロパティ作成の Web API(Custom Properties Create(Ver. 2))の「edit」パラメーター
(カスタムプロパティの編集可否)の指定が false であっても、新たにリンクを作成する時には、
「customProperties」パラメーターで指定された「カスタムプロパティ一括更新用ファイル」の内容
に従って、すべての値が設定されます。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-Error-Property-Id ID カスタムプロパティ値の更新に失敗した場合、最初に失敗した
カスタムプロパティの ID を付加します。
X-Spa-Error-Property-Code エラーコード カスタムプロパティ値の更新に失敗した場合、失敗の内容につ
いてのエラーコードを付加します。
X-Spa-Error-Property-Message エラーメッセージ • カスタムプロパティ値の更新に失敗した場合、失敗の内容
についてのエラーメッセージを付加します。
• URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
149
HTTP ステータ
ス
エラーコー
ド
備考
404 -301 指定したフォルダーが存在しない場合に出力されます。「mkdir」パラメーターに
「false」が指定された場合のみ出力されます。
400 -302 すでに同名のフォルダーが存在している場合に出力されます。「overwrite」パラ
メーターが true でもエラーになります。
400 -304 フォルダーの階層が管理画面の[フォルダーの最大階層数]に設定された値を超
える場合に出力されます。
400 -308 パス名に誤りがあります。次のいずれかの場合に出力されます。
• フルパスが「/」から始まっていない
• 個々のフォルダー名に誤りがある(個々のフォルダー名が-307 エラーの条
件に該当する)
• フルパスが 250 バイトを超えている
リンクを作成するフォルダーの指定がなかった場合も含みます。
400 -309 フォルダー数が、管理画面の[最大フォルダー数]に設定された値を超える場合
に出力されます。
400 -400 同名のファイルがすでに存在している場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -402 リンクを元文書としてリンクを作成した場合に出力されます。
400 -407 ページリンクの作成時、存在しないページへのリンクを作成しようとした場合に
出力されます。ページリンクで指定したページ番号が、元文書のページ数を超え
ている場合などです。
400 -422 リンクの出力先パスがリンク元ファイルのパスと同じ場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 出力先に次のフォルダーが指定された場合など、指定した値に誤りがある場合に
出力されます。
• 「/」フォルダー
• ユーザールートフォルダー
• ドメインルートフォルダー(またはユーザールートフォルダー配下のドメイ
ンルートフォルダーと同階層のフォルダー)
第 1 章 SPA Web API リファレンス
150
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。ページリンクにおいて同一
ページが重複して指定された場合などにも出力されます。
400 -20804 アーカイブ、リンク作成、ページリンク作成において、カスタムプロパティ値の
更新に失敗した場合に出力されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Id」の値に最初に失敗したカ
スタムプロパティの ID が付加されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Code」の値に、エラーコー
ドが付加されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Message」の値に、エラー
メッセージが付加されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"results": [
{
"linkId": "1",
"folderId": "2",
"folderPath": "/abc/",
"linkName": "link1.pdf",
"documentEntityVersion": 0,
"propertyEntityVersion": 0
第 1 章 SPA Web API リファレンス
151
出力例(JSON 形式)
},
{
"linkId": "3",
"folderId": "4",
"folderPath": "/def/"
"linkName": "link2.pdf",
"documentEntityVersion": 0,
"propertyEntityVersion": 0
}
]
}
■ データ内容
キー 値 備考
results 作成したリンクの情報
linkId 文字列 作成したリンクの ID です。
folderId 文字列 作成したリンクの親フォルダーの ID です。
folderPath 文字列 作成したリンクの親フォルダーのパスです。
linkName 文字列 作成したリンク名です。
documentEntityVersion 数値 文書のエンティティバージョンです。
propertyEntityVersion 数値 文書プロパティのエンティティバージョンです。
第 1 章 SPA Web API リファレンス
152
7 マルチリンク マルチリンクに関する API は、次のとおりです。
• Multi Links Page Get(P.153)
• Multi Links Set(P.156)
• Multi Links Update(P.160)
第 1 章 SPA Web API リファレンス
153
Multi Links Page Get マルチリンクのページ情報を取得します。
URI
http://<hostname>:44230/spa/service/links/multi/<id>
• キー
キー 必須 値 備考
id 取得対象の文書の ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
154
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
対象がマルチリンクでない場合の出力例(JSON 形式)
{
"linkBases": [
]
}
対象がマルチリンクの場合の出力例(JSON 形式)
{
"linkBases": [
{
"id": "1",
"pages": "1-2,4",
"name": "name1.pdf",
"folderId": "1",
"folderPath": "/aaa/",
"pageCount": 5
},
{
"id": "2",
"pages": "6-2"
"name": null,
"folderId": null,
第 1 章 SPA Web API リファレンス
155
対象がマルチリンクの場合の出力例(JSON 形式)
"folderPath": null,
"pageCount": null,
},
{
"id": "1",
"pages": "2"
"name": "name1.pdf",
"folderId": "1",
"folderPath": "/aaa/",
"pageCount": 5
}
]
}
■ データ内容
キー 値 備考
linkBases リンク元の文書の情報
id 文字列 リンク元の文書 ID です。
pages 文字列 対象ページです。複数ページの場合は、カンマ区切りによるページ指定またはハイフンによ
る範囲指定で出力されます。
name 文字列 リンク元の文書名です。
リンク元のアクセス権の変更等でリンク元文書の情報が取得できなかった場合は、null が返
ります。
folderId 文字列 リンク元文書が存在するフォルダーの ID です。
リンク元のアクセス権の変更等でリンク元文書の情報が取得できなかった場合は、null が返
ります。
folderPath 文字列 リンク元文書が存在するフォルダーパスです。
リンク元のアクセス権の変更等でリンク元文書の情報が取得できなかった場合は、null が返
ります。
pageCount 数値 リンク元文書の総ページ数です。
リンク元のアクセス権の変更等でリンク元文書の情報が取得できなかった場合は、null が返
ります。
第 1 章 SPA Web API リファレンス
156
Multi Links Set マルチリンクを作成します。
URI
http://<hostname>:44230/spa/service/links/multi/
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"folderId": "10",
"name": "link.pdf",
"overwrite": true,
"linkBases": [
{
"id": "1",
"pages": "1-2,4"
},
{
"id": "2",
"pages": "6-2"
},
{
"id": "1",
"pages": "2"
}
第 1 章 SPA Web API リファレンス
157
本体の例(JSON 形式)
],
"pdfProperty": {
"title": "PDF タイトル",
"subject": "サブタイトル",
"keywords": "キーワード"
}
}
■ データ内容
キー 必
須
値 備考
folderId 文字列 リンク出力先のフォルダーID です。必ず指定する必要があります。
name 文字列 リンク名です。必ず指定する必要があります。
overwrite true リンク作成先のパスにすでにファイルまたはリンクが存在している場合に、強制的に
上書きします。
false リンク作成先のパスにすでにファイルまたはリンクが存在している場合は、 エラーと
なります。
指定されていない場合は、false が指定されたものとします。
linkBases リンク元になる文書の情報
指定した順番で PDF が構成されます。
id 文字列 リンク元の文書 ID です。必ず指定する必要があります。
pages 文字列 対象ページ番号です。必ず指定する必要があります。複数ページを指定する場合はカ
ンマ区切りまたはハイフンによる範囲指定を行います。
pdfProperty PDF プロパティに設定する値
title 文字列 PDF プロパティのタイトルです。
subject 文字列 PDF プロパティのサブタイトルです。
keywords 文字列 PDF プロパティのキーワードです。
第 1 章 SPA Web API リファレンス
158
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -308 パス名に誤りがあります。次のいずれかの場合に出力されます。
• フルパスが「/」から始まっていない
• 個々のフォルダー名に誤りがある(個々のフォルダー名が-307 エラーの条
件に該当する)
• フルパスが 250 バイトを超えている
リンク名が正しくない以外でも、リンク出力先のフォルダーID、リンク名、リン
ク元の文書 ID の指定がない場合にも出力されます。
400 -400 同名のファイルがすでに存在している場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -402 リンクを元文書としてリンクを作成した場合に出力されます。
400 -407 ページリンクの作成時、存在しないページへのリンクを作成しようとした場合に
出力されます。
第 1 章 SPA Web API リファレンス
159
HTTP ステータ
ス
エラーコー
ド
備考
400 -422 リンクの出力先パスがリンク元ファイルのパスと同じ場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。リンク先のフォルダーにルート
「/」が指定された場合です。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。マルチリンクの総ページ
数が設定された制限値を超えた場合です。
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "10",
"documentEntityVersion": 0,
"propertyEntityVersion": 0
}
■ データ内容
キー 値 備考
id 文字列 作成したリンクの文書 ID です。
documentEntityVersion 数値 文書のエンティティバージョンです。
propertyEntityVersion 数値 文書プロパティのエンティティバージョンです。
第 1 章 SPA Web API リファレンス
160
Multi Links Update マルチリンクの構成を変更します。
URI
http://<hostname>:44230/spa/service/links/multi/update/<id>
• キー
キー 必須 値 備考
id 取得対象の文書の ID
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"linkBases": [
{
"id": "1",
"pages": "1-2,4"
},
{
"id": "2",
"pages": "6-2"
},
{
"id": "1",
"pages": "2"
第 1 章 SPA Web API リファレンス
161
本体の例(JSON 形式)
}
],
"pdfProperty": {
"title": "PDF タイトル",
"subject": "サブタイトル",
"keywords": "キーワード"
},
"condition": {
"useDocumentEntityVersion": true,
"documentEntityVersion": 1,
"usePropertyEntityVersion": true,
"propertyEntityVersion": 1
}
}
■ データ内容
キー 必須 値 備考
linkBases リンク元になる文書の情報
指定を省略した場合は、リンク元になる文書の情報は変更されませ
ん。
id 文字列 リンク元の文書 ID です。
pages 文字列 対象ページ番号です。複数ページを指定する場合はカンマ区切りま
たはハイフンによる範囲指定を行います。
pdfProperty PDF プロパティに設定する値
指定を省略した場合は、PDF プロパティの値は変更されません。
title 文字列 PDF プロパティのタイトルです。
空文字を指定すると値を削除できます。
subject 文字列 PDF プロパティのサブタイトルです。
空文字を指定すると値を削除できます。
keywords 文字列 PDF プロパティのキーワードです。
空文字を指定すると値を削除できます。
第 1 章 SPA Web API リファレンス
162
キー 必須 値 備考
condition 更新条件
指定を省略した場合は、文書と文書プロパティのエンティティバー
ジョンを確認しません。
useDocumentEntityVersion true 更新時に文書のエンティティバージョンを確認します。
指定されていない場合は、true が指定されたものとします。
false 更新時に文書のエンティティバージョンを確認しません。
documentEntityVersion 数値 文書のエンティティバージョンです。
usePropertyEntityVersion true 更新時に文書プロパティのエンティティバージョンを確認します。
指定されていない場合は、true が指定されたものとします。
false 更新時に文書プロパティのエンティティバージョンを確認しませ
ん。
propertyEntityVersion 数値 文書プロパティのエンティティバージョンです。
*1 どちらか 1 つの指定が必須です。
*2 「linkBases」を指定した場合に必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
163
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -308 パス名に誤りがあります。次のいずれかの場合に出力されます。
• フルパスが「/」から始まっていない
• 個々のフォルダー名に誤りがある(個々のフォルダー名が-307 エラーの条
件に該当する)
• フルパスが 250 バイトを超えている
リンク元の文書 ID の指定がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -407 ページリンクの作成時、存在しないページへのリンクを作成しようとした場合に
出力されます。
400 -409 アーカイブされた文書を更新する際、対象の文書を開いたときのバージョンとサ
ーバーに保管されている文書のバージョンが一致しなかった場合に出力されま
す。
400 -410 ロックされている文書の文書属性を更新しようとした場合に出力されます。
400 -417 マルチリンクではない文書をマルチリンクとして構成変更しようとした場合に出
力されます。
400 -458 プロパティ値の更新時にバージョンを更新条件としたが、指定したバージョンと
一致しなかった場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
第 1 章 SPA Web API リファレンス
164
HTTP ステータ
ス
エラーコー
ド
備考
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "1",
"documentEntityVersion": 2,
"propertyEntityVersion": 3
}
■ データ内容
キー 値 備考
id 文字列 対象の文書 ID です。
documentEntityVersion 数値 更新後の文書のエンティティバージョンです。
propertyEntityVersion 数値 更新後の文書プロパティのエンティティバージョンです。
第 1 章 SPA Web API リファレンス
165
8 文書のコメント 文書のコメントに関する API は、次のとおりです。
• Documents Comments Get(P.166)
• Documents Comments Add(P.169)
第 1 章 SPA Web API リファレンス
166
Documents Comments Get 指定した文書のコメントを取得します。
URI
http://<hostname>:44230/spa/service/documents/<id>/comments
• キー
キー 必須 値 備考
id 取得対象の文書の ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
第 1 章 SPA Web API リファレンス
167
HTTP ステータ
ス
エラーコー
ド
備考
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。対象文書のレビュア
ーに指定されている場合はエラーとはならず、type が「REVIEW」のコメントの
みが取得されます。
404 -401 指定したファイルが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"commentList": [
{
"id": "10",
"type": "VOLUNTARY",
"userId": "1",
"userName": "user",
"userFullname": "fullname",
"deletedUser": false,
"comment": "comment",
"addDate": "2015-11-30T23:02:40.041+0900",
"threadUpdateDate": "2016-01-14T15:24:14.933+0900",
"children": [
{
"id": "20",
"type": "VOLUNTARY",
第 1 章 SPA Web API リファレンス
168
出力例(JSON 形式)
"userId": "2",
"userName": "user2",
"userFullname": "fullname2",
"deletedUser": false,
"comment": "comment2",
"addDate": "2016-01-14T15:24:14.933+0900",
"threadUpdateDate": "2016-01-14T15:24:14.933+0900",
"children": []
}
]
},
...
]
}
■ データ内容
キー 値 備考
commentList 文書のコメント情報
id 文字列 コメントの ID です。
type VOLUNTARY 任意のコメントです。
REVIEW レビュー確認時のコメントです。
userId 文字列 コメントを追加したユーザーの ID です。
userName 文字列 コメントを追加したユーザーのユーザー名です。
userFullname 文字列 コメントを追加したユーザーのユーザーフルネームです。
deletedUser true 削除されたユーザーです。
false 存在するユーザーです。
comment 文字列 文書のコメントです。
addDate 文字列 登録時の日時です。
threadUpdateDate 文字列 コメントが含まれるスレッドの更新日時です。
children 子コメントの情報
第 1 章 SPA Web API リファレンス
169
Documents Comments Add 指定した文書にコメントを追加します。
URI
http://<hostname>:44230/spa/service/documents/<id>/comments
• キー
キー 必須 値 備考
id 取得対象の文書の ID
HTTP メソッド
POST
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必須 値 備考
comment コメントの文字列 1 文字以上を指定する必要があります。
parentId 親コメントの ID 親コメントがない場合は省略します。
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
第 1 章 SPA Web API リファレンス
170
キー 値の内容 備考
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。文書のコメントが指定さ
れない場合、コメントの文字数が設定された制限値を超えた場合に出力されま
す。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
171
9 ページメモ ページメモに関する API は、次のとおりです。
• PageMemo Get(Ver. 2)(P.172)
• PageMemo Update(P.175)
第 1 章 SPA Web API リファレンス
172
PageMemo Get(Ver. 2) 指定したページのページメモの情報を取得します。
URI
http://<hostname>:44230/spa/service/pagememo_v2/<id>/<page>
• キー
キー 必須 値 備考
id 取得対象の文書の ID
page ページ番号
HTTP メソッド
GET
▌パラメーター
キー 必須 値 備考
version 取得対象となる文書
のバージョン
文書がバージョン管理対象の場合に指定します。version キー自体の指定が
ない場合は、最新バージョンが指定されたものとします。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
173
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
404 -423 指定したバージョンが存在しない場合に出力されます。
404 -424 指定した文書がバージョン管理の対象外の場合や、バージョン管理の対象外の文
書に version キーを指定した場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイルを
指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指定し
た場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。version キーに正しくない値が指定された場合に出力されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。0 以下や文書のページ数以上のページ番号が指定された場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
ページメモが存在する場合の出力例(JSON 形式)
{
"pagememoEntityVersion": 1,
第 1 章 SPA Web API リファレンス
174
ページメモが存在する場合の出力例(JSON 形式)
"pagememo": "ページメモの情報"
}
ページメモが存在しない場合の出力例(JSON 形式)
{
"pagememoEntityVersion": 1,
"pagememo": null
}
■ データ内容
キー 値 備考
pagememoEntityVersion 数値 ページメモのエンティティバージョンです。
pagememo 文字列 ページメモの情報です。
ページメモが存在しない場合は、null が返ります。
第 1 章 SPA Web API リファレンス
175
PageMemo Update 指定したページのページメモの情報を更新します。
URI
http://<hostname>:44230/spa/service/pagememo/<id>
• キー
キー 必須 値 備考
id 処理対象の文書 ID
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"pagememos": {
"1": "1 ページ目のページメモの情報",
"3": "3 ページ目のページメモの情報",
"5": "5 ページ目のページメモの情報"
},
"condition": {
"usePagememoEntityVersion": true,
"pagememoEntityVersion": 1
}
}
第 1 章 SPA Web API リファレンス
176
■ データ内容
キー 必須 値 備考
pagememos 更新対象ページのページ番号とそのページメモの一覧
キーと値のペアで指定します。
• 指定のなかったページのページメモは変更されません。
• ページメモに空文字を指定した場合、ページメモは削除されま
す。
• ページメモは、管理画面で設定した[ページメモの最大文字
数](初期値は 1000 文字)以内で指定します。
condition ページメモを更新する際に確認する条件
指定がない場合はページメモのエンティティバージョンを確認しま
せん。
usePagememoEntityVersion true ページメモを更新する際にページメモのエンティティバージョンを
確認します。
指定されていない場合は、true が指定されたものとします。
false ページメモを更新する際にページメモのエンティティバージョンを
確認しません。
pagememoEntityVersion 数値 ページメモのエンティティバージョンです。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
177
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -1201 ページメモのエンティティバージョンが指定されたエンティティバージョン
と一致しない場合に出力されます。usePagememoEntityVersion が「true」
の場合にのみ出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイ
ルを指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指
定した場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。ページメモの文字数
が設定された制限値を超えた場合にも出力されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "1",
"pagememoEntityVersion", 5
}
第 1 章 SPA Web API リファレンス
178
■ データ内容
キー 値 備考
id 文字列 文書 ID です。
pagememoEntityVersion 数値 ページメモのエンティティバージョンです。
第 1 章 SPA Web API リファレンス
179
10 フォルダー操作 フォルダーの操作に関する API は次のとおりです。
• Folders Lookup(P.180)
• Folders All(Ver. 2)(P.183)
• Folders List(Ver. 2)(P.187)
• Folders Open List(Ver. 2)(P.191)
• Folders Get(Ver. 2)(P.198)
• Folders Info Get(P.201)
• Folders Create(Ver. 2)(P.204)
• Folders Rename(Ver. 2)(P.207)
第 1 章 SPA Web API リファレンス
180
Folders Lookup フォルダー名からフォルダーID を取得します。
URI
http://<hostname>:44230/spa/service/folders/lookup
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"lookupTableList": [
{
"name": "/folder1"
},
{
"name": "/folder2"
},
...
]
}
■ データ内容
キー 必須 値 備考
lookupTableList フォルダー名のリスト
name 文字列 フォルダー名です。フルパスで指定してください。
第 1 章 SPA Web API リファレンス
181
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"lookupTableList": [
{
"name": "/folder1",
第 1 章 SPA Web API リファレンス
182
出力例(JSON 形式)
"id": "10"
},
{
"name": "/folder2",
"id": null
},
...
]
}
■ データ内容
キー 値 備考
lookupTableList フォルダー名のリスト
name 文字列 フォルダー名です。
id 文字列 フォルダー名から取得するフォルダーID です。フォルダーが存在しない場合は null にな
ります。
フォルダーのアクセス権がない場合、存在しないものとして扱います。
第 1 章 SPA Web API リファレンス
183
Folders All(Ver. 2) すべてのフォルダー情報のリストを取得します。
URI
http://<hostname>:44230/spa/service/folders_v2
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
184
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"folderList": [
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=2",
"id": 2,
"parentId": 1,
"folderType": "PUBLIC",
"path": "/folder1",
"name": "folder1",
"childrenCount": 0,
"children": [
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=4",
"id": 4,
"parentId": 2,
"folderType": "PUBLIC",
"path": "/folder1/f_1",
"name": "f_1",
"childrenCount": 0,
"children": []
},
],
第 1 章 SPA Web API リファレンス
185
出力例(JSON 形式)
},
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=3",
"id": 3,
"parentId": 1,
"folderType": "PUBLIC",
"path": "/folder2",
"name": "folder2",
"childrenCount": 0,
"children": []
}
]
}
■ データ内容
キー 値 備考
folderList フォルダー情報のリスト
「フォルダー情報に関するキーについて(P.185)」を参照してください。
フォルダー情報に関するキーについて
キー 値 備考
type folder フォルダーを示します。
directUrl 文字列 フォルダーの URL リンクです。
id 数値 フォルダーID です。
name 文字列 フォルダー名です。
parentId 数値 親フォルダーのフォルダーID です。
folderType 文字列 フォルダーの種類です。
文字列 説明
ROOT システムルート(システム全体のルート)です。
PUBLIC パブリックフォルダーです。
第 1 章 SPA Web API リファレンス
186
キー 値 備考
USER_ROOT ユーザールートです。
DOMAIN_ROOT ドメインルートです。
USER_HOME ユーザーホーム(マイフォルダーのルート)です。
PERSONAL マイフォルダーです。
UNDEFINED_DOMAIN_ROOT ドメインルート(未定義)です。ユーザールート配下
で、まだ確定していないフォルダーです。
UNDEFINED_USER_HOME ユーザーホーム(未定義)です。ドメインルート(未定
義)配下で、まだ確定していないフォルダーです。
path 文字列 フォルダーの絶対パスです。
childrenCount 数値 子フォルダーの要素数です。常に 0 です。
children 子フォルダーのリストです。
第 1 章 SPA Web API リファレンス
187
Folders List(Ver. 2) 指定したフォルダー直下にあるフォルダーのリストを取得します。
URI
http://<hostname>:44230/spa/service/folders_v2/<id>/list
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
188
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"folderList": [
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=2",
"id": 2,
"parentId": 1,
"folderType": "PUBLIC",
"path": "/folder1",
"name": "folder1",
"childrenCount": 1,
"children": [
{
"type": "hasFolder"
}
]
},
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=3",
第 1 章 SPA Web API リファレンス
189
出力例(JSON 形式)
"id": 3,
"parentId": 1,
"folderType": "PUBLIC",
"path": "/folder2",
"name": "folder2",
"childrenCount": 0,
"children": []
}
]
}
■ データ内容
キー 値 備考
folderList フォルダー情報のリスト
「フォルダー情報に関するキーについて(P.189)」を参照してください。
フォルダー情報に関するキーについて
キー 値 備考
type folder フォルダーを示します。設定時には必須です。
hasFolder Folders List で有効です。children キーの値に含まれる際に「子フォルダーが存在す
る」ことを示します。
directUrl 文字列 フォルダーの URL リンクです。
id 数値 フォルダーID です。
name 文字列 フォルダー名です。
parentId 数値 親フォルダーのフォルダーID です。
folderType 文字列 フォルダーの種類です。
文字列 説明
ROOT システムルート(システム全体のルート)です。
PUBLIC パブリックフォルダーです。
USER_ROOT ユーザールートです。
DOMAIN_ROOT ドメインルートです。
第 1 章 SPA Web API リファレンス
190
キー 値 備考
USER_HOME ユーザーホーム(マイフォルダーのルート)です。
PERSONAL マイフォルダーです。
UNDEFINED_DOMAIN_ROOT ドメインルート(未定義)です。ユーザールート配
下で、まだ確定していないフォルダーです。
UNDEFINED_USER_HOME ユーザーホーム(未定義)です。ドメインルート
(未定義)配下で、まだ確定していないフォルダー
です。
path 文字列 フォルダーの絶対パスです。
childrenCount 数値 子フォルダーの要素数です。
children 子フォルダーのリスト
第 1 章 SPA Web API リファレンス
191
Folders Open List(Ver. 2) 指定したフォルダーまで展開したフォルダーのリストを取得します。
URI
http://<hostname>:44230/spa/service/folders_v2/<id>/open
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
192
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"folderList": [
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=103",
"id": "103",
"parentId": "1",
"folderType": "PUBLIC",
"path": "/folder1",
"name": "folder1",
"childrenCount": 3,
"children": [
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=104",
"id": "104",
"parentId": "103",
"folderType": "PUBLIC",
"path": "/folder1/folder1-1",
"name": "folder1-1",
第 1 章 SPA Web API リファレンス
193
出力例(JSON 形式)
"childrenCount": 1,
"children": [
{
"type": "hasFolder"
}
]
},
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=105",
"id": "105",
"parentId": "103",
"folderType": "PUBLIC",
"path": "/folder1/folder1-2",
"name": "folder1-2",
"childrenCount": 1,
"children": [
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=107",
"id": "107",
"parentId": "105",
"folderType": "PUBLIC",
"path": "/folder1/folder1-2/folder1-2-1",
"name": "folder1-2-1",
"childrenCount": 0,
"children": []
}
]
},
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=106",
第 1 章 SPA Web API リファレンス
194
出力例(JSON 形式)
"id": "106",
"parentId": "103",
"folderType": "PUBLIC",
"path": "/folder1/folder1-3",
"name": "folder1-3",
"childrenCount": 1,
"children": [
{
"type": "hasFolder"
}
]
}
]
},
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=2",
"id": "2",
"parentId": "1",
"folderType": "PUBLIC",
"path": "/Users",
"name": "Users",
"childrenCount": 1,
"children": [
{
"type": "hasFolder"
}
]
}
]
}
第 1 章 SPA Web API リファレンス
195
■ データ内容
キー 値 備考
folderList フォルダー情報のリスト
「フォルダー情報に関するキーについて(P.195)」を参照してください。
フォルダー情報に関するキーについて
キー 値 備考
type folder フォルダーを示します。
hasFolder children キーの値に含まれる際に「子フォルダーが存在する」ことを示します。
directUrl 文字列 フォルダーの URL リンクです。
id 数値 フォルダーID です。
name 文字列 フォルダー名です。
parentId 数値 親フォルダーのフォルダーID です。
folderType 文字列 フォルダーの種類です。
文字列 説明
ROOT システムルート(システム全体のルート)です。
PUBLIC パブリックフォルダーです。
USER_ROOT ユーザールートです。
DOMAIN_ROOT ドメインルートです。
USER_HOME ユーザーホーム(マイフォルダーのルート)です。
PERSONAL マイフォルダーです。
UNDEFINED_DOMAIN_ROOT ドメインルート(未定義)です。ユーザールート配
下で、まだ確定していないフォルダーです。
UNDEFINED_USER_HOME ユーザーホーム(未定義)です。ドメインルート
(未定義)配下で、まだ確定していないフォルダー
です。
path 文字列 フォルダーの絶対パスです。
childrenCount 数値 子フォルダーの要素数です。
children 子フォルダーのリスト
第 1 章 SPA Web API リファレンス
196
• 「children」の値については、次のいずれかになります。
○ フォルダー情報を返す場合、type:"folder"を持つフォルダー情報のリスト
○ フォルダー情報を返さない場合で子フォルダーが存在する場合、type:"hasFolder"を 1 つだけ持つ
リスト
○ フォルダー情報を返さない場合で子フォルダーが存在しない場合、空リスト
■ 出力内容について
フォルダー構成が、次のような場合の出力内容について説明します。
フォルダーの構成
/folder1
/folder11
/folder111
/folder112
/folder12
/folder121
/folder122
/folder13
/folder131
/folder132
/folder2
/folder21
/folder22
/folder23
/folder1/folder12/folder121(*1)の ID を指定した場合、(*2)のフォルダー情報を取得します。
folder121 を指定した場合の例
/folder1(*2)
/folder11(*2)
/folder111
/folder112
/folder12(*2)
/folder121(*1)(*2)
/folder122(*2)
第 1 章 SPA Web API リファレンス
197
folder121 を指定した場合の例
/folder13(*2)
/folder131
/folder132
/folder2(*2)
/folder21
/folder22
/folder23
第 1 章 SPA Web API リファレンス
198
Folders Get(Ver. 2) 指定したパスのフォルダー情報を取得します。
URI
http://<hostname>:44230/spa/service/folders_v2/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
199
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=2",
"id": 2,
"parentId": 0,
"folderType": "PUBLIC",
"path": "/folder1",
"name": "folder1",
"childrenCount": 0,
"children": []
}
■ データ内容
キー 値 備考
type folder フォルダーを示します。
directUrl 文字列 フォルダーの URL リンクです。
id 数値 フォルダーID です。
name 文字列 フォルダー名です。
parentId 数値 親フォルダーのフォルダーID です。Folders Get(Ver. 2)では無効です。
第 1 章 SPA Web API リファレンス
200
キー 値 備考
folderType 文字列 フォルダーの種類です。
文字列 説明
ROOT システムルート(システム全体のルート)です。
PUBLIC パブリックフォルダーです。
USER_ROOT ユーザールートです。
DOMAIN_ROOT ドメインルートです。
USER_HOME ユーザーホーム(マイフォルダーのルート)です。
PERSONAL マイフォルダーです。
UNDEFINED_DOMAIN_ROOT ドメインルート(未定義)です。ユーザールート配下
で、まだ確定していないフォルダーです。
UNDEFINED_USER_HOME ユーザーホーム(未定義)です。ドメインルート(未定
義)配下で、まだ確定していないフォルダーです。
path 文字列 フォルダーの絶対パスです。
childrenCount 数値 子フォルダーの要素数です。常に 0 です。
children 子フォルダーのリスト
Folders Get(Ver. 2)では常に空要素になります。
第 1 章 SPA Web API リファレンス
201
Folders Info Get 指定したフォルダー内に含まれるフォルダーやファイルなどの概要情報を取得します。
URI
http://<hostname>:44230/spa/service/folders/<id>/info
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
202
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"folders": "2",
"documents": "11",
"realFiles": "5",
"fileLinks": "2",
"pageLinks": "3",
"multiLinks": "1",
"documentPages": "22",
"realFilePages": "10",
"fileLinkPages": "4",
"pageLinkPages": "6",
"multiLinkPages": "2"
}
■ データ内容
キー 値 備考
folders 文字列 指定したフォルダー内に含まれるフォルダー数です。
documents 文字列 指定したフォルダー内に含まれる実ファイル、リンク、ページリンク、マルチリンクの
合計です。
realFiles 文字列 指定したフォルダー内に含まれるファイル数です。
第 1 章 SPA Web API リファレンス
203
キー 値 備考
fileLinks 文字列 指定したフォルダー内に含まれるリンク数です。
pageLinks 文字列 指定したフォルダー内に含まれるページリンク数です。
multiLinks 文字列 指定したフォルダー内に含まれるマルチリンク数です。
documentPages 文字列 指定したフォルダー内に含まれる全文書のページ数です。次の文書の合計ページ数で
す。
• 実ファイル
• リンク
• ページリンク
• マルチリンク
realFilePages 文字列 指定したフォルダー内に含まれる実ファイルのページ数です。
fileLinkPages 文字列 指定したフォルダー内に含まれるリンクのページ数です。
pageLinkPages 文字列 指定したフォルダー内に含まれるページリンクのページ数です。
multiLinkPages 文字列 指定したフォルダー内に含まれるマルチリンクのページ数です。
第 1 章 SPA Web API リファレンス
204
Folders Create(Ver. 2) フォルダーを作成します。
URI
http://<hostname>:44230/spa/service/folders_v2
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"type": "folder",
"parentId": 1,
"name": "folder1",
}
■ データ内容
キー 必須 値 備考
type folder フォルダーを示します。設定時には必須です。
parentId 数値 親フォルダーのフォルダーID です。設定時には必須です。
name 文字列 フォルダー名です。設定時には必須です。
次の制限があります。
• 半角ドット(.)から始まらない
• ¥ / : * ? " < > ¥ | がない
• 1~250 バイトで指定する
第 1 章 SPA Web API リファレンス
205
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。作成対象のフォルダーの
親フォルダーが存在しない場合も出力されます。
400 -302 すでに同名のフォルダーが存在している場合に出力されます。
400 -304 フォルダーの階層が管理画面の[フォルダーの最大階層数]に設定された値を超
える場合に出力されます。
400 -305 フォルダーの階層が管理画面の[フォルダー内の最大サブフォルダー数]に設定
された値を超える場合に出力されます。
400 -307 フォルダー名に誤りがあります。次のいずれかの場合に出力されます。
• フォルダー名が半角ドットから始まっている
• フォルダー名に¥ / : * ? " < > |が使用されている
• フォルダー名が 250 バイトを超えている
第 1 章 SPA Web API リファレンス
206
HTTP ステータ
ス
エラーコー
ド
備考
400 -309 フォルダー数が、管理画面の[最大フォルダー数]に設定された値を超える場合
に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
• 正常に作成された場合は、「Folders Get(Ver. 2)(P.198)」(フォルダー情報の取得)と同様の形式で、
フォルダー情報を付けて返します。
第 1 章 SPA Web API リファレンス
207
Folders Rename(Ver. 2) フォルダーの名称を変更します。
URI
http://<hostname>:44230/spa/service/folders_v2/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"type": "folder",
"name": "f_1"
}
■ データ内容
キー 必須 値 備考
type folder フォルダーを示します。設定時には必須です。
name 文字列 フォルダー名です。設定時には必須です。
次の制限があります。
• 半角ドット(.)から始まらない
• ¥ / : * ? " < > ¥ | がない
第 1 章 SPA Web API リファレンス
208
キー 必須 値 備考
• 1~250 バイトで指定する
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -302 すでに同名のフォルダーが存在している場合に出力されます。
400 -307 フォルダー名に誤りがあります。次のいずれかの場合に出力されます。
• フォルダー名が半角ドットから始まっている
• フォルダー名に¥ / : * ? " < > |が使用されている
• フォルダー名が 250 バイトを超えている
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
第 1 章 SPA Web API リファレンス
209
HTTP ステータ
ス
エラーコー
ド
備考
400 -9997 指定した値に誤りがある場合に出力されます。パスにルート(「/」)が指定された
場合や、システムフォルダーをリネームしようとした場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
• 正常に作成された場合は、「Folders Get(Ver. 2)(P.198)」(フォルダー情報の取得)と同様の形式で、
フォルダー情報を付けて返します。
▌出力例
出力例(JSON 形式)
{
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=2",
"id": 2,
"parentId": 0,
"folderType": "PUBLIC",
"path": "/f_1",
"name": "f_1",
"childrenCount": 0,
"children": []
}
■ データ内容
キー 値 備考
type folder フォルダーを示します。
第 1 章 SPA Web API リファレンス
210
キー 値 備考
directUrl 文字列 フォルダーの URL リンクです。
id 数値 フォルダーID です。
name 文字列 フォルダー名です。
parentId 数値 親フォルダーのフォルダーID です。
folderType 文字列 フォルダーの種類です。
文字列 説明
ROOT システムルート(システム全体のルート)です。
PUBLIC パブリックフォルダーです。
USER_ROOT ユーザールートです。
DOMAIN_ROOT ドメインルートです。
USER_HOME ユーザーホーム(マイフォルダーのルート)です。
PERSONAL マイフォルダーです。
UNDEFINED_DOMAIN_ROOT ドメインルート(未定義)です。ユーザールート配下
で、まだ確定していないフォルダーです。
UNDEFINED_USER_HOME ユーザーホーム(未定義)です。ドメインルート(未定
義)配下で、まだ確定していないフォルダーです。
path 文字列 フォルダーの絶対パスです。
childrenCount 数値 子フォルダーの要素数です。
children 子フォルダーのリスト
第 1 章 SPA Web API リファレンス
211
11 フォルダーショートカット フォルダーショートカットに関する API は、次のとおりです。
• Shortcuts List(Ver. 2)(P.212)
• Shortcuts Create(Ver. 2)(P.215)
• Shortcuts Rename(P.219)
• Shortcuts Delete(P.221)
第 1 章 SPA Web API リファレンス
212
Shortcuts List(Ver. 2) ログインしているユーザーのフォルダーショートカットの一覧を取得します。
URI
http://<hostname>:44230/spa/service/shortcuts_v2
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
第 1 章 SPA Web API リファレンス
213
HTTP ステータス エラーコード 備考
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"shortcutList": [
{
"type": "shortcut",
"id": "10",
"name": "shortcut1",
"folderId": "200",
"folder": {
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=200",
"id": "200",
"parentId": "100",
"folderType": "PUBLIC",
"path": "/folder1/folder1-1/folder1-1-1",
"name": "folder1-1-1",
"childrenCount": 2,
"children": [
{
"type": "hasFolder"
}
]
}
},
...
]
}
第 1 章 SPA Web API リファレンス
214
■ データ内容
キー 値 説明
shortcutList ショートカット情報
type shortcut ショートカット情報であることを表します。
id 文字列 ショートカットの ID です。
name 文字列 ショートカット名です。
folderId 文字列 ショートカット先のフォルダーID です。
folder フォルダーID のフォルダー情報
type folder フォルダーであることを表します。
directUrl 文字列 フォルダーの URL リンクです。
id 文字列 フォルダーID です。
parentId 文字列 親フォルダーのフォルダーID です。
folderType ROOT フォルダーの種類が「/」(ルート)フォルダーです。
PUBLIC フォルダーの種類がパブリックフォルダーです。
USER_ROOT フォルダーの種類がユーザールートフォルダーです。
DOMAIN_ROOT フォルダーの種類がドメインルートフォルダーです。
USER_HOME フォルダーの種類がユーザーホームフォルダーです。
PERSONAL フォルダーの種類がマイフォルダーです。
UNDEFINED_DOMAIN_ROOT フォルダーの種類がドメインルートフォルダー(未定義)です。
ユーザールートフォルダー配下で、まだ確定していないフォルダー
です。
UNDEFINED_USER_HOME フォルダーの種類がユーザーホームフォルダー(未定義)です。
ドメインルートフォルダー(未定義)配下で、まだ確定していない
フォルダーです。
path 文字列 フォルダーの絶対パスです。
name 文字列 フォルダー名です。
childrenCount 数値 子フォルダーの要素数です。
children 子フォルダーのリスト
第 1 章 SPA Web API リファレンス
215
Shortcuts Create(Ver. 2) ログインしているユーザーのフォルダーショートカットを作成します。
URI
http://<hostname>:44230/spa/service/shortcuts_v2
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"type": "shortcut",
"name": "shortcut1",
"folderId": "200"
}
■ データ内容
キー 必須 値 備考
type shortcut ショートカットであることを表します。
指定は必須です。
name 文字列 ショートカット名です。
指定は必須です。次の制限があります。
• 半角ドット(.)から始まらない
• ¥ / : * ? " < > ¥ | がない
• 1~250 バイトで指定する
folderId 文字列 ショートカット先のフォルダーID です。
第 1 章 SPA Web API リファレンス
216
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -1401 指定したフォルダーのショートカットがすでに存在する場合に出力されま
す。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -21402 ショートカット名に誤りがある場合に出力されます。ショートカット名の規
則に従っていない場合です。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、folderId
キーに数値以外や、null が指定された場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
第 1 章 SPA Web API リファレンス
217
HTTP ステータス エラーコード 備考
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"type": "shortcut",
"id": "10",
"name": "shortcut1",
"folderId": "200",
"folder": {
"type": "folder",
"directUrl": "http://<サーバー名または IP アドレス>:44230/spa/index.jsp?folderId=200",
"id": "200",
"parentId": "100",
"folderType": "PUBLIC",
"path": "/folder1/folder1-1/folder1-1-1",
"name": "folder1-1-1",
"childrenCount": 2,
"children": [
{
"type": "hasFolder"
}
]
}
}
■ データ内容
キー 値 説明
type shortcut ショートカット情報であることを表します。
id 文字列 ショートカットの ID です。
第 1 章 SPA Web API リファレンス
218
キー 値 説明
name 文字列 ショートカット名です。
folderId 文字列 ショートカット先のフォルダーID です。
folder フォルダーID のフォルダー情報
type folder フォルダーであることを表します。
directUrl 文字列 フォルダーの URL リンクです。
id 文字列 フォルダーID です。
name 文字列 フォルダー名です。
parentId 文字列 親フォルダーのフォルダーID です。
folderType 文字列 フォルダーの種類です。
文字列 説明
ROOT システムルート(システム全体のルート)です。
PUBLIC パブリックフォルダーです。
USER_ROOT ユーザールートです。
DOMAIN_ROOT ドメインルートです。
USER_HOME ユーザーホーム(マイフォルダーのルート)です。
PERSONAL マイフォルダーです。
UNDEFINED_DOMAIN_ROOT ドメインルート(未定義)です。ユーザールート配下
で、まだ確定していないフォルダーです。
UNDEFINED_USER_HOME ユーザーホーム(未定義)です。ドメインルート(未
定義)配下で、まだ確定していないフォルダーです。
path 文字列 フォルダーの絶対パスです。
childrenCount 数値 子フォルダーの要素数です。
children 子フォルダーのリスト
第 1 章 SPA Web API リファレンス
219
Shortcuts Rename ログインしているユーザーの、指定されたフォルダーショートカットの名前を変更します。
URI
http://<hostname>:44230/spa/service/shortcuts/<id>
• キー
キー 必須 値 備考
id ショートカットの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"type": "shortcut",
"name": "shortcut1"
}
■ データ内容
キー 必須 値 備考
type shortcut ショートカットであることを表します。
name 文字列 変更後のショートカット名です。
次の制限があります。
• 半角ドット(.)から始まらない
• ¥ / : * ? " < > ¥ | がない
第 1 章 SPA Web API リファレンス
220
キー 必須 値 備考
• 1~250 バイトで指定する
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -1400 指定したフォルダーのショートカットが存在しない場合に出力されます。
400 -1401 指定したフォルダーのショートカットがすでに存在する場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -21402 ショートカット名に誤りがある場合に出力されます。ショートカット名の規則に
従っていない場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
221
Shortcuts Delete ログインしているユーザーの、指定されたフォルダーショートカットを削除します。
URI
http://<hostname>:44230/spa/service/shortcuts/deleteList
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"ids": [
"5",
"6"
]
}
■ データ内容
キー 必須 値 備考
ids 文字列 削除するショートカットの ID のリスト
▌その他の注意事項
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
222
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -1400 指定したフォルダーのショートカットが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。ids キーに正しくない値
が指定された場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
223
12 ごみ箱 ごみ箱に関する API は、次のとおりです。
• Trashbox List(Ver. 3)(P.224)
• Trashbox Restore(P.228)
• Trashbox Clear(Ver. 2)(P.230)
第 1 章 SPA Web API リファレンス
224
Trashbox List(Ver. 3) ログインしているユーザーのごみ箱にあるフォルダーおよびファイルの一覧を取得します。
URI
http://<hostname>:44230/spa/service/trashbox_v3
HTTP メソッド
GET
▌パラメーター
キー 必
須
値 備考
limit 取得される情報の最大件数 指定がない場合、および、0 以下の数値を指
定した場合は無制限となります。
from 取得する削除日時(開始) 「yyyy-MM-dd'T'HH:mm:ss.SSSZ」形式で指
定します。
例:2013-07-17T07:25:48.000+0900
to 取得する削除日時(終了) 「yyyy-MM-dd'T'HH:mm:ss.SSSZ」形式で指
定します。
例:2013-07-17T07:25:48.000+0900
asAdmin ごみ箱管理の操作権限を持つユーザーで実行する
場合、すべてのユーザーのごみ箱にある情報を取
得するかどうかを指定します。
• true
すべてのユーザーのごみ箱にある情報を取得
します。
• false
自分のごみ箱にある情報のみを取得します。
指定されない場合は、true として動作しま
す。
ごみ箱管理の操作権限を持たないユーザーで
実行する場合は、指定しても無視されます。
第 1 章 SPA Web API リファレンス
225
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"size": 10,
"trash": [
第 1 章 SPA Web API リファレンス
226
出力例(JSON 形式)
{
"type": 0,
"id": "1",
"name": "folderName",
"path": "/aaa/bbb/",
"deleteUserId": "10",
"deleteUserName":"user10",
"deleteDate": "2015-11-20T11:03:43.639+0900",
"parentId": "15",
"linkId": null,
"fileType": null
"contentType": 1
},
{
"type": 1,
"id": "2",
"name": "fileName.pdf",
"path": "/aaa/bbb/",
"deleteUserId": "10",
"deleteUserName":"user10",
"deleteDate": "2015-11-20T11:03:43.639+0900",
"parentId": "15",
"linkId": "20",
"fileType": 1
"contentType": 1
},
...
]
}
第 1 章 SPA Web API リファレンス
227
■ データ内容
キー 値 説明
size 数値 指定した条件に合致するごみ箱内アイテムの総数です。
「limit」パラメーターで最大件数を指定した場合には、trash 内に取得されるごみ箱ア
イテムの数(最大件数)を超える場合があります。
trash ごみ箱内のアイテム一覧
type 0 フォルダーを表します。
1 ファイルを表します。
id 文字列 フォルダーID または文書 ID です。
name 文字列 フォルダー名またはファイル名です。
path 文字列 ごみ箱へ移動する前のパスです。
deleteUserId 文字列 削除したユーザーの ID です。
deleteUserName 文字列 削除したユーザーのユーザー名です。
deleteDate 日付 削除日時です。
parentId 文字列 所属フォルダーのフォルダーID です。
linkId 数値 リンクの場合、リンク元文書の文書 ID です。通常の文書およびフォルダーの場合は null
です。
fileType null フォルダーです。
0 PDF ファイルと PDF ファイル以外のファイルです。
1 リンクです。
2 ページリンクです。
3 マルチリンクです。
contentType 0 PDF ファイル以外のファイルとフォルダーです。
1 PDF ファイルです。
第 1 章 SPA Web API リファレンス
228
Trashbox Restore ログインしているユーザーのごみ箱から、指定したフォルダーまたはファイルを戻します。
URI
http://<hostname>:44230/spa/service/trashbox/restore/
HTTP メソッド
PUT
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
folderIds (*1) ごみ箱から戻したいフォルダーのフォルダーID カンマ区切りで複数指定が可能です。
documentIds (*1) ごみ箱から戻したいファイルの文書 ID カンマ区切りで複数指定が可能です。
*1 folderIds または documentIds どちらかの指定が必要です。
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
229
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。リストア対象または戻し
先のフォルダーが存在しない場合です。
400 -302 すでに同名のフォルダーが存在している場合に出力されます。戻し先に同名のフ
ォルダーが存在する場合です。
400 -400 同名のファイルがすでに存在している場合に出力されます。戻し先に同名のファ
イルが存在する場合です。
404 -401 指定したファイルが存在しない場合に出力されます。リストア対象のファイルが
存在しない、または、リンクのリストア時にリンクの元ファイルが存在しない場
合です。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。値がカンマ区切りの数値
でない場合、folderIds と documentIds 両方の指定がない場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
230
Trashbox Clear(Ver. 2) ログインしているユーザーのごみ箱を空にします。
URI
http://<hostname>:44230/spa/service/trashbox/clear_v2/
HTTP メソッド
PUT
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必
須
値 備考
asAdmin ごみ箱管理の操作権限を持つユーザーで実行する場合、すべて
のユーザーのごみ箱にある文書とフォルダーを削除するかどう
かを指定します。
• true
すべてのユーザーのごみ箱にある文書とフォルダーを削
除します。
• false
自分のごみ箱にある文書とフォルダーのみを削除しま
す。
指定されない場合は、true とし
て動作します。
ごみ箱管理の操作権限を持たない
ユーザーで実行する場合は、指定
しても無視されます。
▌その他の注意事項
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
231
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -301 指定したフォルダーが存在しない場合に出力されます。削除しようとしたフォル
ダーがすでに存在しない場合です。
400 -303 ごみ箱を空にできない場合に出力されます。ごみ箱内のフォルダーに他のユーザ
ーのごみ箱にあるファイルやフォルダーが含まれている場合です。
404 -401 指定したファイルが存在しない場合に出力されます。削除しようとしたファイル
がすでに存在しない場合です。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
232
13 ユーザー情報操作 ユーザー情報操作に関する API は、次のとおりです。
• Users Lookup(P.233)
• Users List(Ver. 2)(P.236)
• Users Group List(Ver. 2)(P.241)
• Users Get(Ver. 2)(P.245)
• Users Authorities(Ver. 4)(P.248)
• Users Create(Ver. 2)(P.253)
• Users Update(Ver. 2)(P.258)
• Users Delete(P.262)
第 1 章 SPA Web API リファレンス
233
Users Lookup ドメイン名とユーザー名からユーザーID を取得します。
URI
http://<hostname>:44230/spa/service/users/lookup
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"lookupTableList": [
{
"name": "user1",
"domainName": "local"
},
{
"name": "user2"
},
...
]
}
第 1 章 SPA Web API リファレンス
234
■ データ内容
キー 必須 値 備考
lookupTableList ドメイン名とユーザー名のリスト
name 文字列 ユーザー名です。
domainName 文字列 ドメイン名です。
指定されていない場合は、local が指定されたものとします。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
235
▌出力例
出力例(JSON 形式)
{
"lookupTableList": [
{
"name": "user1",
"domainName": "local",
"id": "10"
},
{
"name": "user2",
"id": null
},
...
]
}
■ データ内容
キー 値 備考
lookupTableList ドメイン名とユーザー名のリスト
name 文字列 ユーザー名です。
domainName 文字列 ドメイン名です。
id 文字列 ドメイン名とユーザー名から取得したユーザーID です。ユーザーが存在しない場合は
null になります。
指定されたドメイン名が存在しない場合、ユーザーが存在しないものとして扱います。
第 1 章 SPA Web API リファレンス
236
Users List(Ver. 2) ユーザー情報のリストを取得して返します。
URI
http://<hostname>:44230/spa/service/users_v2/list/<id>
• キー
キ
ー
必須 値 備考
id ドメインの ID 未指定の場合は「local」の ID が指定されたものとします。
HTTP メソッド
GET
▌パラメーター
キー 必須 値 備考
name 取得されるユーザー情報をユーザー名
で絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両
方指定された場合は、name を優先します。
fullName 取得されるユーザー情報をフルネーム
で絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両
方指定された場合は、name を優先します。
limit 取得されるユーザー情報の最大件数
(数値) • クエリーパラメーターで指定します。
• 指定しない場合と「0」以下の数値を指定した場
合は無制限になります。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
第 1 章 SPA Web API リファレンス
237
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
404 -651 ドメインが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"size": 10,
"allUserCount": 20,
"userList":[
{
"id":"0",
"name": "admin",
"domainId":"0",
第 1 章 SPA Web API リファレンス
238
出力例(JSON 形式)
"domainName": "local",
"password":"",
"fullname": "",
"mailAddress": "[email protected]",
"comment":"",
"adUser":false,
"groups":[
{
"id":"0",
"name":"AdminGroup",
"fullname":"AdminGroup"
}
],
"adGroups":[]
},
{
"id":"1",
"name": "admmin1",
"domainId":"0",
"domainName": "local",
"password":"",
"fullname":"admin1",
"mailAddress": "[email protected]",
"comment":"",
"adUser":false,
"groups":[
{
"id":"0",
"name":"AdminGroup",
"fullname":"AdminGroup"
},
{
"id":"3",
第 1 章 SPA Web API リファレンス
239
出力例(JSON 形式)
"name":"FULLACCESS_GROUP",
"fullname":"Folder Full Access Group"
}
],
"adGroups":[]
},
...
]
}
■ データ内容
キー 値 備考
size 数値 条件に一致するユーザー情報の総数です。limit で最大件数を指定した場合、userList にあ
るユーザー情報の個数よりも多い場合があります。
allUserCount 数値 指定したドメインの総ユーザー数です。
userList ユーザー情報
id 文字列 このユーザーに割り当てられるシステムで一意の番号です。
name 文字列 ユーザー名です。
domainId 文字列 このユーザーが所属するドメインの ID です。
domainName 文字列 このユーザーが所属するドメインの名前です。
password 文字列 パスワードです。内容はクリアされます。
fullname 文字列 フルネームです。
mailAddress 文字列 メールアドレスです。
comment 文字列 ユーザーの説明です。
adUser true Active Directory ユーザーであることを示します。
false Active Directory ユーザーではないことを示します。
groups 所属グループ情報
id 文字列 このユーザーが所属するグループの ID です。
name 文字列 このユーザーが所属するグループの名前です。
fullname 文字列 グループのフルネームです。
第 1 章 SPA Web API リファレンス
240
キー 値 備考
adGroups 所属しているドメイングループの情報
id 文字列 このユーザーが所属する外部認証グループの ID です。
name 文字列 このユーザーが所属する外部認証グループの名前です。
第 1 章 SPA Web API リファレンス
241
Users Group List(Ver. 2) 指定されたグループに含まれるユーザー情報のリストを返します。
URI
http://<hostname>:44230/spa/service/users_v2/groups/<id>
• キー
キー 必須 値 備考
id グループの ID
HTTP メソッド
GET
▌パラメーター
キー 必須 値 備考
name 取得されるユーザー情報をユーザー
名で絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両方
指定された場合は、name を優先します。
fullName 取得されるユーザー情報をフルネー
ムで絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両方
指定された場合は、name を優先します。
limit 取得されるユーザー情報の最大件数
(数値) • クエリーパラメーターで指定します。
• 指定しない場合と「0」以下の数値を指定した場合
は無制限になります。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
242
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"size": 10,
"allUserCount": 20,
"userList":[
{
"id":"0",
"name": "admin",
"domainId":"0",
第 1 章 SPA Web API リファレンス
243
出力例(JSON 形式)
"domainName": "",
"password":"",
"fullname": "",
"mailAddress":"",
"comment":"",
"adUser":false,
"groups":[],
"adGroups":[]
},
{
"id":"1",
"name": "admmin1",
"domainId":"0",
"domainName": "",
"password":"",
"fullname":"admin1",
"mailAddress":"",
"comment":"",
"adUser":false,
"groups":[],
"adGroups":[]
},
...
]
}
■ データ内容
キー 値 備考
size 数値 条件に一致するユーザー情報の総数です。limit で最大件数を指定した場合、userList にあ
るユーザー情報の個数よりも多い場合があります。
allUserCount 数値 指定グループの総ユーザー数です。
userList ユーザー情報
第 1 章 SPA Web API リファレンス
244
キー 値 備考
id 文字列 このユーザーに割り当てられるシステムで一意の番号です。
name 文字列 ユーザー名です。
domainId 文字列 このユーザーが所属するドメインの ID です。
domainName 文字列 このユーザーが所属するドメインの名前です。
password 文字列 パスワードです。内容はクリアされます。
fullname 文字列 フルネームです。
mailAddress 文字列 メールアドレスです。
comment 文字列 ユーザーの説明です。
adUser true Active Directory ユーザーであることを示します。
false Active Directory ユーザーではないことを示します。
groups 所属グループ情報
空リストです。
adGroups 所属しているドメイングループの情報
空リストです。
第 1 章 SPA Web API リファレンス
245
Users Get(Ver. 2) 指定された対象ユーザーの内部 ID(ユーザーID)を持つユーザーの情報を取得します。
URI
http://<hostname>:44230/spa/service/users_v2/<id>
• キー
キー 必須 値 備考
id ユーザーID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -501 対象のユーザーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
246
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "2",
"name": "admin2",
"domainId": "0",
"domainName": "local",
"password": "",
"fullname": "admin2",
"comment": "",
"mailAddress": "[email protected]",
"adUser": false,
"groups": [
{
"id": "0",
"name": "AdminGroup",
"fullname": "AdminGroup"
},
{
"id": "3",
"name": "FULLACCESS_GROUP",
"fullname":"Folder Full Access Group"
第 1 章 SPA Web API リファレンス
247
出力例(JSON 形式)
},
{
"id": "4",
"name": "DENY_TOPLEVEL_CREATE_GROUP",
"fullname": "Deny Top Level Folder Create Group"
}
],
"adGroups": []
}
■ データ内容
キー 値 備考
id 文字列 このユーザーに割り当てられるシステムで一意の番号です。
name 文字列 ユーザー名です。
domainId 文字列 このユーザーが所属するドメインの ID です。
domainName 文字列 このユーザーが所属するドメインの名前です。
password 文字列 パスワードです。内容はクリアされます。
fullname 文字列 フルネームです。
mailAddress 文字列 メールアドレスです。
comment 文字列 ユーザーの説明です。
adUser true Active Directory ユーザーです。
false Active Directory ユーザーではありません。
groups 所属グループ情報
id 文字列 このユーザーが所属するグループの ID です。
name 文字列 このユーザーが所属するグループの名前です。
fullname 文字列 グループのフルネームです。
adGroups 所属している外部認証グループの情報
id 文字列 このユーザーが所属するドメイングループの ID です。
name 文字列 このユーザーが所属する外部認証グループの名前です。
第 1 章 SPA Web API リファレンス
248
Users Authorities(Ver. 4) 指定されたユーザーに許可されたすべての操作の権限 ID 番号を取得します。
URI
http://<hostname>:44230/spa/service/users_v4/<id>/authorities
• キー
キ
ー
必須 値 備考
id ユーザーID 未指定の場合はログインしているユーザーの ID が指定されたものとします。
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
404 -501 対象のユーザーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
249
HTTP ステータス エラーコード 備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "0",
"name": "admin",
"domainId": "0",
"authorities": [
4,
5,
7,
8,
10,
15,
21,
23,
...
26,
53,
54,
55,
56
]
}
第 1 章 SPA Web API リファレンス
250
■ データ内容
キー 値 備考
id 文字列 このユーザーに割り当てられるシステムで一意の番号です。
name 文字列 ユーザーの名前です。
domainId 文字列 ユーザーが所属するドメインの ID(数値配列)です。
authorities 数値 操作が許可(「ALLOW」)となっている権限の ID のリスト
権限 ID については、「authorities キーの id キーに指定する権限 ID(P.250)」を参照してくださ
い。
authorities キーの id キーに指定する権限 ID
authorities キーの id キーに指定する権限の ID は次のとおりです。
カテゴリ 操作の内容 権限 ID
検索 条件の保存 1
全文検索 46
基本プロパティ検索 47
カスタムプロパティ検索 48
SVF 検索フィールド検索 49
明細検索 50
データ出力 検索結果の CSV ファイル出力 2
SVF 検索フィールドデータの CSV ファイル出力 53
ダウンロード ダウンロード 3
無加工ダウンロード 4
印刷 印刷 5
プレビュー プレビュー 6
ファイル ファイル名の変更 8
ファイルまたはリンクの移動 36
ファイルまたはリンクの削除 9
リンクの作成 10
アーカイブ 11
プロパティの変更 23
第 1 章 SPA Web API リファレンス
251
カテゴリ 操作の内容 権限 ID
マスクの適用 37
検索結果へのマスク適用 54
履歴の閲覧と復元 55
フォルダー フォルダーの作成 12
フォルダー名の変更 13
フォルダーの移動 38
フォルダーの削除 14
透かしの設定 16
暗号化の設定 17
アクセス権の設定 18
削除の履歴 削除記録の確認 39
レビュー レビューの作成 40
個人設定 ユーザープロファイル 19
カラム表示の設定 34
サーバー設定 環境設定 21
運用管理 ユーザーの設定 20
カスタムプロパティの設定 22
マスク設定 41
共通検索条件の設定 42
スタンプ、注釈画像アイテムの設定 43
セッション管理 44
カラム表示のデフォルト設定 24
ファイル証跡情報の設定 45
ファイル証跡情報の確認 26
メンテナンスモードへの移行 27
設定のインポート/エクスポート 52
通知の設定 56
文書定義 文書定義の設定 33
第 1 章 SPA Web API リファレンス
252
カテゴリ 操作の内容 権限 ID
特権 フォルダーへのフルアクセス 28
トップレベルフォルダーの作成 29
ごみ箱管理 30
レビュー管理 31
文書管理 35
非表示カスタムプロパティの操作 51
第 1 章 SPA Web API リファレンス
253
Users Create(Ver. 2) 指定されたユーザーを作成し、指定されたグループに登録します。
URI
http://<hostname>:44230/spa/service/users_v2
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"name":"user1",
"password":"12345",
"fullname":"user1",
"mailAddress":"[email protected]",
"comment":"",
"groups":[
{
"id":"0"
},
{
"id":"4"
}
]
}
第 1 章 SPA Web API リファレンス
254
■ データ内容
キー 必須 値 備考
name 文字列 ユーザー名です。半角 128 文字以内で指定してください。/ ¥ : * ? " < > | は指定で
きません。
password 文字列 パスワードです。32 文字以内の半角文字で指定してください。
fullname 文字列 ユーザーのフルネームです。半角 128 文字以内で指定してください。
mailAddress 文字列 ユーザーのメールアドレスです。50 バイト以内で、以下の規則に準拠した文字列
を指定してください。
• 文字列の中に「@」が 1 つだけある
• 「@」の前後に文字がある
• 使用する文字は、半角英数字(大文字、小文字)と以下の記号のみ
! # $ % & ' * + - / = ? ^ _ ` { } | ~ @ .
comment 文字列 ユーザーの説明です。半角 128 文字以内で指定してください。
groups 所属するグループの情報
id 文字列 このユーザーが所属するグループの ID です。
指定されていない場合は、「ViewGroup」の ID が追加されます。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• 「"ViewGroup"」は必須グループのため、指定がなくても、ユーザーは自動的に所属します。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
255
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。ユーザーが正常に作成された場合は、「Users Get(Ver.
2)(P.245)」と同様の形式でユーザー情報を付けて返します。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -500 ユーザー作成時、作成しようとしているユーザーと同じ名前のユーザーが存在し
ている場合に出力されます。
400 -502 管理画面の[最大ユーザー数]の設定値以上のユーザーを登録しようとした場合
に出力されます。
400 -503 ユーザーを、管理画面の[ユーザーの所属する最大グループ数]の設定値以上の
グループに所属させようとした場合に出力されます。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。所属するグループの情報に、外部
認証サーバーから取り込んだグループの id が指定された場合です。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20014 パスワードの指定がない場合に出力されます。
400 -20015 パスワードに使用できない文字を使用した場合に出力されます。半角文字(0x20
~0x7e)以外の文字が使用された場合です。
400 -20016 半角 33 文字以上のパスワードが指定された場合に出力されます。
400 -20504 ユーザー名が指定されていない場合に出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、以下のような
場合に出力されます。
• ユーザー名、フルネーム、説明に半角 129 文字以上の文字列が指定された
場合
• ユーザー名に使えない文字(¥ / : * ? " < > |)が使用されている場合
• メールアドレスに使えない文字が使用されている場合
第 1 章 SPA Web API リファレンス
256
HTTP ステータ
ス
エラーコー
ド
備考
• メールアドレスに 51 バイト以上の文字列が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
正常に作成された場合の出力例(JSON 形式)
{
"id": "7",
"name": "user1",
"domainId": "0",
"domainName": "local",
"password": "",
"fullname": "user1",
"mailAddress": "[email protected]",
"comment": "",
"adUser": false,
"groups": [
{
"id": "0",
"name": "AdminGroup",
"fullname": "AdminGroup"
},
{
"id": "2",
"name": "ViewGroup",
"fullname": "ViewGroup"
},
{
"id": "4",
第 1 章 SPA Web API リファレンス
257
正常に作成された場合の出力例(JSON 形式)
"name": "DENY_TOPLEVEL_CREATE_GROUP",
"fullname": "Deny Top Level Folder Create Group"
}
],
"adGroups": []
}
■ データ内容
キー 値 備考
id 文字列 このユーザーに割り当てられるシステムで一意の番号です。
name 文字列 ユーザー名です。
domainId 文字列 このユーザーが所属するドメインの ID です。
domainName 文字列 このユーザーが所属するドメインの名前です。
password 文字列 パスワードです。内容はクリアされます。
fullname 文字列 フルネームです。
mailAddress 文字列 メールアドレスです。
comment 文字列 ユーザーの説明です。
adUser true Active Directory ユーザーです。
false Active Directory ユーザーではありません。
groups 所属グループ情報
id 文字列 このユーザーが所属するグループの ID です。
name 文字列 このユーザーが所属するグループの名前です。
fullname 文字列 グループのフルネームです。
adGroups 所属している外部認証グループの情報
id 文字列 このユーザーが所属するドメイングループの ID です。
name 文字列 このユーザーが所属する外部認証グループの名前です。
第 1 章 SPA Web API リファレンス
258
Users Update(Ver. 2) 指定された内容でユーザー情報を更新します。
URI
http://<hostname>:44230/spa/service/users_v2/<id>
• キー
キー 必須 値 備考
id 対象ユーザーの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"password":"12345",
"fullname":"user1",
"mailAddress": "[email protected]",
"comment":"",
"groups":[
{
"id":"0"
},
{
"id":"2"
},
{
第 1 章 SPA Web API リファレンス
259
オブジェクトの例(JSON 形式)
"id":"3"
}
]
}
■ データ内容
キー 必須 値 備考
password 文字列 パスワードです。
指定されていない場合は、更新されません。
fullname 文字列 ユーザーのフルネームです。
指定されていない場合は、更新されません。
mailAddress 文字列 ユーザーのメールアドレスです。
指定されていない場合は、更新されません。
comment 文字列 ユーザーの説明です。
指定されていない場合は、更新されません。
groups 所属するグループの情報
id 文字列 このユーザーが所属するグループの ID です。
指定されていない場合は、更新されません。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• 「ViewGroup」("id":"3")は、削除できません。
• ローカルユーザーと Active Directory ユーザー(ドメインユーザー)では、更新できる項目が異なりま
す。更新できる項目には「 」を、更新できない項目には「 」を記しています。
キー 値 ローカルユーザー ドメインユーザー
group 所属グループ(複数指定可)
password パスワード
fullname フルネーム
第 1 章 SPA Web API リファレンス
260
キー 値 ローカルユーザー ドメインユーザー
mailAddress メールアドレス
comment ユーザー説明
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。ユーザーが正常に更新された場合は、「Users Get(Ver.
2)(P.245)」と同様の形式でユーザー情報を付けて返します。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -501 対象のユーザーが存在しない場合に出力されます。
400 -503 ユーザーを、管理画面の[ユーザーの所属する最大グループ数]の設定値以上の
グループに所属させようとした場合に出力されます。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 「ViewGroup」("id":"3")を削除しようとしたなど、指定した値に誤りがある場
合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20015 パスワードに使用できない文字を使用した場合に出力されます。半角文字(0x20
~0x7e)以外の文字が使用された場合です。
400 -20016 半角 33 文字以上のパスワードが指定された場合に出力されます。
第 1 章 SPA Web API リファレンス
261
HTTP ステータ
ス
エラーコー
ド
備考
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、以下のような
場合に出力されます。
• フルネームまたは説明に半角 129 文字以上の文字列が指定され場合
• ドメインユーザーがグループ情報以外を変更しようとした場合
• メールアドレスに使えない文字が使用されている場合
• メールアドレスに 51 バイト以上の文字列が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
262
Users Delete 指定されたユーザーID を持つユーザー情報を削除します。
URI
http://<hostname>:44230/spa/service/users/deleteList
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"ids":[
"10",
"11",
"12"
]
}
■ データ内容
キー 必須 値 備考
ids 文字列 削除したいユーザーID のリスト
▌その他の注意事項
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
263
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。複数のユーザーを削除する場合は、すべてのユーザーが
削除できたときに出力されます。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -501 対象のユーザーが存在しない場合に出力されます。
400 -504 admin ユーザーを削除しようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 ドメインが「local」以外で指定されたときなど、指定した値に誤りがある場合に
出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20505 ユーザーID が指定されていない場合に出力されます。
400 -29001 ユーザーID の指定に誤りがあるなど、パラメーターの指定に誤りがある場合に出
力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
264
14 グループ情報操作 グループ情報操作に関する API は次のとおりです。
• Groups Lookup(P.265)
• Groups List(Ver. 2)(P.268)
• Groups Role List(Ver. 2)(P.272)
• Groups Get(Ver. 2)(P.275)
• Groups Create(Ver. 2)(P.278)
• Groups Update(Ver. 2)(P.283)
• Groups Delete(P.288)
第 1 章 SPA Web API リファレンス
265
Groups Lookup 指定された ID を持つグループの情報を削除します。
URI
http://<hostname>:44230/spa/service/groups/lookup
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"lookupTableList": [
{
"name": "group1",
"domainName": "local"
},
{
"name": "group2"
},
...
]
}
■ データ内容
キー 必須 値 備考
lookupTableList ドメイン名とグループ名のリスト
第 1 章 SPA Web API リファレンス
266
キー 必須 値 備考
name 文字列 グループ名です。
domainName 文字列 ドメイン名です。
指定されていない場合は、local が指定されたものとします。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
267
▌出力例
出力例(JSON 形式)
{
"lookupTableList": [
{
"name": "group1",
"domainName": "local",
"id": "10"
},
{
"name": "group2",
"id": null
},
...
]
}
■ データ内容
キー 値 備考
lookupTableList ドメイン名とグループ名のリスト
name 文字列 グループ名です。
domainName 文字列 ドメイン名です。
id 文字列 ドメイン名とグループ名から取得するグループの ID です。グループが存在しない場合は
null になります。
指定されたドメイン名が存在しない場合、グループが存在しないものとして扱います。
第 1 章 SPA Web API リファレンス
268
Groups List(Ver. 2) グループ情報のリストを取得して返します。
URI
http://<hostname>:44230/spa/service/groups_v2/list/<id>
• キー
キー 必須 値 備考
id ドメインの ID 未指定の場合は「local」の ID が指定されたものとします。
HTTP メソッド
GET
▌パラメーター
キー 必
須
値 備考
name 取得されるグループ情報をグループ名
で絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両方
指定された場合は、name を優先します。
fullName 取得されるグループ情報をグループ名
で絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両方
指定された場合は、name を優先します。
limit 取得されるグループ情報の最大件数
(数値) • クエリーパラメーターで指定します。
• 指定しない場合と「0」以下の数値を指定した場合
は無制限になります。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
第 1 章 SPA Web API リファレンス
269
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -651 ドメインが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"size": 2,
"allGroupCount": 5,
"groupList": [
{
"id": "0",
"name": "AdminGroup",
第 1 章 SPA Web API リファレンス
270
出力例(JSON 形式)
"domainId": "0",
"fullname": "AdminGroup",
"mailAddress":"[email protected]",
"comment": "",
"roles": [
{
"id": "4",
"name": "DOCUMENT_ADMIN",
"ja": "文書管理者",
"en": "Document Administrator",
"zh_CN": "文档管理员"
},
{
"id": "5",
"name": "ADMIN",
"ja": "管理者",
"en": "Administrator",
"zh_CN": "管理员"
}
]
},
{
"id": "1",
"name": "UserGroup",
...
}
]
}
第 1 章 SPA Web API リファレンス
271
■ データ内容
キー 値 備考
size 数値 条件に一致するグループ情報の総数です。limit で最大件数を指定した場合、groupList に
あるグループ情報の個数よりも多い場合があります。
allGroupCount 数値 指定したドメインの総グループ数です。
groupList グループ情報のリスト
id 文字列 グループに割り当てられるシステムで一意の番号です。
name 文字列 グループ名です。
domainId 文字列 このグループが属するドメインの ID です。
fullname 文字列 グループのフルネームです。
mailAddress 文字列 メールアドレスです。
comment 文字列 グループの説明です。
roles ロール情報
id 文字列 このグループに割り当てられているロールの ID です。
name 文字列 このグループに割り当てられているロールの名前です。
ja 文字列 このグループに適用されているロールの日本語でのフルネームです。
en 文字列 このグループに適用されているロールの英語でのフルネームです。
zh_CN 文字列 このグループに適用されているロールの中国語(簡体字)でのフルネームです。
第 1 章 SPA Web API リファレンス
272
Groups Role List(Ver. 2) 指定されたロールが含まれるグループ情報のリストを返します。
URI
http://<hostname>:44230/spa/service/groups_v2/roles/<id>
• キー
キー 必須 値 備考
id ロールの ID
HTTP メソッド
GET
▌パラメーター
キー 必須 値 備考
name 取得されるグループ情報をグループ名
で絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両
方指定された場合は、name を優先します。
fullName 取得されるグループ情報をグループ名
で絞り込むための条件(文字列) • クエリーパラメーターで指定します。
• name か fullName のどちらかを指定します。両
方指定された場合は、name を優先します。
limit 取得されるグループ情報の最大件数
(数値) • クエリーパラメーターで指定します。
• 指定しない場合と「0」以下の数値を指定した場
合は無制限になります。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
273
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -551 対象のロールが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"size": 2,
"allGroupCount": 5,
"groupList": [
{
"id": "0",
"name": "AdminGroup",
"domainId": "0",
"fullname": "AdminGroup",
第 1 章 SPA Web API リファレンス
274
出力例(JSON 形式)
"mailAddress": "[email protected]",
"comment": "",
"roles": []
},
{
"id": "1",
"name": "PowerUserGroup",
...
}
]
}
■ データ内容
キー 値 備考
size 数値 条件に一致するグループ情報の総数です。limit で最大件数を指定した場合、groupList に
あるグループ情報の個数よりも多い場合があります。
allGroupCount 数値 指定ロールの総グループ数です。
groupList グループ情報のリスト
id 文字列 グループに割り当てられるシステムで一意の番号です。
name 文字列 グループ名です。
domainId 文字列 このグループが属するドメインの ID です。
fullname 文字列 グループのフルネームです。
mailAddress 文字列 グループのメールアドレスです。
comment 文字列 グループの説明です。
roles ロール情報
空リストです。
第 1 章 SPA Web API リファレンス
275
Groups Get(Ver. 2) 指定された ID を持つグループの情報を取得します。
URI
http://<hostname>:44230/spa/service/groups_v2/<id>
• キー
キー 必須 値 備考
id グループの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
276
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20603 グループ名の指定がない場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "0",
"name": "AdminGroup",
"domainId": "0",
"fullname": "AdminGroup",
"mailAddress": "[email protected]",
"comment": "",
"roles": [
{
"id": "4",
"name": "ADMIN",
"ja": "管理者",
"en": "Administrator",
"zh_CN": "管理员"
},
{
"id": "5",
"name": "TOPLEVEL_FOLDER_CREATOR",
"ja": "トップレベルフォルダー作成",
第 1 章 SPA Web API リファレンス
277
出力例(JSON 形式)
"en": "Create Top Level Folder",
"zh_CN": "顶层文件夹创建"
}
]
}
■ データ内容
キー 値 備考
id 文字列 グループに割り当てられるシステムで一意の番号です。
name 文字列 グループ名です。
domainId 文字列 このグループが属するドメインの ID です。
fullname 文字列 グループのフルネームです。
mailAddress 文字列 グループのメールアドレスです。
comment 文字列 グループの説明です。
roles ロール情報
id 文字列 このグループに割り当てられているロールの ID です。
name 文字列 このグループに割り当てられているロールの名前です。
ja 文字列 このグループに適用されているロールの日本語でのフルネームです。
en 文字列 このグループに適用されているロールの英語でのフルネームです。
zh_CN 文字列 このグループに適用されているロールの中国語(簡体字)でのフルネームです。
第 1 章 SPA Web API リファレンス
278
Groups Create(Ver. 2) 指定されたグループを作成します。
URI
http://<hostname>:44230/spa/service/groups_v2
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"name": "CUSTOM_GROUP",
"fullname": "Custom Group",
"mailAddress": "[email protected]",
"comment": "",
"roles": [
{
"id": "4"
},
{
"id": "5"
}
]
}
第 1 章 SPA Web API リファレンス
279
■ データ内容
キー 必須 値 備考
name 文字列 グループ名です。
fullname 文字列 グループのフルネームです。
mailAddress 文字列 ユーザーのメールアドレスです。50 バイト以内で、以下の規則に準拠した文字列
を指定してください。
• 文字列の中に「@」が 1 つだけある
• 「@」の前後に文字がある
• 使用する文字は、半角英数字(大文字、小文字)と以下の記号のみ
! # $ % & ' * + - / = ? ^ _ ` { } | ~ @ .
comment 文字列 グループの説明です。
roles 適用するロールの情報
指定されていない場合は、「VIEW_USER(閲覧ユーザー)」を指定したものとし
ます。
id 文字列 このグループが適用するロールの ID です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
280
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。グループが正常に作成された場合は、「Groups Get
(Ver. 2)(P.275)」と同様の形式でグループ情報を付けて返します。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -551 対象のロールが存在しない場合に出力されます。
400 -600 グループ作成時、作成しようとしているグループと同じ名前のグループが存在し
ている場合に出力されます。
400 -602 管理画面の[最大グループ数]の設定値以上のグループを登録しようとした場合
に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20603 グループ名の指定がない場合に出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、以下のような
場合に出力されます。
• グループ名、説明、フルネームに半角 129 文字以上の文字列が指定され場
合
• グループ名に使えない文字(¥ / : * ? " < > |)が使用されている場合
• メールアドレスに使えない文字が使用されている場合
• メールアドレスに 51 バイト以上の文字列が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
281
▌出力例
正常に作成された場合の出力例(JSON 形式)
{
"id": "6",
"name": "CUSTOM_GROUP",
"domainId": "0",
"fullname": "Custom Group",
"mailAddress": "[email protected]",
"comment": "",
"roles": [
{
"id": "4",
"name": "DOCUMENT_ADMIN",
"ja": "文書管理者",
"en": "Document Administrator",
"zh_CN": "文档管理员"
},
{
"id": "5",
"name": "ADMIN",
"ja": "管理者",
"en": "Administrator",
"zh_CN": "管理员"
}
]
}
■ データ内容
キー 値 備考
id 文字列 グループに割り当てられるシステムで一意の番号です。
name 文字列 グループ名です。
domainId 文字列 このグループが属するドメインの ID です。
第 1 章 SPA Web API リファレンス
282
キー 値 備考
fullname 文字列 グループのフルネームです。
mailAddress 文字列 グループのメールアドレスです。
comment 文字列 グループの説明です。
roles ロール情報
id 文字列 このグループに割り当てられているロールの ID です。
name 文字列 このグループに割り当てられているロールの名前です。
ja 文字列 このグループに適用されているロールの日本語でのフルネームです。
en 文字列 このグループに適用されているロールの英語でのフルネームです。
zh_CN 文字列 このグループに適用されているロールの中国語(簡体字)でのフルネームです。
第 1 章 SPA Web API リファレンス
283
Groups Update(Ver. 2) 指定された内容でグループ情報を更新します。
URI
http://<hostname>:44230/spa/service/groups_v2/<id>
• キー
キー 必須 値 備考
id グループの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"fullname": "Custom Group",
"mailAddress": "[email protected]",
"comment": "TOPLEVEL FOLDER",
"roles": [
{
"id": "4"
},
{
"id": "6"
}
]
}
第 1 章 SPA Web API リファレンス
284
■ データ内容
キー 必須 値 備考
fullname 文字列 グループのフルネームです。
指定されていない場合は、更新されません。
mailAddress 文字列 グループのメールアドレスです。
指定されていない場合は、更新されません。
comment 文字列 グループの説明です。
指定されていない場合は、更新されません。
roles 適用するロールの情報
指定されていない場合は、「VIEW_USER(閲覧ユーザー)」を指定したものとしま
す。
id 文字列 このグループに適用するロールの ID です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• local グループとドメイングループ(Active Directory から取り込んだグループ)では、更新できる項
目が異なります。
キー 値 local グループ ドメイングループ
fullname フルネーム*1
mailAddress メールアドレス
comment グループの説明*1
role ロール*2
○ 「 」は更新可、「 」は更新不可
○ *1 システムグループは変更できません。システムグループとは、グループ名が次のグループで
す。
■ ViewGroup
■ UserGroup
第 1 章 SPA Web API リファレンス
285
■ PowerUserGroup
■ AdminGroup
○ *2 指定されていない場合は、「VIEW_USER」が指定されたものとします。ロールは複数指定ができ
ますが、システムグループはシステムロールの削除ができません。
システムロールは、ロール名が次のロールです。
■ VIEW_USER
■ USER
■ POWER_USER
■ PDF_SECURITY_ADMIN
■ FOLDER_ADMIN
■ ADMIN
■ TOPLEVEL_FOLDER_CREATOR
■ FOLDER_FULLACCESS
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。グループが正常に作成された場合は、「Groups Get
(Ver. 2)(P.275)」と同様の形式でグループ情報を付けて返します。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -551 対象のロールが存在しない場合に出力されます。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
286
HTTP ステータ
ス
エラーコー
ド
備考
400 -603 システムグループ情報を更新する際、既定ロール(デフォルトで適用されるロー
ル)が取り除かれていた場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20604 グループの ID が指定されていない場合に出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、以下のような
場合に出力されます。
• グループ名、フルネーム、グループの説明に使用できない文字が含まれてい
る場合や、半角 129 文字以上の文字列が指定された場合
• メールアドレスに使えない文字が使用されている場合
• メールアドレスに 51 バイト以上の文字列が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
正常に作成された場合の出力例(JSON 形式)
{
"id": "6",
"name": "CUSTOM_GROUP",
"domainId": "0",
"fullname": "Custom Group",
"mailAddress": "[email protected]",
"comment": "TOPLEVEL FOLDER",
"roles": [
{
第 1 章 SPA Web API リファレンス
287
正常に作成された場合の出力例(JSON 形式)
"id": "4",
"name": "DOCUMENT_ADMIN",
"ja": "文書管理者",
"en": "Document Administrator",
"zh_CN": "文档管理员"
},
{
"id": "6",
"name": "TOPLEVEL_FOLDER_CREATOR",
"ja": "トップレベルフォルダー作成",
"en": "Create Top Level Folder",
"zh_CN": "顶层文件夹创建"
}
]
}
■ データ内容
キー 値 備考
id 文字列 グループに割り当てられるシステムで一意の番号です。
name 文字列 グループ名です。
domainId 文字列 このグループが属するドメインの ID です。
fullname 文字列 グループのフルネームです。
mailAddress 文字列 グループのメールアドレスです。
comment 文字列 グループの説明です。
roles ロール情報
id 文字列 このグループに割り当てられているロールの ID です。
name 文字列 このグループに割り当てられているロールの名前です。
ja 文字列 このグループに適用されているロールの日本語でのフルネームです。
en 文字列 このグループに適用されているロールの英語でのフルネームです。
zh_CN 文字列 このグループに適用されているロールの中国語(簡体字)でのフルネームです。
第 1 章 SPA Web API リファレンス
288
Groups Delete 指定された ID を持つグループの情報を削除します。
URI
http://<hostname>:44230/spa/service/groups/deleteList
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"ids":[
"7",
"8",
"10"
]
}
■ データ内容
キー 必須 値 備考
ids 文字列 削除したいグループの ID のリスト
▌その他の注意事項
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
289
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。複数のグループを削除する場合は、すべてのグループが
削除できたときに出力されます。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
400 -605 システムグループ(AdminGroup、PowerUserGroup、UserGroup、
ViewGroup)を削除しようとした場合に出力されます。
400 -606 ユーザーまたはグループを削除すると、アクセス権をもつユーザーおよびグルー
プがなくなるフォルダーがある場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20604 グループの ID が指定されていない場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
290
15 ロール情報操作 ロール情報操作に関する API は次のとおりです。
• Roles Lookup(P.291)
• Roles List(Ver. 4)(P.294)
• Roles Get(Ver. 4)(P.300)
• Roles Create(Ver. 4)(P.305)
• Roles Update(Ver. 4)(P.314)
• Roles Delete(P.321)
第 1 章 SPA Web API リファレンス
291
Roles Lookup ロール名からロールの ID を取得します。
URI
http://<hostname>:44230/spa/service/roles/lookup
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"lookupTableList": [
{
"name": "role1"
},
{
"name": "role2"
},
...
]
}
■ データ内容
キー 必須 値 備考
lookupTableList ロール名のリスト
name 文字列 ロール名です。
第 1 章 SPA Web API リファレンス
292
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"lookupTableList": [
{
"name": "role1",
第 1 章 SPA Web API リファレンス
293
出力例(JSON 形式)
"id": "10"
},
{
"name": "role2",
"id": null
},
...
]
}
■ データ内容
キー 値 備考
lookupTableList ロール名のリスト
name 文字列 ロール名です。
id 文字列 ロール名から取得したロールの ID です。ロールが存在しない場合は null になります。
第 1 章 SPA Web API リファレンス
294
Roles List(Ver. 4) カスタムロールの詳細情報のリストを取得して返します。
URI
http://<hostname>:44230/spa/service/roles_v4/list
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
第 1 章 SPA Web API リファレンス
295
HTTP ステータス エラーコード 備考
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
カスタムロールの一覧を取得する場合の出力例(JSON 形式)
{
"roleList": [
{
"system": true,
"id": "0",
"name": "VIEW_USER",
"labels": [
{
"language": "zh_CN",
"title": "浏览用户",
"description": "可进行查找及预览"
},
{
"language": "en",
"title": "View-Only User",
"description": "Can perform search and preview."
},
{
"language": "ja",
"title": "閲覧ユーザー",
"description": "検索とプレビューが可能"
}
],
"authorities": [
{
"id": 1,
"value": "ALLOW"
第 1 章 SPA Web API リファレンス
296
カスタムロールの一覧を取得する場合の出力例(JSON 形式)
},
{
"id": 34,
"value": "ALLOW"
},
{
"id": 19,
"value": "ALLOW"
},
{
"id": 2,
"value": "ALLOW"
},
{
"id": 6,
"value": "ALLOW"
},
{
"id": 7,
"value": "ALLOW"
}
]
},
{
"system": true,
"id": "1",
"name": "USER",
...
}
]
}
第 1 章 SPA Web API リファレンス
297
■ データ内容
キー 値 備考
system true システムロールです。
false システムロールではありません。
id 文字列 このロールに割り当てられたシステムで一意の番号(ID)です。
name 文字列 ロール名です。
labels ロールの表示情報リスト
language ja ロールの「表示名」と「説明」の表示言語が「日本語」です。
en ロールの「表示名」と「説明」の表示言語が「英語」です。
zh_CN ロールの「表示名」と「説明」の表示言語が「中国語(簡体字)」です。
title 文字列 表示名です。
description 文字列 説明です。
authorities ロールの権限情報
id 数値 権限 ID です。
権限 ID については「authorities キーの id キーに指定する権限 ID(P.297)」を参照してくださ
い。
value ALLOW 操作が許可されています。
DENY 操作が許可されていません。
authorities キーの id キーに指定する権限 ID
authorities キーの id キーに指定する権限の ID は次のとおりです。
カテゴリ 操作の内容 権限 ID
検索 条件の保存 1
全文検索 46
基本プロパティ検索 47
カスタムプロパティ検索 48
SVF 検索フィールド検索 49
明細検索 50
データ出力 検索結果の CSV ファイル出力 2
SVF 検索フィールドデータの CSV ファイル出力 53
第 1 章 SPA Web API リファレンス
298
カテゴリ 操作の内容 権限 ID
ダウンロード ダウンロード 3
無加工ダウンロード 4
印刷 印刷 5
プレビュー プレビュー 6
ファイル ファイル名の変更 8
ファイルまたはリンクの移動 36
ファイルまたはリンクの削除 9
リンクの作成 10
アーカイブ 11
プロパティの変更 23
マスクの適用 37
検索結果へのマスク適用 54
履歴の閲覧と復元 55
フォルダー フォルダーの作成 12
フォルダー名の変更 13
フォルダーの移動 38
フォルダーの削除 14
透かしの設定 16
暗号化の設定 17
アクセス権の設定 18
削除の履歴 削除記録の確認 39
レビュー レビューの作成 40
個人設定 ユーザープロファイル 19
カラム表示の設定 34
サーバー設定 環境設定 21
運用管理 ユーザーの設定 20
カスタムプロパティの設定 22
マスク設定 41
第 1 章 SPA Web API リファレンス
299
カテゴリ 操作の内容 権限 ID
共通検索条件の設定 42
スタンプ、注釈画像アイテムの設定 43
セッション管理 44
カラム表示のデフォルト設定 24
ファイル証跡情報の設定 45
ファイル証跡情報の確認 26
メンテナンスモードへの移行 27
設定のインポート/エクスポート 52
通知の設定 56
文書定義 文書定義の設定 33
特権 フォルダーへのフルアクセス 28
トップレベルフォルダーの作成 29
ごみ箱管理 30
レビュー管理 31
文書管理 35
非表示カスタムプロパティの操作 51
第 1 章 SPA Web API リファレンス
300
Roles Get(Ver. 4) 指定された ID を持つロールの情報を取得します。
URI
http://<hostname>:44230/spa/service/roles_v4/<id>
• キー
キー 必須 値 備考
id 対象となるロールの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
404 -551 対象のロールが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
第 1 章 SPA Web API リファレンス
301
HTTP ステータス エラーコード 備考
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20605 ロール名が指定されていない場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"system": true,
"id": "6",
"name": "FOLDER_FULLACCESS",
"labels": [
{
"language": "zh_CN",
"title": "文件夹完全访问",
"description": "无论文件夹的访问权限如何,都可进行"读取"、"写入"、"取得""
},
{
"language": "en",
"title": "Full Access to Folders",
"description": "Can perform ''Read'', ''Write'', and ''Fetch'' operations regardless of folder access
permissions."
},
{
"language": "ja",
"title": "フォルダーフルアクセス",
"description": "フォルダーのアクセス権にかかわらず、「読み取り」「書き込み」「取り出し」が可能"
}
第 1 章 SPA Web API リファレンス
302
出力例(JSON 形式)
],
"authorities": [
{
"id": 28,
"value": "ALLOW"
}
]
}
■ データ内容
キー 値 備考
system true システムロールです。
false システムロールではありません。
id 文字列 このロールに割り当てられたシステムで一意の番号(ID)です。
name 文字列 ロール名です。
labels ロールの表示情報リスト
language ja ロールの「表示名」と「説明」の表示言語が「日本語」です。
en ロールの「表示名」と「説明」の表示言語が「英語」です。
zh_CN ロールの「表示名」と「説明」の表示言語が「中国語(簡体字)」です。
title 文字列 表示名です。
description 文字列 説明です。
authorities ロールの権限情報
id 数値 権限 ID です。
権限 ID については「authorities キーの id キーに指定する権限 ID(P.302)」を参照してくださ
い。
value ALLOW 操作が許可されています。
DENY 操作が許可されていません。
authorities キーの id キーに指定する権限 ID
authorities キーの id キーに指定する権限の ID は次のとおりです。
第 1 章 SPA Web API リファレンス
303
カテゴリ 操作の内容 権限 ID
検索 条件の保存 1
全文検索 46
基本プロパティ検索 47
カスタムプロパティ検索 48
SVF 検索フィールド検索 49
明細検索 50
データ出力 検索結果の CSV ファイル出力 2
SVF 検索フィールドデータの CSV ファイル出力 53
ダウンロード ダウンロード 3
無加工ダウンロード 4
印刷 印刷 5
プレビュー プレビュー 6
ファイル ファイル名の変更 8
ファイルまたはリンクの移動 36
ファイルまたはリンクの削除 9
リンクの作成 10
アーカイブ 11
プロパティの変更 23
マスクの適用 37
検索結果へのマスク適用 54
履歴の閲覧と復元 55
フォルダー フォルダーの作成 12
フォルダー名の変更 13
フォルダーの移動 38
フォルダーの削除 14
透かしの設定 16
暗号化の設定 17
アクセス権の設定 18
第 1 章 SPA Web API リファレンス
304
カテゴリ 操作の内容 権限 ID
削除の履歴 削除記録の確認 39
レビュー レビューの作成 40
個人設定 ユーザープロファイル 19
カラム表示の設定 34
サーバー設定 環境設定 21
運用管理 ユーザーの設定 20
カスタムプロパティの設定 22
マスク設定 41
共通検索条件の設定 42
スタンプ、注釈画像アイテムの設定 43
セッション管理 44
カラム表示のデフォルト設定 24
ファイル証跡情報の設定 45
ファイル証跡情報の確認 26
メンテナンスモードへの移行 27
設定のインポート/エクスポート 52
通知の設定 56
文書定義 文書定義の設定 33
特権 フォルダーへのフルアクセス 28
トップレベルフォルダーの作成 29
ごみ箱管理 30
レビュー管理 31
文書管理 35
非表示カスタムプロパティの操作 51
第 1 章 SPA Web API リファレンス
305
Roles Create(Ver. 4) 指定されたロールを作成します。
URI
http://<hostname>:44230/spa/service/roles_v4
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
3 言語設定のオブジェクト例(JSON 形式)
{
"name": "MY_ROLE",
"labels": [
{
"language": "zh_CN",
"title": "顶层文件夹创建",
"description": "可进行顶层文件夹的创建及其访问权限的设置"
},
{
"language": "en",
"title": "Create Top Level Folder",
"description": "Can create top level folders, as well as set access permissions to them."
},
{
"language": "ja",
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
}
第 1 章 SPA Web API リファレンス
306
3 言語設定のオブジェクト例(JSON 形式)
],
"authorities": [
{
"id": 29,
"value": "ALLOW"
}
]
}
1 言語設定のオブジェクト例(JSON 形式)
{
"name": "MY_ROLE",
"labels": [
{
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
}
],
"authorities": [
{
"id": 29,
"value": "ALLOW"
}
]
}
■ データ内容
キー 必須 値 備考
name 文字列 ロール名です。
labels ロールの表示情報リスト
language ja ロールの「表示名」と「説明」の表示言語が「日本語」です。
en ロールの「表示名」と「説明」の表示言語が「英語」です。
第 1 章 SPA Web API リファレンス
307
キー 必須 値 備考
zh_CN ロールの「表示名」と「説明」の表示言語が「中国語(簡体字)」です。
title 文字列 表示名です。
description 文字列 説明です。
authorities ロールの権限情報
id 数値 権限 ID です。
権限 ID については「authorities キーの id キーに指定する権限 ID(P.307)」を参照し
てください。
value ALLOW 操作が許可されています。
DENY 操作が許可されていません。
authorities キーの id キーに指定する権限 ID
authorities キーの id キーに指定する権限の ID は次のとおりです。
カテゴリ 操作の内容 権限 ID
検索 条件の保存 1
全文検索 46
基本プロパティ検索 47
カスタムプロパティ検索 48
SVF 検索フィールド検索 49
明細検索 50
データ出力 検索結果の CSV ファイル出力 2
SVF 検索フィールドデータの CSV ファイル出力 53
ダウンロード ダウンロード 3
無加工ダウンロード 4
印刷 印刷 5
プレビュー プレビュー 6
ファイル ファイル名の変更 8
ファイルまたはリンクの移動 36
ファイルまたはリンクの削除 9
リンクの作成 10
第 1 章 SPA Web API リファレンス
308
カテゴリ 操作の内容 権限 ID
アーカイブ 11
プロパティの変更 23
マスクの適用 37
検索結果へのマスク適用 54
履歴の閲覧と復元 55
フォルダー フォルダーの作成 12
フォルダー名の変更 13
フォルダーの移動 38
フォルダーの削除 14
透かしの設定 16
暗号化の設定 17
アクセス権の設定 18
削除の履歴 削除記録の確認 39
レビュー レビューの作成 40
個人設定 ユーザープロファイル 19
カラム表示の設定 34
サーバー設定 環境設定 21
運用管理 ユーザーの設定 20
カスタムプロパティの設定 22
マスク設定 41
共通検索条件の設定 42
スタンプ、注釈画像アイテムの設定 43
セッション管理 44
カラム表示のデフォルト設定 24
ファイル証跡情報の設定 45
ファイル証跡情報の確認 26
メンテナンスモードへの移行 27
設定のインポート/エクスポート 52
第 1 章 SPA Web API リファレンス
309
カテゴリ 操作の内容 権限 ID
通知の設定 56
文書定義 文書定義の設定 33
特権 フォルダーへのフルアクセス 28
トップレベルフォルダーの作成 29
ごみ箱管理 30
レビュー管理 31
文書管理 35
非表示カスタムプロパティの操作 51
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。ロールが正常に作成された場合は、「Roles Get(Ver. 4)
(P.300)」と同様の形式でロール情報を付けて返します。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -550 カスタムロール作成時、作成しようとしているロールと同じ名前のロールが存在
している場合に出力されます。
第 1 章 SPA Web API リファレンス
310
HTTP ステータ
ス
エラーコー
ド
備考
400 -553 ロール数が管理画面の[最大ロール数]に設定された値を超える場合に出力され
ます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20605 ロール名が指定されていない場合に出力されます。
404 -20610 存在しない権限 ID を指定した場合に出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。ロール名、表示名、説明
に半角 129 文字以上の文字列が指定されたり、ロール名に¥ / : * ? " < > |が使用さ
れている場合などです。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
正常に作成された場合の出力例(JSON 形式)
{
"system": false,
"id": "11",
"name": "MY_ROLE",
"labels": [
{
"language": "zh_CN",
"title": "顶层文件夹创建",
"description": "可进行顶层文件夹的创建及其访问权限的设置"
},
{
"language": "en",
第 1 章 SPA Web API リファレンス
311
正常に作成された場合の出力例(JSON 形式)
"title": "Create Top Level Folder",
"description": "Can create top level folders, as well as set access permissions to them."
},
{
"language": "ja",
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
}
],
"authorities": [
{
"id": 29,
"value": "ALLOW"
}
]
}
1 言語のみ設定した場合の出力例(JSON 形式)
{
"system": false,
"id": "12",
"name": "MY_ROLE",
"labels": [
{
"language": "zh_CN",
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
},
{
"language": "en",
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
},
第 1 章 SPA Web API リファレンス
312
1 言語のみ設定した場合の出力例(JSON 形式)
{
"language": "ja",
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
}
],
"authorities": [
{
"id": 29,
"value": "ALLOW"
}
]
}
• 1 言語のみ指定した場合、3 言語すべてに、同じ表示名と説明が設定されます。
■ データ内容
キー 値 備考
system true システムロールです。
false システムロールではありません。
id 文字列 このロールに割り当てられたシステムで一意の番号(ID)です。
name 文字列 ロール名です。
labels ロールの表示情報リスト
language ja ロールの「表示名」と「説明」の表示言語が「日本語」です。
en ロールの「表示名」と「説明」の表示言語が「英語」です。
zh_CN ロールの「表示名」と「説明」の表示言語が「中国語(簡体字)」です。
title 文字列 表示名です。
description 文字列 説明です。
authorities ロールの権限情報
id 数値 権限 ID です。
第 1 章 SPA Web API リファレンス
313
キー 値 備考
権限 ID については「authorities キーの id キーに指定する権限 ID(P.307)」を参照してくださ
い。
value ALLOW 操作が許可されています。
DENY 操作が許可されていません。
第 1 章 SPA Web API リファレンス
314
Roles Update(Ver. 4) 指定された内容でロールの権限に関する情報を更新します。
URI
http://<hostname>:44230/spa/service/roles_v4/<id>
• キー
キー 必須 値 備考
id 対象となるロールの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"labels": [
{
"language": "zh_CN",
"title": "文件夹完全访问",
"description": "无论文件夹的访问权限如何,都可进行"读取"、"写入"、"取得""
},
{
"language": "en",
"title": "Create Top Level Folder",
"description": "Can create top level folders, as well as set access permissions to them."
},
{
第 1 章 SPA Web API リファレンス
315
オブジェクトの例(JSON 形式)
"language": "ja",
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
}
],
"authorities": [
{
"id": 29,
"value": "DENY"
}
]
}
■ データ内容
キー 必須 値 備考
labels ロールの表示情報リスト
language ja ロールの「表示名」と「説明」の表示言語が「日本語」です。
en ロールの「表示名」と「説明」の表示言語が「英語」です。
zh_CN ロールの「表示名」と「説明」の表示言語が「中国語(簡体字)」です。
title 文字列 表示名です。
指定されていない場合は、設定されている値が削除されます。
description 文字列 説明です。
指定されていない場合は、設定されている値が削除されます。
authorities ロールの権限情報
id 数値 権限 ID です。
指定されていない場合は、設定されている値が削除されます。
権限 ID については「authorities キーの id キーに指定する権限 ID(P.316)」を参照し
てください。
value ALLOW 操作が許可されています。
指定されていない場合は、設定されている値が削除されます。
DENY 操作が許可されていません。
第 1 章 SPA Web API リファレンス
316
キー 必須 値 備考
指定されていない場合は、設定されている値が削除されます。
authorities キーの id キーに指定する権限 ID
authorities キーの id キーに指定する権限の ID は次のとおりです。
カテゴリ 操作の内容 権限 ID
検索 条件の保存 1
全文検索 46
基本プロパティ検索 47
カスタムプロパティ検索 48
SVF 検索フィールド検索 49
明細検索 50
データ出力 検索結果の CSV ファイル出力 2
SVF 検索フィールドデータの CSV ファイル出力 53
ダウンロード ダウンロード 3
無加工ダウンロード 4
印刷 印刷 5
プレビュー プレビュー 6
ファイル ファイル名の変更 8
ファイルまたはリンクの移動 36
ファイルまたはリンクの削除 9
リンクの作成 10
アーカイブ 11
プロパティの変更 23
マスクの適用 37
検索結果へのマスク適用 54
履歴の閲覧と復元 55
フォルダー フォルダーの作成 12
フォルダー名の変更 13
フォルダーの移動 38
第 1 章 SPA Web API リファレンス
317
カテゴリ 操作の内容 権限 ID
フォルダーの削除 14
透かしの設定 16
暗号化の設定 17
アクセス権の設定 18
削除の履歴 削除記録の確認 39
レビュー レビューの作成 40
個人設定 ユーザープロファイル 19
カラム表示の設定 34
サーバー設定 環境設定 21
運用管理 ユーザーの設定 20
カスタムプロパティの設定 22
マスク設定 41
共通検索条件の設定 42
スタンプ、注釈画像アイテムの設定 43
セッション管理 44
カラム表示のデフォルト設定 24
ファイル証跡情報の設定 45
ファイル証跡情報の確認 26
メンテナンスモードへの移行 27
設定のインポート/エクスポート 52
通知の設定 56
文書定義 文書定義の設定 33
特権 フォルダーへのフルアクセス 28
トップレベルフォルダーの作成 29
ごみ箱管理 30
レビュー管理 31
文書管理 35
非表示カスタムプロパティの操作 51
第 1 章 SPA Web API リファレンス
318
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• システムロールの権限情報は、更新できません。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。指定されたすべての権限について変更が完了した場合の
み正常終了になります。正常に更新された場合は、「Roles Get(Ver. 4)
(P.300)」と同様の形式の情報を付けて返します。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -551 対象のロールが存在しない場合に出力されます。
400 -552 システムロールと同じ名前のロールを作成しようとしたか、または、システムロ
ールの情報を変更/削除しようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20605 ロール名が指定されていない場合に出力されます。
404 -20610 存在しない権限 ID を指定した場合に出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
第 1 章 SPA Web API リファレンス
319
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
正常に作成された場合の出力例(JSON 形式)
{
"system": false,
"id": "11",
"name": "MY_ROLE",
"labels": [
{
"language": "zh_CN",
"title": "顶层文件夹创建",
"description": "可进行顶层文件夹的创建及其访问权限的设置"
},
{
"language": "en",
"title": "Create Top Level Folder",
"description": "Can create top level folders, as well as set access permissions to them."
},
{
"language": "ja",
"title": "トップレベルフォルダー作成",
"description": "トップレベルフォルダーの作成と、トップレベルフォルダーのアクセス権が設定可能"
}
],
"authorities": [
{
"id": 29,
第 1 章 SPA Web API リファレンス
320
正常に作成された場合の出力例(JSON 形式)
"value": "DENY"
}
]
}
■ データ内容
キー 値 備考
system true システムロールです。
false システムロールではありません。
id 文字列 このロールに割り当てられたシステムで一意の番号(ID)です。
name 文字列 ロール名です。
labels ロールの表示情報リスト
language ja ロールの「表示名」と「説明」の表示言語が「日本語」です。
en ロールの「表示名」と「説明」の表示言語が「英語」です。
zh_CN ロールの「表示名」と「説明」の表示言語が「中国語(簡体字)」です。
title 文字列 表示名です。
description 文字列 説明です。
authorities ロールの権限情報
id 数値 権限 ID です。
権限 ID については「authorities キーの id キーに指定する権限 ID(P.316)」を参照してくださ
い。
value ALLOW 操作が許可されています。
DENY 操作が許可されていません。
第 1 章 SPA Web API リファレンス
321
Roles Delete 指定された ID を持つロールの情報を削除します。
URI
http://<hostname>:44230/spa/service/roles/deleteList
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"ids":[
"2",
"3",
"5"
]
}
■ データ内容
キー 必須 値 説明
ids 文字列 削除したいロールの ID のリスト
▌その他の注意事項
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
322
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。複数のグループを削除する場合は、すべてのグループが
削除できたときに出力されます。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -551 対象のロールが存在しない場合に出力されます。
400 -552 システムロールと同じ名前のロールを作成しようとしたか、または、システムロ
ールの情報を変更/削除しようとした場合に出力されます。
400 -554 対象のロールがグループに適用されていて削除できなかった場合に出力されま
す。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20606 ロールの ID が指定されていない場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
323
16 ドメイン情報操作 ドメイン情報操作に関する API は次のとおりです。
• Domains List(Ver. 2)(P.324)
• Domains Create(Ver. 2)(P.330)
• Domains Update(Ver. 2)(P.335)
• Domains Default Update(P.340)
• Domains Delete(P.342)
第 1 章 SPA Web API リファレンス
324
Domains List(Ver. 2) ドメイン名のリストを取得します。
URI
http://<hostname>:44230/spa/service/domains_v2
HTTP メソッド
GET
▌パラメーター
キー 必須 値 備考
detail ドメインに関する詳細情報(ドメイン接続情報、自動同期スケジュー
ル)についても取得するかどうか
• true
取得する
• false(デフォルト)
取得しない
クエリーパラメーターで指
定します。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• detail の値が true の場合のみ、ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
325
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"domain": [
{
"id": "0",
"name": "local",
"use": true,
"connectInfo": null
},
{
"id": "1",
"name": "domain1",
"use": true,
"connectInfo": null
},
...
],
"default": "0",
第 1 章 SPA Web API リファレンス
326
出力例(JSON 形式)
"schedule": null
}
detail の値が true の場合の出力例(JSON 形式)
{
"domain": [
{
"id": "0",
"name": "local",
"use": true,
"connectInfo": null
},
{
"id": "1",
"name": "domain1",
"use": true,
"connectInfo": {
"connectionName": "conn1",
"autoSync": false,
"syncGroup": false,
"lastUpdate": "2015-11-20T11:03:43.639+0900",
"primary": {
"address": "127.0.0.1",
"port": 389,
"id": "id",
"password": "password"
},
"secondary": null,
"userFilterQuery": "(!(cn=*user))",
"groupFilterQuery": "(!(cn=*group))",
"organizationalUnitFilterQuery": "(ou=organization)"
}
},
第 1 章 SPA Web API リファレンス
327
detail の値が true の場合の出力例(JSON 形式)
...
],
"default": "0",
"schedule": {
"cycle": "DAILY",
"days": 1,
"hours": 0,
"minutes": 0
}
}
■ データ内容
キー 値 備考
domain ドメイン情報のリスト
詳細は、「ドメイン情報に関するキーについて(P.327)」を参照してください。
default 文字列 デフォルトドメインの ID です。
schedule 自動同期における更新時刻の設定
「detail」キーが true の場合のみ取得します。それ以外は null です。
詳細は、「自動同期の更新時刻設定に関するキーについて(P.328)」を参照してください。
ドメイン情報に関するキーについて
キー 値 備考
id 文字列 ドメインの ID です。
name 文字列 ドメインの名称です。
use true ドメインが有効です。
false ドメインが無効です。
connectInfo ドメインが Active Directory の場合のサーバー接続設定
detail の値が true の場合のみ取得します。それ以外は null です。
local ドメインの場合は null になります。
詳細は、「Active Directory の場合のサーバー接続設定に関するキーについて(P.328)」を参照
してください。
第 1 章 SPA Web API リファレンス
328
Active Directory の場合のサーバー接続設定に関するキーについて
キー 値 備考
connectionName 文字列 接続設定の名称です。
autoSync true 自動的に同期します。
false 自動的に同期しません。
syncGroup true グループ情報を同期します。
false グループ情報を同期しません。
lastUpdate 文字列 最後に同期した時刻です。
primary プライマリサーバーの設定情報
詳細は、「サーバーの設定情報に関するキーについて(P.328)」を参照して
ください。
secondary セカンダリサーバーの設定情報
デフォルトおよび設定がない場合「null」です。詳細は、「サーバーの設定
情報に関するキーについて(P.328)」を参照してください。
userFilterQuery 文字列 Active Directory のユーザーフィルターの文字列です。
groupFilterQuery 文字列 Active Directory のグループフィルターの文字列です。
organizationalUnitFilterQuery 文字列 Active Directory の組織フィルターの文字列です。
サーバーの設定情報に関するキーについて
キー 値 備考
address 文字列 サーバーのアドレスです。
port 数値 ポート番号です。
id 文字列 接続時の ID です。
password 文字列 接続時のパスワードです。
自動同期の更新時刻設定に関するキーについて
キー 値 備考
cycle DAILY 同期のサイクルを「毎日」にします。
WEEKLY 同期のサイクルを「毎週」にします。
MONTHLY 同期のサイクルを「毎月」にします。
第 1 章 SPA Web API リファレンス
329
キー 値 備考
days 数値 同期サイクルの日数です。cycle の値によって異なります。
• DAILY
「1」で固定です。
• WEEKLY
日曜日が「1」、土曜日が「7」です。
• MONTHLY
同期する日です。1~31 の値です。
hours 数値 同期時刻の「時」です。0~23 の値です。
minutes 数値 同期時刻の「分」です。0~59 の値です。
第 1 章 SPA Web API リファレンス
330
Domains Create(Ver. 2) ドメイン設定を作成します。
URI
http://<hostname>:44230/spa/service/domains_v2
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"name": "domain1",
"use": true,
"connectInfo": {
"connectionName": "conn1",
"autoSync": false,
"syncGroup": true,
"primary": {
"address": "127.0.0.1",
"port": 389,
"id": "id",
"password": "password"
},
"secondary": null,
"userFilterQuery": "(!(cn=*user))",
"groupFilterQuery": "(!(cn=*group))",
"organizationalUnitFilterQuery": "(ou=organization)"
第 1 章 SPA Web API リファレンス
331
オブジェクトの例(JSON 形式)
}
}
■ データ内容
キー 必須 値 備考
name 文字列 ドメインの名称です。256 バイト以内で指定します。
use true ドメインが有効です。
false ドメインが無効(デフォルト)です。
connectInfo ドメインが Active Directory の場合のサーバー接続設定
詳細は、「Active Directory の場合のサーバー接続設定に関するキーについて
(P.331)」を参照してください。
Active Directory の場合のサーバー接続設定に関するキーについて
キー 必須 値 備考
connectionName 文字列 接続設定の名称です。256 バイト以内で指定します。
autoSync true 自動的に同期します。
false 自動的に同期しません。
指定されていない場合は、false が指定されたものとします。
syncGroup true グループ情報を同期します。
false グループ情報を同期しません。
指定されていない場合は、false が指定されたものとします。
primary プライマリサーバーの設定情報
詳細は、「サーバーの設定情報に関するキーについて(P.332)」を
参照してください。
secondary セカンダリサーバーの設定情報
詳細は、「サーバーの設定情報に関するキーについて(P.332)」を
参照してください。
userFilterQuery 文字列 Active Directory のユーザーフィルターの文字列です。
groupFilterQuery 文字列 Active Directory のグループフィルターの文字列です。
organizationalUnitFilterQuery 文字列 Active Directory の組織フィルターの文字列です。
第 1 章 SPA Web API リファレンス
332
サーバーの設定情報に関するキーについて
キー 必須 値 備考
address 文字列 サーバーのアドレスです。256 バイト以内で指定します。プライマリサーバーのドメ
イン情報を作成/更新する場合は、必須です。
port 数値 ポート番号です。1~65,535 以内で指定します。
指定されていない場合は、389 が指定されたものとします。
id 文字列 接続時の ID です。256 バイト以内で指定します。プライマリサーバーのドメイン情報
を作成/更新する場合は、必須です。
password 文字列 接続時のパスワードです。256 バイト以内で指定します。プライマリサーバーのドメ
イン情報を作成/更新する場合は、必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -650 Active Directory 接続設定の作成または変更時に指定したドメイン名が、既存
のドメイン名と重複する場合に出力されます。
400 -652 外部認証接続の設定数が、上限値を超えた場合に出力されます。
第 1 章 SPA Web API リファレンス
333
HTTP ステータス エラーコード 備考
400 -653 接続設定の作成または変更時に、指定した[外部接続名]が存在していた場
合に出力されます。
400 -682 外部認証サーバー接続設定の作成または変更時に、指定した[ユーザーフィ
ルター]の文字数が 4,096 文字を超えていた場合に出力されます。
400 -683 外部認証サーバー接続設定の作成または変更時に、指定した[グループフィ
ルター]の文字数が 4,096 文字を超えていた場合に出力されます。
400 -684 外部認証サーバー接続設定の作成または変更時に、指定した[組織フィルタ
ー]の文字数が 4,096 文字を超えていた場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "1",
"name": "domain1",
"use": true,
"connectInfo": {
"connectionName": "conn1",
"autoSync": false,
"syncGroup": true,
"lastUpdate": "2015-11-20T11:03:43.639+0900",
"primary": {
"address": "127.0.0.1",
第 1 章 SPA Web API リファレンス
334
出力例(JSON 形式)
"port": 389,
"id": "id",
"password": "password"
},
"secondary": null,
"userFilterQuery": "",
"groupFilterQuery": "",
"organizationalUnitFilterQuery": "(ou=organization)"
}
}
■ データ内容
キー 値 備考
connectionName 文字列 接続設定の名称です。256 バイト以内で指定します。ドメイン情報の作成
と更新の際は、必須です。
autoSync true 自動的に同期します。接続確認時には不要です。
false 自動的に同期しません(デフォルト)。接続確認時には不要です。
syncGroup true グループ情報を同期します。接続確認時には不要です。
false グループ情報を同期しません(デフォルト)。接続確認時には不要です。
lastUpdate 文字列 最後に同期した時刻です。設定時、接続確認時には不要です。
primary プライマリサーバーの設定情報
ドメイン情報の作成と更新の際は、必須です。詳細は、「サーバーの設定情
報に関するキーについて(P.332)」を参照してください。
secondary セカンダリサーバーの設定情報
デフォルトおよび設定がない場合「null」です。詳細は、「サーバーの設定
情報に関するキーについて(P.332)」を参照してください。
userFilterQuery 文字列 Active Directory のユーザーフィルターの文字列です。
groupFilterQuery 文字列 Active Directory のグループフィルターの文字列です。
organizationalUnitFilterQuery 文字列 Active Directory の組織フィルターの文字列です。
第 1 章 SPA Web API リファレンス
335
Domains Update(Ver. 2) 指定されたドメイン設定を更新します。
URI
http://<hostname>:44230/spa/service/domains_v2/<id>
• キー
キー 必須 値 備考
id 変更対象ドメインの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"name": "domain1",
"use": true,
"connectInfo": {
"connectionName": "conn1",
"autoSync": false,
"syncGroup": false,
"primary": {
"address": "127.0.0.1",
"port": 389,
"id": "id",
"password": "password"
},
第 1 章 SPA Web API リファレンス
336
オブジェクトの例(JSON 形式)
"secondary": null,
"userFilterQuery": "(!(cn=*user))",
"groupFilterQuery": "(!(cn=*group))",
"organizationalUnitFilterQuery": "(ou=organization)"
}
}
■ データ内容
キー 必須 値 備考
name 文字列 ドメインの名称です。256 バイト以内で指定します。
use true ドメインが有効です。
false ドメインが無効(デフォルト)です。
connectInfo ドメインが Active Directory の場合のサーバー接続設定
local ドメインの場合は null になります。
詳細は、「Active Directory の場合のサーバー接続設定に関するキーについて
(P.336)」を参照してください。
Active Directory の場合のサーバー接続設定に関するキーについて
キー 必須 値 備考
connectionName 文字列 接続設定の名称です。256 バイト以内で指定します。
autoSync true 自動的に同期します。
false 自動的に同期しません。
指定されていない場合は、false が指定されたものとします。
syncGroup true グループ情報を同期します。
false グループ情報を同期しません。
指定されていない場合は、false が指定されたものとします。
primary プライマリサーバーの設定情報
詳細は、「サーバーの設定情報に関するキーについて(P.337)」を
参照してください。
secondary セカンダリサーバーの設定情報
第 1 章 SPA Web API リファレンス
337
キー 必須 値 備考
詳細は、「サーバーの設定情報に関するキーについて(P.337)」を
参照してください。
userFilterQuery 文字列 Active Directory のユーザーフィルターの文字列です。
groupFilterQuery 文字列 Active Directory のグループフィルターの文字列です。
organizationalUnitFilterQuery 文字列 Active Directory の組織フィルターの文字列です。
サーバーの設定情報に関するキーについて
キー 必須 値 備考
address (*1) 文字列 サーバーのアドレスです。256 バイト以内で指定します。
port 数値 ポート番号です。1~65,535 以内で指定します。
指定されていない場合は、389 が指定されたものとします。
id (*1) 文字列 接続時の ID です。256 バイト以内で指定します。
password (*1) 文字列 接続時のパスワードです。256 バイト以内で指定します。
*1 プライマリサーバーの設定時に必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
第 1 章 SPA Web API リファレンス
338
HTTP ステータス エラーコード 備考
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -302 すでに同名のフォルダーが存在している場合に出力されます。
400 -650 Active Directory 接続設定の作成または変更時に指定したドメイン名が、既存
のドメイン名と重複する場合に出力されます。
404 -651 ドメインが存在しない場合に出力されます。
400 -653 Active Directory 接続設定の作成または変更時に、指定した[外部接続名]が
存在していた場合に出力されます。
400 -654 local ドメインを変更または削除しようとした場合に出力されます。
400 -682 Active Directory 接続設定の作成または変更時に、指定した[ユーザーフィル
ター]の文字数が 4,096 文字を超えていた場合に出力されます。
400 -683 Active Directory 接続設定の作成または変更時に、指定した[グループフィル
ター]の文字数が 4,096 文字を超えていた場合に出力されます。
400 -684 Active Directory 接続設定の作成または変更時に、指定した[組織フィルタ
ー]の文字数が 4,096 文字を超えていた場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "1",
"name": "domain1",
"use": true,
第 1 章 SPA Web API リファレンス
339
出力例(JSON 形式)
"connectInfo": {
"connectionName": "conn1",
"autoSync": false,
"syncGroup": false,
"lastUpdate": "2015-11-20T11:03:43.639+0900",
"primary": {
"address": "127.0.0.1",
"port": 389,
"id": "id",
"password": "password"
},
"secondary": null,
"userFilterQuery": "(!(cn=*user))",
"groupFilterQuery": "(!(cn=*group))",
"organizationalUnitFilterQuery": "(ou=organization)"
}
}
■ データ内容
キー 値 備考
id 文字列 ドメインの ID です。
name 文字列 ドメインの名称です。
use true ドメインが有効です。
false ドメインが無効(デフォルト)です。
connectInfo ドメインが Active Directory の場合のサーバー接続設定
detail の値が true の場合のみ取得します。それ以外は null です。
local ドメインの場合は null になります。
詳細は、「Active Directory の場合のサーバー接続設定に関するキーについて(P.336)」を参照
してください。
第 1 章 SPA Web API リファレンス
340
Domains Default Update デフォルトドメインの ID を設定します。
URI
http://<hostname>:44230/spa/service/domains/default
HTTP メソッド
PUT
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
domainId 変更対象ドメインの ID
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
341
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -651 ドメインが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
342
Domains Delete 指定されたドメイン設定を削除します。
URI
http://<hostname>:44230/spa/service/domains/deleteList
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"ids": [
"5",
"6"
]
}
■ データ内容
キー 必須 値 備考
ids 文字列 削除したいドメインの ID のリスト
▌その他の注意事項
• ログインしている必要があります。
• デフォルトドメインに設定されているドメインを削除した場合、「local」ドメインがデフォルトドメイ
ンに設定されます。
第 1 章 SPA Web API リファレンス
343
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。複数のユーザーを削除する場合は、すべてのユーザーが
削除できたときに出力されます。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -651 ドメインが存在しない場合に出力されます。
400 -654 local ドメインを変更または削除しようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
344
17 アクセス権 アクセス権に関する API は次のとおりです。
• Permission Get(Ver. 3)(P.345)
• Permission Update(Ver. 3)(P.351)
第 1 章 SPA Web API リファレンス
345
Permission Get(Ver. 3) 指定したフォルダーのアクセス権の情報を取得します。
URI
http://<hostname>:44230/spa/service/permissions_v3/<id>
• キー
キー 必須 値 備考
id 取得対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
346
HTTP ステータ
ス
エラーコー
ド
備考
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -9997 パスにルート(「/」)が指定された場合など、指定した値に誤りがある場合に出力
されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "2",
"name": "",
"auto": true,
"inherit": false,
"inheritFolderId": "-1",
"permissions": [
{
"groupId": "1",
"name": "AdminGroup",
"fullName": "AdminGroup",
"domainId": "1",
"domainName": "local",
"readable": true,
"downloadable": true,
"writable": true,
第 1 章 SPA Web API リファレンス
347
出力例(JSON 形式)
"annotationWritable": true,
"commentWritable": true,
"svfFieldEditable": true,
"allDenied": false
},
{
"groupId": "2",
"name": "UserGroup",
"fullName": "UserGroup",
"domainId": "1",
"domainName": "local",
"readable": true,
"downloadable": true,
"writable": false,
"annotationWritable": false,
"commentWritable": false,
"svfFieldEditable": false,
"allDenied": false
},
...
],
"userPermissions": [
{
"userId": "1",
"name": "admin1",
"fullName": "admin1",
"domainId": "1",
"domainName": "local",
"readable": true,
"downloadable": true,
"writable": true,
"annotationWritable": true,
"commentWritable": true,
第 1 章 SPA Web API リファレンス
348
出力例(JSON 形式)
"svfFieldEditable": true,
"allDenied": false
},
{
"userId": "2",
"name": "user1",
"fullName": "user1",
"domainId": "1",
"domainName": "local",
"readable": true,
"downloadable": true,
"writable": false,
"annotationWritable": false,
"commentWritable": false,
"svfFieldEditable": false,
"allDenied": false
},
...
]
}
■ データ内容
キー 値 備考
id 文字列 アクセス権のマスターID です。auto キーが false の場合のみ意味を持ちます。
name 文字列 マスター上の名称です。auto キーが false の場合のみ意味を持ちます。
auto true 個々のフォルダーに設定されたアクセス権です。
false マスターに設定されたアクセス権です。
inherit true 親フォルダーからアクセス権を継承しています。
false 親フォルダーからアクセス権を継承していません。
inheritFolderId 文字列 アクセス権設定を継承している親フォルダーの ID です。inherit キーが true の場合のみ
有効です。
第 1 章 SPA Web API リファレンス
349
キー 値 備考
permissions グループごとのアクセス権リスト
詳細は、「グループごとのアクセス権に関するキーについて(P.349)」を参照してくださ
い。
userPermissions ユーザーごとのアクセス権リスト
詳細は、「ユーザーごとのアクセス権に関するキーについて(P.350)」を参照してくださ
い。
グループごとのアクセス権に関するキーについて
キー 値 備考
groupId 文字列 アクセス権を設定したグループの ID です。
name 文字列 グループ名です。
fullName 文字列 グループのフルネームです。
domainId 文字列 ドメインの ID です。
domainName 文字列 ドメイン名です。
readable true 「読み込み」のアクセス権があります。
false 「読み込み」のアクセス権がありません。
downloadable true 「取り出し」のアクセス権があります。
false 「取り出し」のアクセス権がありません。
writable true 「書き込み」のアクセス権があります。
false 「書き込み」のアクセス権がありません。
annotationWritable true 「注釈」が利用できます。
false 「注釈」が利用できません。
commentWritable true 「文書のコメント」が利用できます。
false 「文書のコメント」が利用できません。
svfFieldEditable true 「SVF 検索フィールドの編集」のアクセス権があります。
false 「SVF 検索フィールドの編集」のアクセス権がありません。
allDenied true 「拒否」が指定されます。
false 「拒否」は指定されません。
第 1 章 SPA Web API リファレンス
350
ユーザーごとのアクセス権に関するキーについて
キー 値 備考
userId 文字列 アクセス権を設定したユーザーの ID です。
name 文字列 ユーザー名です。
fullName 文字列 ユーザーのフルネームです。
domainId 文字列 ドメインの ID です。
domainName 文字列 ドメイン名です。
readable true 「読み込み」のアクセス権があります。
false 「読み込み」のアクセス権がありません。
downloadable true 「取り出し」のアクセス権があります。
false 「取り出し」のアクセス権がありません。
writable true 「書き込み」のアクセス権があります。
false 「書き込み」のアクセス権がありません。
annotationWritable true 「注釈」が利用できます。
false 「注釈」が利用できません。
commentWritable true 「文書のコメント」が利用できます。
false 「文書のコメント」が利用できません。
svfFieldEditable true 「SVF 検索フィールドの編集」のアクセス権があります。
false 「SVF 検索フィールドの編集」のアクセス権がありません。
allDenied true 「拒否」が指定されます。
false 「拒否」は指定されません。
第 1 章 SPA Web API リファレンス
351
Permission Update(Ver. 3) 指定したフォルダーのアクセス権をすべてのグループおよびすべてのユーザーに一括して設定します。
URI
http://<hostname>:44230/spa/service/permissions_v3/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"clear": true,
"permissionsData": {
"auto": true,
"permissions": [
{
"groupId": "1",
"readable": true,
"downloadable": true,
"writable": true,
"annotationWritable": true,
"commentWritable": true,
"svfFieldEditable": true,
第 1 章 SPA Web API リファレンス
352
オブジェクトの例(JSON 形式)
"allDenied": false
},
{
"groupId": "2",
"readable": true,
"downloadable": true,
"writable": false,
"annotationWritable": false,
"commentWritable": false,
"svfFieldEditable": false,
"allDenied": false
},
...
],
"userPermissions": [
{
"userId": "1",
"readable": true,
"downloadable": true,
"writable": true,
"annotationWritable": true,
"commentWritable": true,
"svfFieldEditable": true,
"allDenied": false
},
{
"userId": "2",
"readable": true,
"downloadable": true,
"writable": false,
"annotationWritable": false,
"commentWritable": false,
"svfFieldEditable": false,
第 1 章 SPA Web API リファレンス
353
オブジェクトの例(JSON 形式)
"allDenied": false
},
...
]
}
}
■ データ内容
キー 必須 値 備考
clear true 指定したフォルダー配下のアクセス権設定をクリアします。
false 指定したフォルダー配下のアクセス権設定をクリアしません。
指定されていない場合は、false が指定されたものとします。
permissionsData アクセス権
「アクセス権に関するキーについて(P.353)」を参照してください。
トップレベルフォルダー配下のフォルダーで、親フォルダーのアクセス権設定
を継承する場合は、permissions 要素と userPermissions 要素を 0 個にする必
要があります。
アクセス権に関するキーについて
キー 必
須
値 備考
id 文字列 本 API では使用しません。
name 文字列 本 API では使用しません。
auto true 個々のフォルダーに設定されたアクセス権です。「true」固定です。
inherit true 親フォルダーからアクセス権を継承しています。
本 API では、指定しても無視されます。
false 親フォルダーからアクセス権を継承していません。
本 API では、指定しても無視されます。
inheritFolderId 文字列 アクセス権設定を継承している親フォルダーの ID です。inherit キーが true の場
合のみ有効です。
本 API では、指定しても無視されます。
permissions グループごとのアクセス権リスト
第 1 章 SPA Web API リファレンス
354
キー 必
須
値 備考
詳細は、「グループごとのアクセス権に関するキーについて(P.354)」を参照して
ください。
Permission Update の場合、トップレベルフォルダー配下のフォルダーで親フォ
ルダーのアクセス権設定を継承する場合は、permissions 要素と
userPermissions 要素を 0 個にする必要があります。
userPermissions ユーザーごとのアクセス権リスト
詳細は、「ユーザーごとのアクセス権に関するキーについて(P.355)」を参照して
ください。
Permission Update の場合、トップレベルフォルダー配下のフォルダーで親フォ
ルダーのアクセス権設定を継承する場合は、permissions 要素と
userPermissions 要素を 0 個にする必要があります。
グループごとのアクセス権に関するキーについて
キー 必須 値 備考
groupId (*1) 文字列 アクセス権を設定したグループの ID です。
name 文字列 グループ名です。
本 API では、指定しても無視されます。
fullName 文字列 グループのフルネームです。
本 API では、指定しても無視されます。
domainId 文字列 ドメインの ID です。
本 API では、指定しても無視されます。
domainName 文字列 ドメイン名です。
本 API では、指定しても無視されます。
readable true 「読み込み」のアクセス権があります。
false 「読み込み」のアクセス権がありません。
指定されていない場合は、false が指定されたものとします。
downloadable true 「取り出し」のアクセス権があります。
false 「取り出し」のアクセス権がありません。
指定されていない場合は、false が指定されたものとします。
writable true 「書き込み」のアクセス権があります。
false 「書き込み」のアクセス権がありません。
第 1 章 SPA Web API リファレンス
355
キー 必須 値 備考
指定されていない場合は、false が指定されたものとします。
annotationWritable true 「注釈」が利用できます。
false 「注釈」が利用できません。
指定されていない場合は、false が指定されたものとします。
commentWritable true 「文書のコメント」が利用できます。
false 「文書のコメント」が利用できません。
指定されていない場合は、false が指定されたものとします。
svfFieldEditable true 「SVF 検索フィールドの編集」のアクセス権があります。
false 「SVF 検索フィールドの編集」のアクセス権がありません。
指定されていない場合は、false が指定されたものとします。
allDenied true 「拒否」が指定されます。
指定されていない場合は、true が指定されたものとします。
false 「拒否」は指定されません。
*1 グループのアクセス権を更新する場合に必須です。
ユーザーごとのアクセス権に関するキーについて
キー 必須 値 備考
userId (*1) 文字列 アクセス権を設定したユーザーの ID です。
name 文字列 ユーザー名です。
本 API では、指定しても無視されます。
fullName 文字列 ユーザーのフルネームです。
本 API では、指定しても無視されます。
domainId 文字列 ドメインの ID です。
本 API では、指定しても無視されます。
domainName 文字列 ドメイン名です。
本 API では、指定しても無視されます。
readable true 「読み込み」のアクセス権があります。
false 「読み込み」のアクセス権がありません。
指定されていない場合は、false が指定されたものとします。
downloadable true 「取り出し」のアクセス権があります。
false 「取り出し」のアクセス権がありません。
第 1 章 SPA Web API リファレンス
356
キー 必須 値 備考
指定されていない場合は、false が指定されたものとします。
writable true 「書き込み」のアクセス権があります。
false 「書き込み」のアクセス権がありません。
指定されていない場合は、false が指定されたものとします。
annotationWritable true 「注釈」が利用できます。
false 「注釈」が利用できません。
指定されていない場合は、false が指定されたものとします。
commentWritable true 「文書のコメント」が利用できます。
false 「文書のコメント」が利用できません。
指定されていない場合は、false が指定されたものとします。
svfFieldEditable true 「SVF 検索フィールドの編集」のアクセス権があります。
false 「SVF 検索フィールドの編集」のアクセス権がありません。
指定されていない場合は、false が指定されたものとします。
allDenied true 「拒否」が指定されます。
指定されていない場合は、true が指定されたものとします。
false 「拒否」は指定されません。
*1 ユーザーのアクセス権を更新する場合に必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
• 次のフォルダーに対し、アクセス権は設定できません。
○ パブリックのルートフォルダー(/)
○ ユーザールートフォルダー(/Users)
○ ドメインルートフォルダー(/Users/<ドメイン名>)
○ ログインしているユーザーのホームフォルダー(/Users/<ドメイン名>/<ユーザー名>)
○ マイフォルダー(/Users/<ドメイン名>/<ユーザー名>配下)
第 1 章 SPA Web API リファレンス
357
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
404 -501 対象のユーザーが存在しない場合に出力されます。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。パスにルート(「/」)が指定された
場合や、次のフォルダーを指定した場合などです。
• ユーザールートフォルダー
• ドメインルートフォルダー
• ログインしているユーザーのホームフォルダー
• マイフォルダー
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。次の指定をした場合など
です。
• permissions に同じ groupId を複数登録した場合
第 1 章 SPA Web API リファレンス
358
HTTP ステータ
ス
エラーコー
ド
備考
• userPermissions に同じ userId を複数登録した場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
359
18 透かし設定 透かし設定に関する API は次のとおりです。
• Watermark Get(P.360)
• Watermark Image Get(P.364)
• Watermark Update(P.366)
第 1 章 SPA Web API リファレンス
360
Watermark Get 指定したフォルダーの透かしに関する設定を取得します。
URI
http://<hostname>:44230/spa/service/watermark/<id>
• キー
キー 必須 値 備考
id 取得対象フォルダーパスの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
361
HTTP ステータ
ス
エラーコー
ド
備考
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
透かし設定がある場合の出力例(JSON 形式)
{
"status": "ON",
"inheritFolderId": "-1",
"settings": {
"type": "CUSTOM",
"width": 437,
"height": 128,
"keepAspectRatio": false,
"background": true,
"opaque": 50,
"action": "BOTH"
}
}
透かし設定がない場合の出力例(JSON 形式)
{
"status": "OFF",
"inheritFolderId": "-1",
第 1 章 SPA Web API リファレンス
362
透かし設定がない場合の出力例(JSON 形式)
"settings": null
}
透かし設定が親フォルダーの設定を継承する場合の出力例(JSON 形式)
{
"status": "INHERITED",
"inheritFolderId": "8",
"settings": {
"type": "CUSTOM",
"width": 437,
"height": 128,
"keepAspectRatio": false,
"background": true,
"opaque": 50,
"action": "BOTH"
}
}
■ データ内容
キー 値 備考
status INHERITED 親フォルダーの設定を継承します。
OFF 透かしを設定しません。
ON 透かしを設定します。
inheritFolderId 文字列 status が INHERITED の場合の継承しているフォルダーID です。
settings 透かし設定
status が OFF の場合は、null です。
status が INHERITED の場合は、継承しているフォルダーの透かし設定です。null
の場合は、継承先のフォルダーにも透かしは設定されません。
background true 「画像ファイルの外観」を「ページの背面」とします。
false 「画像ファイルの外観」を「ページの前面」とします。
action BOTH 画像ファイルの表示を「閲覧時、印刷時に表示」に設定します。
第 1 章 SPA Web API リファレンス
363
キー 値 備考
VIEW 画像ファイルの表示を「閲覧時に表示」に設定します。
PRINT 画像ファイルの表示を「印刷時に表示」に設定します。
type FITPAGE 画像ファイルの配置を「ページに合わせる」に設定します。
TILE 画像ファイルの配置を「ページ全面にタイル表示」に設定します。
CUSTOM 画像ファイルの配置を「ページ中央に表示」に設定します。
width 数値 画像の幅です。
height 数値 画像の高さです。
keepAspectRatio true 画像の縦横比を固定します。
false 画像の縦横比を固定しません。
opaque 数値 画像の不透明度です。
第 1 章 SPA Web API リファレンス
364
Watermark Image Get 指定したフォルダーに透かし画像が設定されていた場合、その画像を取得します。
URI
http://<hostname>:44230/spa/service/watermark/image/<id>
• キー
キー 必須 値 備考
id 取得対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type 取得する画像の種類 取得する画像の種類によって以下の値が指定されます。
• image/png
• image/jpeg
• image/bmp
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
365
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。透かし画像が設定されていないフォルダーが指定された
場合は、HTTP レスポンスのコンテンツにデータは設定されませんが、正常終了
となります。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
366
Watermark Update 指定したフォルダーに透かしを設定します。
URI
http://<hostname>:44230/spa/service/watermark/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
PUT
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必
須
値 備考
file 更新情報が記述された JSON 「オブジェクト(P.366)」を参照してください。
image 透かし画像データファイル 「status」キーを ON にする場合、すでに画像が設定されていなけれ
ば必須です。
▌オブジェクト
透かし設定を行う場合の例(JSON 形式)
{
"status": "ON",
"settings": {
"type": "CUSTOM",
"width": 437,
第 1 章 SPA Web API リファレンス
367
透かし設定を行う場合の例(JSON 形式)
"height": 128,
"keepAspectRatio": false,
"background": true,
"opaque": 50,
"action": "BOTH"
}
}
透かし設定を行わない場合の例(JSON 形式)
{
"status": "OFF",
"settings": null
}
親フォルダーの透かし設定を継承する場合の例(JSON 形式)
{
"status": "INHERITED",
"settings": null
}
■ データ内容
キー 必須 値 備考
status INHERITED 親フォルダーの設定を継承します。
指定されていない場合は、INHERITED が指定されたものとします。
OFF 透かしを設定しません。
ON 透かしを設定します。
settings (*1) 透かし設定
status が OFF の場合は、null です。
status が INHERITED の場合は、継承しているフォルダーの透かし設
定です。null の場合は、継承先のフォルダーにも透かしは設定されま
せん。
Watermark Update では status が ON の場合のみ必要です。
第 1 章 SPA Web API リファレンス
368
キー 必須 値 備考
background true 「画像ファイルの外観」を「ページの背面」とします。
false 「画像ファイルの外観」を「ページの前面」とします。
指定されていない場合は、false が指定されたものとします。
action BOTH 画像ファイルの表示を「閲覧時、印刷時に表示」に設定します。
指定されていない場合は、BOTH が指定されたものとします。
VIEW 画像ファイルの表示を「閲覧時に表示」に設定します。
PRINT 画像ファイルの表示を「印刷時に表示」に設定します。
type FITPAGE 画像ファイルの配置を「ページに合わせる」に設定します。
指定されていない場合は、FITPAGE が指定されたものとします。
TILE 画像ファイルの配置を「ページ全面にタイル表示」に設定します。
CUSTOM 画像ファイルの配置を「ページ中央に表示」に設定します。
width 数値 画像の幅を 30,000 以下で指定します。
0 未満を指定すると、画像の幅を取得してセットします。ただし、画
像が一緒に指定されていない場合は、1 がセットされます。それ以外
の値を指定すると、その指定された値をセットします。
type が FITPAGE 以外の場合のみ使用します。
指定されていない場合は、0 が指定されたものとします。
height 数値 画像の高さを 30,000 以下で指定します。
0 未満を指定すると、画像の高さを取得してセットします。ただし、
画像が一緒に指定されていない場合は、1 がセットされます。それ以
外の値を指定すると、その指定された値をセットします。
type が FITPAGE 以外の場合のみ使用します。
指定されていない場合は、0 が指定されたものとします。
keepAspectRatio true 画像の縦横比を固定します。
false 画像の縦横比を固定しません。
指定されていない場合は、false が指定されたものとします。
opaque (*1) 数値 画像の不透明度を 1~100 で指定します。
*1 「status」が「ON」の場合に必須です。
第 1 章 SPA Web API リファレンス
369
▌その他の注意事項
• ログインしている必要があります。
• 特殊フォルダーに対する「透かし」の設定可否は、次のとおりです。
フォルダー 設定可否 備考
パブリックのルートフォルダー status は ON か OFF のみです。
ユーザールートフォルダー
ドメインルートフォルダー
ログインしているユーザーのホームフォルダー 常に継承扱いです。
マイフォルダー 常に継承扱いです。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -106 対応していない形式の画像ファイルが指定された場合に出力されます。画像が
jpg、png、bmp 以外の場合です。
400 -107 画像ファイルのサイズが制限値を超えている場合に出力されます。画像ファイル
のサイズが 30MB 以上の場合です。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
500 -5000 以下のいずれかの場合に出力されます。
第 1 章 SPA Web API リファレンス
370
HTTP ステータ
ス
エラーコー
ド
備考
• SPA Archive Server または、SPA WebService で何らかのエラーが発生した
場合
• Bridge サービス作成時に、指定した Bridge サービス名が、既存の Bridge
サービスの名称と重複した場合
画像の指定がないフォルダーに対して、更新情報を送った場合などに出力されま
す。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。たとえば、次のような場合です。
• フォルダーに設定できない status を指定した場合
• ユーザーホーム、マイフォルダーを指定した場合
• 設定値に誤りがある場合
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 「settings」キーの指定に誤りがあった場合に出力されます。
エラーが出力されるのは、次の場合です。
• background に true/false 以外を指定
• action に BOTH/VIEW/PRINT 以外を指定
• type に FITPAGE/TILE/CUSTOM 以外を指定
• keepAspectRatio に true/false 以外を指定
• 以下のキーに数値以外を指定
○ width
○ height
○ opaque
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
371
19 暗号化設定 暗号化設定に関する API は次のとおりです。
• Encryption Get(P.372)
• Encryption Update(P.376)
第 1 章 SPA Web API リファレンス
372
Encryption Get 指定したフォルダーの暗号化設定に関する情報を取得します。
URI
http://<hostname>:44230/spa/service/encryption/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
373
HTTP ステータ
ス
エラーコー
ド
備考
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
暗号化設定がある場合の出力例(JSON 形式)
{
"status": "ON",
"inheritFolderId": "-1",
"settings": {
"ownerPassword": "abcdefg",
"userPassword": "hijklmn",
"passwordEncoding": "UTF-8",
"type": "ACROBAT5",
"copy": true,
"print": "HIGH",
"modify": "ALL",
"access": true,
"ondemand": "SETTING"
}
}
暗号化設定がない場合の出力例(JSON 形式)
{
第 1 章 SPA Web API リファレンス
374
暗号化設定がない場合の出力例(JSON 形式)
"status": "OFF",
"inheritFolderId": "-1",
"settings": null
}
暗号化設定が親フォルダーの設定を継承する場合の出力例(JSON 形式)
{
"status": "INHERITED",
"inheritFolderId": "8",
"settings": {
"ownerPassword": "abcdefg",
"userPassword": "hijklmn",
"passwordEncoding": "UTF-8",
"type": "ACROBAT5",
"copy": true,
"print": "HIGH",
"modify": "ALL",
"access": true,
"ondemand": "SETTING"
}
}
■ データ内容
キー 値 備考
status INHERITED 親フォルダーの設定を継承します。
OFF 設定しません。
ON 設定します。
inheritFolderId ID status が INHERITED の場合の継承しているフォルダーID です。
settings 暗号化設定
status が OFF の場合は、null です。
status が INHERITED の場合は、継承しているフォルダーの暗号化設定です。
null の場合は、継承先のフォルダーにも暗号化設定されません。
第 1 章 SPA Web API リファレンス
375
キー 値 備考
ownerPassword 文字列 権限パスワード。
userPassword 文字列 文書を開くパスワード。
passwordEncoding 文字列 基本的に「UTF-8」で指定します。
type ACROBAT5 「暗号化互換形式」を「Acrobat 5.0 およびそれ以降」に設定します。
ACROBAT6 「暗号化互換形式」を「Acrobat 6.0 およびそれ以降」に設定します。
ACROBAT7 「暗号化互換形式」を「Acrobat 7.0 およびそれ以降」に設定します。
ACROBAT9 「暗号化互換形式」を「Acrobat 9.0 およびそれ以降」に設定します。
copy *1 true テキスト、画像、およびその他の内容のコピーを有効にします。
false テキスト、画像、およびその他の内容のコピーを無効にします。
print *2 NOT 「印刷を許可」を「許可しない」に設定します。
LOW 「印刷を許可」を「低解像度(150dpi)」に設定します。
HIGH 「印刷を許可」を「高解像度」に設定します。
modify *3 NOT 「変更を許可」を「許可しない」に設定します。
ANNOTATION 「変更を許可」を「注釈作成、フォームフィールドの入力と既存の署名フィー
ルドに署名」に設定します。
INPUT 「変更を許可」を「フォームフィールドの入力と既存の署名フィールドに署
名」に設定します。
ASSEMBLE 「変更を許可」を「ページの挿入、削除、回転」に設定します。
ALL 「変更を許可」を「ページの抽出を除くすべての操作」に設定します。
access *4 true スクリーンリーダーデバイスのテキストアクセスを有効にします。
false スクリーンリーダーデバイスのテキストアクセスを無効にします。
ondemand SETTING ダウンロード時に、文書を開くパスワードとして「userPassword」の指定を
使用します。
ONDEMAND ダウンロード時に、文書を開くパスワードを指定します。
• *1 ownerPassword がある場合のみ指定値を利用します。それ以外は常に true です。
• *2 ownerPassword がある場合のみ指定値を利用します。それ以外は常に HIGH です。
• *3 ownerPassword がある場合のみ指定値を利用します。それ以外は常に ALL です。
• *4 ownerPassword がある場合のみ指定値を利用します。それ以外は常に true です。
第 1 章 SPA Web API リファレンス
376
Encryption Update フォルダー内の PDF ファイルに適用するセキュリティ情報(パスワード、暗号化など)を、フォルダーに設
定します。
URI
http://<hostname>:44230/spa/service/encryption/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
暗号化設定を行う場合のオブジェクトの例(JSON 形式)
{
"status": "ON",
"settings": {
"ownerPassword": "abcdefg",
"userPassword": "hijklmn",
"passwordEncoding": "UTF-8",
"type": "ACROBAT5",
"copy": true,
"print": "HIGH",
"modify": "ALL",
"access": true,
"ondemand": "SETTING"
}
第 1 章 SPA Web API リファレンス
377
暗号化設定を行う場合のオブジェクトの例(JSON 形式)
}
暗号化設定を行わない場合のオブジェクトの例(JSON 形式)
{
"status": "OFF",
"settings": null
}
親フォルダーの暗号化設定を継承する場合のオブジェクトの例(JSON 形式)
{
"status": "INHERITED",
"settings": null
}
■ データ内容
キー 必須 値 備考
status INHERITED 親フォルダーの設定を継承します。
OFF 設定しません。
ON 設定します。
settings (*1) 暗号化設定
status が OFF の場合は、null です。
status が INHERITED の場合は、継承しているフォルダーの暗号化設定
です。null の場合は、継承先のフォルダーにも暗号化設定されません。
ownerPassword (*2) 文字列 権限パスワード。半角英数字および半角記号以外は利用できません。
userPassword と同一の文字列は、指定できません。
status が ON の場合、ownerPassword か userPassword のどちらか 1
つが必須です。
userPassword (*2) 文字列 文書を開くパスワード。半角英数字および半角記号以外は利用できませ
ん。ownerPassword と同一の文字列は、指定できません。
status が ON の場合、ownerPassword か userPassword のどちらか 1
つが必須です。
passwordEncoding 文字列 基本的に「UTF-8」で指定します。
第 1 章 SPA Web API リファレンス
378
キー 必須 値 備考
type ACROBAT5 「暗号化互換形式」を「Acrobat 5.0 およびそれ以降」に設定します。
ACROBAT6 「暗号化互換形式」を「Acrobat 6.0 およびそれ以降」に設定します。
ACROBAT7 「暗号化互換形式」を「Acrobat 7.0 およびそれ以降」に設定します。
ACROBAT9 「暗号化互換形式」を「Acrobat 9.0 およびそれ以降」に設定します。
copy(*3) true テキスト、画像、およびその他の内容のコピーを有効にします。
この値を true にしたときは、access の値も true にする必要がありま
す。
false テキスト、画像、およびその他の内容のコピーを無効にします。
print(*4) NOT 「印刷を許可」を「許可しない」に設定します。
LOW 「印刷を許可」を「低解像度(150dpi)」に設定します。
HIGH 「印刷を許可」を「高解像度」に設定します。
modify(*5) NOT 「変更を許可」を「許可しない」に設定します。
ANNOTATION 「変更を許可」を「注釈作成、フォームフィールドの入力と既存の署名
フィールドに署名」に設定します。
INPUT 「変更を許可」を「フォームフィールドの入力と既存の署名フィールド
に署名」に設定します。
ASSEMBLE 「変更を許可」を「ページの挿入、削除、回転」に設定します。
ALL 「変更を許可」を「ページの抽出を除くすべての操作」に設定します。
access(*6) true スクリーンリーダーデバイスのテキストアクセスを有効にします。
false スクリーンリーダーデバイスのテキストアクセスを無効にします。
ondemand SETTING ダウンロード時に、文書を開くパスワードとして「userPassword」の
指定を使用します。
更新時に null が指定された場合は「SETTING」が設定されます。
ONDEMAND ダウンロード時に、文書を開くパスワードを指定します。
*1 「status」が「ON」の場合に必須です。
*2 どちらか 1 つの指定が必須です。
*3 ownerPassword がある場合のみ指定値を利用します。それ以外は常に true です。
*4 ownerPassword がある場合のみ指定値を利用します。それ以外は常に HIGH です。
*5 ownerPassword がある場合のみ指定値を利用します。それ以外は常に ALL です。
第 1 章 SPA Web API リファレンス
379
*6 ownerPassword がある場合のみ指定値を利用します。それ以外は常に true です。
▌その他の注意事項
• ログインしている必要があります。
• 特殊フォルダーに対する「暗号化」の設定可否は、次のとおりです。
フォルダー 設定可否 備考
パブリックのルートフォルダー status は ON か OFF のみです。
ユーザールートフォルダー(/Users)
ドメインルートフォルダー(/Users/<ドメイン名>)
ログインしているユーザーのホームフォルダー 常に継承扱いです。
マイフォルダー 常に継承扱いです。
○ 凡例
「 」設定可
「 」設定不可
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
380
HTTP ステータ
ス
エラーコー
ド
備考
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。指定したフォルダーがユーザーホ
ーム、マイフォルダーの場合を含みます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
381
20 フォルダーへの文書管理ポリシー設定 フォルダーへの文書管理ポリシー設定に関する API は、次のとおりです。
• FolderPolicy Get(Ver. 2)(P.382)
• FolderPolicy Update(Ver. 3)(P.387)
第 1 章 SPA Web API リファレンス
382
FolderPolicy Get(Ver. 2) 指定したフォルダーの文書管理ポリシーの設定情報を取得します。
URI
http://<hostname>:44230/spa/service/folderpolicy_v2/<id>
• キー
キー 必須 値 備考
id 取得対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
383
HTTP ステータ
ス
エラーコー
ド
備考
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
フォルダーへの文書管理ポリシー設定がある場合の出力例(JSON 形式)
{
"status": "ON",
"inheritFolderId": "-1",
"settings": {
"retentionPeriod": 200,
"overwriteForbidden" : true,
"lock": true,
"deletionForbidden": true,
"timestamp": true,
"track": true,
"trackDeletionRecords": true,
"previewImageResolution": 450,
"fileStoreId": "10",
"previewCacheId": "20",
"searchIndexId": "5",
"maskId": "15",
"onDemandMask": "AUTO",
"reviewFlow": true,
第 1 章 SPA Web API リファレンス
384
フォルダーへの文書管理ポリシー設定がある場合の出力例(JSON 形式)
"reviewTemplateId": "25",
"versioning": "OFF",
"maxHistoryCount": 0
}
}
フォルダーへの文書管理ポリシー設定が親フォルダーの設定を継承する場合の出力例(JSON 形式)
{
"status": "INHERITED",
"inheritFolderId": "8",
"settings": {
"retentionPeriod": 200,
"overwriteForbidden" : true,
"lock": true,
"deletionForbidden": true,
"timestamp": true,
"track": true,
"trackDeletionRecords": true,
"previewImageResolution": 450,
"fileStoreId": "10",
"previewCacheId": "20",
"searchIndexId": "5",
"maskId": "15",
"onDemandMask": "AUTO",
"reviewFlow": true,
"reviewTemplateId": "25",
"versioning": "OFF",
"maxHistoryCount": 0
}
}
第 1 章 SPA Web API リファレンス
385
■ データ内容
キー 値 備考
status INHERITED 文書管理ポリシーの設定について、親フォルダーの設定を継承します。
ON 文書管理ポリシーを設定します。
inheritFolderId 文字列 継承しているフォルダーID です(status が「INHERITED」の場合のみ)。
settings 文書管理ポリシー設定
• status が「INHERITED」の場合
継承しているフォルダーの文書管理ポリシーの情報
• status が「ON」の場合
当該フォルダーに設定されている文書管理ポリシーの情報
retentionPeriod 数値 文書公開日からの保存日数です。
overwriteForbidden true 文書の上書きアーカイブを禁止します。
false 文書の上書きアーカイブを禁止しません。
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 文書の削除を禁止します。
false 文書の削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
previewImageResolution 数値 プレビュー画像の解像度(DPI)です。
fileStoreId 文字列 「アーカイブファイルの格納フォルダー」の ID です。実ファイルの保存先
となります。
「FolderPolicy Get」では、ルートフォルダーの設定が出力されます。
previewCacheId 文字列 「キャッシュ用画像の格納フォルダー」の ID です。プレビュー用画像キャ
ッシュの保存先となります。
「FolderPolicy Get」では、ルートフォルダーの設定が出力されます。
第 1 章 SPA Web API リファレンス
386
キー 値 備考
searchIndexId 文字列 「検索インデックス格納フォルダー」の ID です。検索インデックスの保存
先となります。
「FolderPolicy Get」では、ルートフォルダーの設定が出力されます。
maskId 文字列 マスク設定の ID です。
onDemandMask OFF マスクを適用しません。
AUTO アーカイブ時に自動で全ページにマスクを適用します。
MANUAL 任意のタイミングでマスクを適用します。
reviewFlow true レビューを自動的に起票します。
false レビューを自動的に起票しません。
reviewTemplateId 文字列 レビューテンプレートの定義 ID です。
versioning 文字列 バージョン管理の設定です。初期値は OFF です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount 数値 バージョン管理をしている場合に保存できる履歴の最大数です。
• versioning が FORWARD_ONLY または FULL で、履歴の最大数が 0 の
場合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となります。
第 1 章 SPA Web API リファレンス
387
FolderPolicy Update(Ver. 3) 指定した内容で、フォルダーの文書管理ポリシーの設定を変更します。
URI
http://<hostname>:44230/spa/service/folderpolicy_v3/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
フォルダーへ文書管理ポリシー設定を行う場合の本体の例(JSON 形式)
{
"status": "ON",
"settings": {
"retentionPeriod": 200,
"overwriteForbidden" : true,
"lock": true,
"deletionForbidden": true,
"timestamp": true,
"track": true,
"trackDeletionRecords": true,
"previewImageResolution": 450,
"fileStoreId": "10",
"previewCacheId": "20",
第 1 章 SPA Web API リファレンス
388
フォルダーへ文書管理ポリシー設定を行う場合の本体の例(JSON 形式)
"searchIndexId": "5",
"maskId": "15",
"onDemandMask": "AUTO",
"versioning": "FULL",
"maxHistoryCount": 50
},
"reapplyMask": true,
"addTimestamp": true
}
親フォルダーの文書管理ポリシー設定を継承する場合の本体の例(JSON 形式)
{
"status": "INHERITED",
"settings": null
}
■ データ内容
キー 必須 値 備考
status(*1) INHERITED 文書管理ポリシーの設定について、親フォルダーの設定を継承します。
指定されていない場合は、INHERITED が指定されたものとします。
ON 文書管理ポリシーを設定します。
settings (*2) 文書管理ポリシー設定
• status が「INHERITED」の場合
継承しているフォルダーの文書管理ポリシーの情報
• status が「ON」の場合
当該フォルダーに設定されている文書管理ポリシーの情報
retentionPeriod 数値 文書公開日からの保存日数です。
指定なしの場合は、「0」
指定省略時は、「0(指定なし)」となります。
overwriteForbidden true 文書の上書きアーカイブを禁止します。
第 1 章 SPA Web API リファレンス
389
キー 必須 値 備考
false 文書の上書きアーカイブを禁止しません。
指定省略時は、「false」となります。
lock true 文書をロックします。
false 文書をロックしません。
指定省略時は、「false」となります。
deletionForbidden true 文書の削除を禁止します。
false 文書の削除を禁止しません。
指定省略時は、「false」となります。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
指定省略時は、「false」となります。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
指定省略時は、「false」となります。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
指定省略時は、「false」となります。
previewImageResolution 数値 プレビュー画像の解像度(DPI)です。
「150」、「300」、「450」のいずれかです。
指定省略時は「150」となります。
fileStoreId (*3) 文字列 「アーカイブファイルの格納フォルダー」の ID です。実ファイ
ルの保存先となります。
「FolderPolicy Update」では、処理対象がルートフォルダー
で、かつ、SPA に文書が 1 つも存在しない場合にのみ変更でき
ます。
previewCacheId (*3) 文字列 「キャッシュ用画像の格納フォルダー」の ID です。プレビュー
用画像キャッシュの保存先となります。
「FolderPolicy Update」では、処理対象がルートフォルダー
で、かつ、SPA に文書が 1 つも存在しない場合にのみ変更でき
ます。
第 1 章 SPA Web API リファレンス
390
キー 必須 値 備考
searchIndexId (*3) 文字列 「検索インデックス格納フォルダー」の ID です。検索インデッ
クスの保存先となります。
「FolderPolicy Update」では、処理対象がルートフォルダー
で、かつ、SPA に文書が 1 つも存在しない場合にのみ変更でき
ます。
maskId (*4) 文字列 マスク設定の ID です。
onDemandMask が「OFF」の場合は、指定しても無視されま
す。
onDemandMask OFF マスクを適用しません。
AUTO アーカイブ時に自動で全ページにマスクを適用します。
MANUAL 任意のタイミングでマスクを適用します。
reviewFlow true レビューを自動的に起票します。
false レビューを自動的に起票しません。
指定省略時は、「false」となります。
reviewTemplateId (*5) 文字列 レビューテンプレートの定義 ID です。
reviewFlow が「false」の場合は、指定しても無視されます。
reapplyMask true onDemandMask が「AUTO」で、かつ、maskId を変更する場
合、アーカイブ済みの文書にもマスクを再適用します。
指定されていない場合は、true が指定されたものとします。
false onDemandMask が「AUTO」で、かつ、maskId を変更する場
合、アーカイブ済みの文書にはマスクを再適用しません。
addTimestamp true timestamp を「true」に変更する場合、アーカイブ済みの文書
にもタイムスタンプを付与します。
指定されていない場合は、true が指定されたものとします。
false timestamp を「true」に変更する場合、アーカイブ済みの文書
にはタイムスタンプを付与しません。
versioning 文字列 バージョン管理の設定です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
第 1 章 SPA Web API リファレンス
391
キー 必須 値 備考
• FULL
閲覧と復元を許可する
maxHistoryCount (*6) 数値 バージョン管理をしている場合に保存できる履歴の最大数で
す。
• versioning が FORWARD_ONLY または FULL で、履歴の
最大数が 1 以上の場合、その値を履歴数の上限とします。
• versioning が FORWARD_ONLY または FULL で、履歴の
最大数が 0 の場合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となりま
す。
*1 特殊なフォルダーについて
以下のフォルダーについては、文書管理ポリシーの設定が制限されます。
• 「/」(ルート)フォルダー
status「ON(設定する)」のみ設定可能です。
• ログインしているユーザーのホームフォルダー(/Users/<ユーザー名>)
設定できません。
• マイフォルダー
設定できません。
*2 「status」が「ON」の場合に必須です。
*3 ルートフォルダーへの設定時に必須です。
*4 「onDemandMask」が「OFF」以外の場合に必須です。
*5 「reviewFlow」が「true」の場合に必須です。
*6 「versioning」が「OFF」以外の場合に必須です。
▌その他の注意事項
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
392
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
404 -1111 対象のマスクが存在しない場合に出力されます。
404 -1180 保存先設定の更新や文書定義のインポートの際、対象の設定が存在しない場合
に出力されます。
400 -1190 ステータスが「利用可」ではない保存先が指定された場合に出力されます。
404 -1500 指定したレビューテンプレートが存在しない場合に出力されます。
400 -1800 配下に文書が存在する状態で、文書管理ポリシーの保存先を変更しようとした
場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。フォルダーがユーザーホーム、
マイフォルダーの場合も含みます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は
-5000 を返します。
第 1 章 SPA Web API リファレンス
393
21 データの保存先情報取得 データの保存先情報取得に関する API は次のとおりです。
• Storage Settings Get(P.394)
第 1 章 SPA Web API リファレンス
394
Storage Settings Get データの保存先の設定情報を取得します。
URI
http://<hostname>:44230/spa/service/settings/storage
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
395
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"fileSystemStorages": [
{
"name": "default",
"path": "c:/SVFPDFArchiver/data/fileStore",
"status": 1,
"entityVersion": 0,
"id": "0"
}
],
"searchIndexStorages": [
{
"name": "default",
"path": "c:/SVFPDFArchiver/data/index",
"status": 1,
"entityVersion": 0,
"id": "0"
}
],
"previewCacheStorages": [
{
"name": "default",
"path": "c:/SVFPDFArchiver/data/preview",
"status": 1,
"entityVersion": 0,
"previewCacheEnable": false,
第 1 章 SPA Web API リファレンス
396
出力例(JSON 形式)
"createPreviewCacheOnArchive": false,
"thumbnailCacheEnable": true,
"createThumbnailCacheOnArchive": true,
"id": "0"
}
]
}
■ データ内容
キー 値 説明
fileSystemStorages アーカイブファイルの格納フォルダーの情報
「保存先情報に関するキーについて(P.396)」を参照してください。
searchIndexStorages 検索インデックス格納フォルダーの情報
「保存先情報に関するキーについて(P.396)」を参照してください。
previewCacheStorages キャッシュ用画像の格納フォルダーの情報
「保存先情報に関するキーについて(P.396)」を参照してください。
保存先情報に関するキーについて
キー 値 説明
name 文字列 保存先の表示名です。
path 文字列 保存先のフォルダーパスです。
status 数値 保存先のステータスです。
• 0
サーバー再起動後に適用
• 1
利用可
• 2
利用不可
entityVersion 数値 設定のバージョンです。
id 文字列 保存先の ID です。
previewCacheEnable true 文書のプレビュー用画像のキャッシュを作成します。
第 1 章 SPA Web API リファレンス
397
キー 値 説明
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
false 文書のプレビュー用画像のキャッシュを作成しません。
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
createPreviewCacheOnArchive true 文書のアーカイブ時にプレビュー用画像のキャッシュを作成します。
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
false 文書のアーカイブ時にプレビュー用画像のキャッシュを作成しませ
ん。プレビュー実行時に作成されます。
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
thumbnailCacheEnable true 文書のサムネイル用画像のキャッシュを作成します。
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
false 文書のサムネイル用画像のキャッシュを作成しません。
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
createThumbnailCacheOnArchive true 文書のアーカイブ時にサムネイル用画像のキャッシュを作成します。
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
false 文書のアーカイブ時にサムネイル用画像のキャッシュを作成しませ
ん。プレビュー実行時に作成されます。
キャッシュ用画像の格納フォルダーの情報でのみ出力されます。
第 1 章 SPA Web API リファレンス
398
22 カスタムプロパティ操作 カスタムプロパティの操作に関する API は次のとおりです。
• Custom Properties List(Ver. 2)(P.399)
• Custom Properties Create(Ver. 2)(P.405)
• Custom Property Documents Set(P.413)
• Custom Properties Update(Ver. 2)(P.417)
• Custom Properties Delete(P.423)
第 1 章 SPA Web API リファレンス
399
Custom Properties List(Ver. 2) 存在するすべてのカスタムプロパティの構成情報のリストを返します。
URI
http://<hostname>:44230/spa/service/properties_v2
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
400
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"customProperties": [
{
"type": "string",
"id": "1",
"name": "column1",
"description": "desc",
"visible": true,
"edit": true,
"linkTo": true,
"displayNames": {
"ja": "文字列型",
"en": "string",
"zh_CN": "string"
},
"default": "def",
"length": 100
},
{
"type": "number",
"id": "2",
"name": "column2",
"description": "desc",
"visible": true,
第 1 章 SPA Web API リファレンス
401
出力例(JSON 形式)
"edit": true,
"linkTo": true,
"displayNames": {
"ja": "数値型",
"en": "number",
"zh_CN": "number"
},
"default": "0",
"numberType":1
},
{
"type": "date",
"id": "3",
"name": "column3",
"description": "desc",
"visible": true,
"edit": true,
"linkTo": true,
"displayNames": {
"ja": "日付型",
"en": "date",
"zh_CN": "date"
},
"default": "19700101090000",
"dateType": 1
},
{
"type": "date",
"id": "4",
"name": "column4",
"description": "desc",
"visible": true,
"edit": true,
第 1 章 SPA Web API リファレンス
402
出力例(JSON 形式)
"linkTo": true,
"displayNames": {
"ja": "日付型",
"en": "date",
"zh_CN": "date"
},
"default": "19700101",
"dateType": 3
},
{
"type": "boolean",
"id": "5",
"name": "column5",
"description": "desc",
"visible": true,
"edit": true,
"linkTo": true,
"displayNames": {
"ja": "Boolean 型",
"en": "boolean",
"zh_CN": "boolean"
},
"default": true
},
{
"type": "hyperLink",
"id": "6",
"name": "column6",
"description": "desc",
"visible": true,
"edit": true,
"linkTo": true,
"displayNames": {
"ja": "ハイパーリンク型",
第 1 章 SPA Web API リファレンス
403
出力例(JSON 形式)
"en": "hyperLink",
"zh_CN": "hyperLink"
},
"default": "http://www.wingarc.com/",
"length": 100
}
]
}
■ データ内容
キー 値 備考
customProperties カスタムプロパティのリスト
「カスタムプロパティに関するキーと値の説明(P.403)」を参照してください。
カスタムプロパティに関するキーと値の説明
キー 値 備考
type 文字列 カスタムプロパティのデータの型です。
値 説明
string 文字列型
number 数値型
date 日付型
boolean Boolean 型
hyperLink ハイパーリンク型
id 文字列 カスタムプロパティの ID です。
name 文字列 カスタムプロパティの定義名です。
description 文字列 カスタムプロパティの説明です。
visible true 表示対象です(デフォルト)。
false 表示対象ではありません。
edit true 編集可能です。
false 編集できません(デフォルト)。
第 1 章 SPA Web API リファレンス
404
キー 値 備考
linkTo true リンク作成時にカスタムプロパティの値をコピーして値を引き継ぎます。
false リンク作成時にカスタムプロパティの値を引き継ぎません(デフォルト)。
displayNames ロケールごとの表示名です。キーに以下のロケール、値に文字列が出力されます。
• ja
日本語
• en
英語
• zh_CN
中国語簡体字
default 備考を参照 既定値として指定する値です。
length 数値 最大文字数です。
dateType 備考を参照 日付のフォーマットです。
値 説明
1 yyyyMMddHHmmss(年月日時分秒)
2 yyyyMMddHHmm(年月日時分)
3 yyyyMMdd(年月日)
4 MMddHHmm(月日時分)
5 MMdd(月日)
6 HHmmss(時分秒)
7 HHmm(時分)
numberType 備考を参照 数値型の種類です。
値 説明
1 整数のみの数値
2 小数を含んだ数値
第 1 章 SPA Web API リファレンス
405
Custom Properties Create(Ver. 2) カスタムプロパティを作成します。
URI
http://<hostname>:44230/spa/service/properties_v2
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"customProperty": {
"type": "string",
"name": "column1",
"description": "",
"visible": true,
"edit": false,
"linkTo": false,
"displayNames": {
"ja": "文字列型",
"en": "string",
"zh_CN": "string"
},
"default": null,
"length": 256
}
}
第 1 章 SPA Web API リファレンス
406
■ データ内容
キー 値 備考
customProperty カスタムプロパティ
「カスタムプロパティに関するキーと値の説明(P.406)」を参照してください。
カスタムプロパティに関するキーと値の説明
キー 必須 値 備考
type 文字列 カスタムプロパティのデータの型です。
値 説明
string 文字列型
number 数値型
date 日付型
boolean Boolean 型
hyperLink ハイパーリンク型
name 文字列 カスタムプロパティの定義名です。31 文字までの半角英数字が指定できます。
description 文字列 カスタムプロパティの説明です。
visible true 表示対象です。
指定されていない場合は、true が指定されたものとします。
false 表示対象ではありません。
edit true 編集可能です。
false 編集できません。
指定されていない場合は、false が指定されたものとします。
linkTo true リンク作成時にカスタムプロパティの値をコピーして値を引き継ぎます。
false リンク作成時にカスタムプロパティの値を引き継ぎません。
指定されていない場合は、false が指定されたものとします。
displayNames ロケールごとの表示名
キーに以下のロケール、値に文字列を指定します。値には空文字、または null
は指定できません。
• ja
日本語
第 1 章 SPA Web API リファレンス
407
キー 必須 値 備考
• en
英語
• zh_CN
中国語簡体字
default 備考を
参照
既定値として指定する値です。
• 文字列型の場合は、任意の文字列
• 数値型の場合は、数値の種類を指定します。種類により指定可能な範囲は
異なります。
数値の種類 指定可能な範囲
整数のみの
数値
-9,223,372,036,854,775,808~
9,223,372,036,854,775,807
小数を含んだ
数値
-9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999
(整数部 19 桁、小数部 20 桁)
小数点には「.(ピリオド)」のみ使用できます。
• 日付型の場合は、日付のフォーマットに従った値
日付のフォーマットが 1(yyyyMMddHHmmss)または、2
(yyyyMMddHHmm)の場合は UTC 時間です。
• Boolean 型の場合は、true または false
• ハイパーリンク型の場合は、任意の文字列
length 数値 最大文字数です。
1~2,048 の範囲で指定します。
文字列型、ハイパーリンク型の場合のみ必要です。
指定されていない場合は、256 が指定されたものとします。
dateType (*1) 備考を
参照
日付のフォーマットです。
値 説明
1 yyyyMMddHHmmss(年月日時分秒)
2 yyyyMMddHHmm(年月日時分)
3 yyyyMMdd(年月日)
4 MMddHHmm(月日時分)
第 1 章 SPA Web API リファレンス
408
キー 必須 値 備考
5 MMdd(月日)
6 HHmmss(時分秒)
7 HHmm(時分)
numberType (*2) 備考を
参照
数値型の種類です。
値 説明
1 整数のみの数値
2 小数を含んだ数値
*1 日付型の場合に必須です。
*2 数値型の場合に必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
409
HTTP ステータ
ス
エラーコー
ド
備考
400 -450 カスタムプロパティの追加時に、同名のプロパティが存在している場合に出力さ
れます。
400 -453 カスタムプロパティの作成時、プロパティの定義名に次のような誤りがある場合
に出力されます。
• 定義名が指定されていない
• 定義名に半角英数字以外の文字が含まれている
• 定義名が 31 文字を超えている
400 -454 上限値(1,000)以上のカスタムプロパティを登録しようとした場合に出力されます。
400 -455 カスタムプロパティの追加または更新の際、表示名が指定されていない(null や空文字が指定されている)場合や、表示名に使用できない文字が含まれている場合に出力されます。
400 -459 既定値に正しくない値が指定された場合に発生します。
たとえば、次のような場合です。
• 文字列型の既定値の長さが最大文字数(2,048 文字)を超えている
• 日付型の形式に合わない値が指定されている
• 数値型の既定値に種類と合わない値が指定されている
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、次のような場合です。
• データ型が指定されていない
• データ型の指定が正しくない
• 日付のフォーマット指定が正しくない
• 日付のフォーマットが指定されていない
• 数値型の種類が指定されていない
第 1 章 SPA Web API リファレンス
410
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"customProperty": {
"type": "string",
"id": "1",
"name": "column1",
"description": "",
"visible": true,
"edit": false,
"linkTo": false,
"displayNames": {
"ja": "文字列型",
"en": "string",
"zh_CN": "string"
},
"default": null,
"length": 256
}
}
■ データ内容
キー 値 備考
customProperty カスタムプロパティ
「カスタムプロパティに関するキーと値の説明(P.411)」を参照してください。
第 1 章 SPA Web API リファレンス
411
カスタムプロパティに関するキーと値の説明
キー 値 備考
type 文字列 カスタムプロパティのデータの型です。
値 説明
string 文字列型
number 数値型
date 日付型
boolean Boolean 型
hyperLink ハイパーリンク型
id 文字列 カスタムプロパティの ID です。
name 文字列 カスタムプロパティの定義名です。
description 文字列 カスタムプロパティの説明です。
visible true 表示対象です(デフォルト)。
false 表示対象ではありません。
edit true 編集可能です。
false 編集できません(デフォルト)。
linkTo true リンク作成時にカスタムプロパティの値をコピーして値を引き継ぎます。
false リンク作成時にカスタムプロパティの値を引き継ぎません(デフォルト)。
displayNames ロケールごとの表示名
• ja
日本語
• en
英語
• zh_CN
中国語簡体字
default 備考を参照 既定値として指定する値です。
length 数値 最大文字数です。
dateType 備考を参照 日付のフォーマットです。
第 1 章 SPA Web API リファレンス
412
キー 値 備考
値 説明
1 yyyyMMddHHmmss(年月日時分秒)
2 yyyyMMddHHmm(年月日時分)
3 yyyyMMdd(年月日)
4 MMddHHmm(月日時分)
5 MMdd(月日)
6 HHmmss(時分秒)
7 HHmm(時分)
numberType 備考を参照 数値型の種類です。
値 説明
1 整数のみの数値
2 小数を含んだ数値
第 1 章 SPA Web API リファレンス
413
Custom Property Documents Set 指定した文書に対して、カスタムプロパティのすべての値を更新します。
URI
http://<hostname>:44230/spa/service/properties/documents
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
詳細は、「カスタムプロパティ一括更新用ファイルの書式(P.425)」を参照してください。
オブジェクトの例(JSON 形式)
{
"customProperties": {
"1": "text",
"2": "1",
"3": "19700101090000",
"4": "19700101",
"5": "true",
"6": "http://www.wingarc.com/"
},
"ids": [
"1",
"2",
"3"
],
"condition": {
"usePropertyEntityVersions": true,
第 1 章 SPA Web API リファレンス
414
オブジェクトの例(JSON 形式)
"propertyEntityVersions": [
1,
2,
1
]
}
}
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-Error-Property-Id ID カスタムプロパティ値の更新に失敗した場合、最初に失敗した
カスタムプロパティの ID を付加します。
X-Spa-Error-Property-Code エラーコード カスタムプロパティ値の更新に失敗した場合、失敗の内容につ
いてのエラーコードを付加します。
X-Spa-Error-Property-Message エラーメッセージ • カスタムプロパティ値の更新に失敗した場合、失敗の内容
についてのエラーメッセージを付加します。
• URL エンコードされます。
第 1 章 SPA Web API リファレンス
415
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。すべてのカスタムプロパティについて値の更新に成功し
た場合出力されます。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在しな
かった場合に出力されます。
400 -457 編集できない設定のカスタムプロパティの値を更新しようとした場合に出力され
ます。
400 -458 プロパティ値の更新時にバージョンを更新条件としたが、指定したバージョンと
一致しなかった場合に出力されます。
400 -459 既定値に正しくない値が指定された場合に発生します。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
400 -1111 対象のマスクが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20462 更新するプロパティバージョンの個数が文書 ID の個数と一致しない場合に出力
されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、対象となる文
書の ID が指定されていない場合や、ID が空(ids:[])の場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
416
▌出力例
出力例(JSON 形式)
{
"propertyVersions": [
{
"id": "1",
"propertyEntityVersion": 2
},
{
"id": "2",
"propertyEntityVersion": 3
},
{
"id": "3",
"propertyEntityVersion": 2
}
]
}
■ データ内容
キー 値 備考
propertyVersions プロパティのエンティティバージョンのリスト
id 文字列 文書の ID です。
propertyEntityVersion 数値 プロパティのエンティティバージョンです。
第 1 章 SPA Web API リファレンス
417
Custom Properties Update(Ver. 2) 指定されたカスタムプロパティの属性を変更します。
URI
http://<hostname>:44230/spa/service/properties_v2/<id>
• キー
キー 必須 値 備考
id 対象のカスタムプロパティの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトには、変更したい属性のキーと値を記述します。
オブジェクトの例(JSON 形式)
{
"customProperty": {
"description": "",
"visible": true,
"edit": false,
"linkTo": false,
"displayNames": {
"ja": "文字列型",
"en": "string",
"zh_CN": "string"
},
"default": null,
第 1 章 SPA Web API リファレンス
418
オブジェクトの例(JSON 形式)
"length": 256
}
}
■ データ内容
キー 値 備考
customProperty カスタムプロパティ
「カスタムプロパティに関するキーと値の説明(P.418)」を参照してください。
カスタムプロパティに関するキーと値の説明
キー 必須 値 備考
description 文字列 カスタムプロパティの説明です。
visible true 表示対象です。
指定されていない場合は、true が指定されたものとします。
false 表示対象ではありません。
edit true 編集可能です。
false 編集できません。
指定されていない場合は、false が指定されたものとします。
linkTo true リンク作成時にカスタムプロパティの値をコピーして値を引き継ぎます。
false リンク作成時にカスタムプロパティの値を引き継ぎません。
指定されていない場合は、false が指定されたものとします。
displayNames ロケールごとの表示名
キーに以下のロケール、値に文字列を指定します。値には空文字、または null
は指定できません。
• ja
日本語
• en
英語
• zh_CN
中国語簡体字
第 1 章 SPA Web API リファレンス
419
キー 必須 値 備考
default 備考を
参照
既定値として指定する値です。
• 文字列型の場合は、任意の文字列
• 数値型の場合は、数値の種類を指定します。種類により指定可能な範囲は
異なります。
数値の種類 指定可能な範囲
整数のみの
数値
-9,223,372,036,854,775,808~
9,223,372,036,854,775,807
小数を含ん
だ数値
-9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999
(整数部 19 桁、小数部 20 桁)
小数点には「.(ピリオド)」のみ使用できます。
• 日付型の場合は、日付のフォーマットに従った値
日付のフォーマットが 1(yyyyMMddHHmmss)または、2
(yyyyMMddHHmm)の場合は UTC 時間です。
• Boolean 型の場合は、true または false
• ハイパーリンク型の場合は、任意の文字列
length 数値 最大文字数です。
1~2,048 の範囲で指定します。
指定されていない場合は、256 が指定されたものとします。
numberType (*1) 備考を
参照
数値型の種類です。
値 説明
1 整数のみの数値
2 小数を含んだ数値
*1 数値型の場合に必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
420
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在しな
かった場合に出力されます。
404 -455 カスタムプロパティの追加または更新の際、表示名が指定されていない(null や
空文字が指定されている)場合や、表示名に使用できない文字が含まれている場
合に出力されます。
400 -459 既定値に正しくない値が指定された場合に発生します。
たとえば、次のような場合です。
• 文字列型の既定値の長さが最大文字数(2,048 文字)を超えている
• 日付型の形式に合わない値が指定されている
• 数値型の既定値に種類と合わない値が指定されている
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
200 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
421
▌出力例
出力例(JSON 形式)
{
"customProperty": {
"type": "string",
"id": "1",
"name": "column1",
"description": "",
"visible": true,
"edit": false,
"linkTo": false,
"displayNames": {
"ja": "文字列型",
"en": "string",
"zh_CN": "string"
},
"default": null,
"length": 256
}
}
■ データ内容
キー 値 備考
customProperty カスタムプロパティ
「カスタムプロパティに関するキーと値の説明(P.421)」を参照してください。
カスタムプロパティに関するキーと値の説明
キー 値 備考
type 文字列 カスタムプロパティのデータの型です。
値 説明
string 文字列型
number 数値型
第 1 章 SPA Web API リファレンス
422
キー 値 備考
date 日付型
boolean Boolean 型
hyperLink ハイパーリンク型
id 文字列 カスタムプロパティの ID です。
name 文字列 カスタムプロパティの定義名です。
description 文字列 カスタムプロパティの説明です。
visible true 表示対象です(デフォルト)。
false 表示対象ではありません。
edit true 編集可能です。
false 編集できません(デフォルト)。
linkTo true リンク作成時にカスタムプロパティの値をコピーして値を引き継ぎます。
false リンク作成時にカスタムプロパティの値を引き継ぎません(デフォルト)。
displayNames ロケールごとの表示名です。キーに以下のロケール、値に文字列が出力されます。
• ja
日本語
• en
英語
• zh_CN
中国語簡体字
default 備考を参照 既定値として指定する値です。
length 数値 最大文字数です。
numberType 備考を参照 数値型の種類です。
値 説明
1 整数のみの数値
2 小数を含んだ数値
第 1 章 SPA Web API リファレンス
423
Custom Properties Delete 指定した文書定義を削除します。また、その文書定義に属する SVF 検索フィールドもすべて削除されます。
URI
http://<hostname>:44230/spa/service/properties/<id>
• キー
キー 必須 値 備考
id 対象のカスタムプロパティの ID
HTTP メソッド
DELETE
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在しな
かった場合に出力されます。
第 1 章 SPA Web API リファレンス
424
HTTP ステータ
ス
エラーコー
ド
備考
500 -463 カスタムプロパティ削除の際、振り分け処理定義で利用しているカスタムプロパ
ティを削除しようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
425
カスタムプロパティ一括更新用ファイルの書式 複数のカスタムプロパティの値を一括して更新する場合は、そのすべてのカスタムプロパティの名称と更新
する値を記述したファイルが必要です。
• ファイルが必要な API(P.425)
• ファイル書式(P.425)
• 更新条件について(P.427)
▌ファイルが必要な API
カスタムプロパティ一括更新用ファイルが必要な API は、次のとおりです。API はすべて multipart/form-
data として送信するものです。この更新用ファイルを含めるボディ部分の Content-Type ヘッダーを、送信
するファイルの形式(application/json)に合わせてセットしてください。
• Archives Add(Ver. 2)(P.448)
文書を指定したフォルダーにアーカイブします。
• Links Create (P.140)
リンクの作成とカスタムプロパティ値の更新を行います。
• Custom Property Documents Set (P.413)
指定した文書に対して、カスタムプロパティのすべての値を更新します。
▌ファイル書式
一括更新用ファイルには、更新対象であるカスタムプロパティの ID と値のペアを記述します。
キー 必須 値 備考
customProperties 値を登録するカスタムプロパティの ID と値のペア
ID をキーとして記述します。
ids (*1) 文字列 更新する文書 ID をリストで指定します。
condition 更新時の条件
Custom Property Documents Set でのみ有効です。
指定されていない場合は、条件指定なしとなります。
第 1 章 SPA Web API リファレンス
426
*1 「Custom Property Documents Set」でのみ必須です。
• ファイルに記述する ID と値の組み合わせは、定義されているカスタムプロパティの個数とは関係な
く、更新対象のみを記述します。たとえば、カスタムプロパティが 10 個あっても更新する項目が 1 つ
(だけ)なら、更新対象の 1 つのみを記述します。
• 一括更新用ファイルに複数のペアを記述して、一度に複数のカスタムプロパティ値を更新できます
が、そのうち 1 つでも更新に失敗した場合は、すべてのプロパティについて値が更新されません。
• 誤った形式のファイルを送信した場合、「HTTP/1.1 400 Bad Request」 が返ります。
• 値が日付型の「年月日時分秒(yyyyMMddHHmmss)」と「年月日時分(yyyyMMddHHmm)」の場合は、
UTC 時間で指定します。
• 数値の種類により指定可能な範囲は異なります。
数値の種類 指定可能な範囲
整数のみの数値 -9,223,372,036,854,775,808~9,223,372,036,854,775,807
小数を含んだ数値 -9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)
小数点には「.(ピリオド)」のみ使用できます。
• 値として「値なし」を指定する方法は次のとおりです。
カスタムプロパティのデータの型 説明
文字列型 空文字を指定します。
数値型 空文字を指定します。
日付型 空文字を指定します。
Boolean 型 「値なし」は指定できません、必ず true か false を指定してください。
ハイパーリンク型 空文字を指定します。
■ ファイル例
JSON 形式の例
{
"customProperties": {
"1": "text",
"2": "1",
第 1 章 SPA Web API リファレンス
427
JSON 形式の例
"3": "19700101090000",
"4": "19700101",
"5": "true",
"6": "http://www.wingarc.com/"
}
}
Custom Property Documents Set の場合、更新する文書の ID を ids で指定します。
JSON 形式の例(Custom Property Documents Set の場合)
{
"customProperties": {
"1": "text",
"2": "1",
"3": "19700101090000",
"4": "19700101",
"5": "true",
"6": "http://www.wingarc.com/"
},
"ids": [
"1",
"2",
"3"
]
}
▌更新条件について
Custom Property Documents Set の場合のみ、更新条件を指定できます。
キー 必須 値 備考
usePropertyEntityVersions true プロパティのエンティティバージョンを指定します。
false プロパティのバージョンを指定しません。
指定されていない場合は、false が指定されたものとします。
第 1 章 SPA Web API リファレンス
428
キー 必須 値 備考
propertyEntityVersions (*1) 数値の
リスト
更新するプロパティのエンティティバージョンのリストです。文
書 ID と同じ数が必要です。各文書について指定されたエンティ
ティバージョンと一致した場合のみ値を更新します。
*1 「usePropertyEntityVersions」が「true」の場合に必須です。
JSON 形式の例
{
"customProperties": {
"1": "text",
"2": "1",
"3": "19700101090000",
"4": "19700101",
"5": "true",
"6": "http://www.wingarc.com/"
},
"ids": [
"1",
"2",
"3"
],
"condition": {
"usePropertyEntityVersions": true,
"propertyEntityVersions": [
1,
2,
1
]
}
}
第 1 章 SPA Web API リファレンス
430
Masks List マスク(マスクのパターン)の一覧を取得します。
URI
http://<hostname>:44230/spa/service/masks
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
第 1 章 SPA Web API リファレンス
431
HTTP ステータス エラーコード 備考
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"masks":[
{
"id":"1",
"name":"mask01",
"fillType":0,
"withRects":true,
"rects":[
{
"width":136,
"height":77,
"x":58,
"y":76
},
{
"x":462,
"y":620,
"width":290,
"height":225
}
]
},
{
"id":"2",
"name":"mask02",
"fillType":1,
"withRects":true,
第 1 章 SPA Web API リファレンス
432
出力例(JSON 形式)
"rects":[
{
"x":107,
"y":159,
"width":260,
"height":26
}
]
}
]
}
■ データ内容
キー 値 説明
masks マスクの一覧
id 文字列 マスクの ID です。
name 文字列 マスクの名称です。
fillType 数値 マスクの表示形式です。
• 0
黒塗り
• 1
白抜き
• 2
アスタリスク
withRects true 矩形の情報(rects)を保有します。
false 矩形の情報(rects)を保有しません。
rects 矩形の位置、大きさの情報
x 数値 矩形左側のマスク内での横位置です。左上原点として 96dpi のピクセル単位で表します。
y 数値 矩形上側のマスク内での縦位置です。左上原点として 96dpi のピクセル単位で表します。
width 数値 矩形の幅です。96dpi のピクセル単位で表します。
height 数値 矩形の高さです。96dpi のピクセル単位で表します。
第 1 章 SPA Web API リファレンス
433
24 レビューテンプレート情報取得 レビューテンプレート情報取得に関する API は次のとおりです。
• Review Templates List(Ver. 2)(P.434)
第 1 章 SPA Web API リファレンス
434
Review Templates List(Ver. 2) すべてのレビューテンプレートの情報を取得します。
URI
http://<hostname>:44230/spa/service/reviews/templates_v2
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
435
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"reviewTemplateList": [
{
"id": "10",
"name": "template1",
"description": "desc1",
"completeNumber": 2,
"userExitPath": "path1",
"userExitParameter": [
"param1",
"param2"
],
"reviewers": [
{
"id": "1",
"name": "admin",
"domainId": "0",
"domainName": "local",
"fullname": "Admin",
"comment": "comment"
},
{
"id": "2",
"name": "user1",
第 1 章 SPA Web API リファレンス
436
出力例(JSON 形式)
"domainId": "1",
"domainName": "ad1",
"fullname": "User1",
"comment": "comment1"
}
],
"notifications": {
"item": [
{
"description": "通知の説明",
"events": [
24,
25,
26
],
"mails": {
"enable": true,
"users": [
{
"id": "1",
"name": "admin1",
"fullName": "admin1",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
},
{
"id": "2",
"name": "user1",
"fullName": "user1",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
第 1 章 SPA Web API リファレンス
437
出力例(JSON 形式)
}
],
"groups": [
{
"id": "1",
"name": "AdminGroup",
"fullName": "AdminGroup",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
},
{
"id": "2",
"name": "UserGroup",
"fullName": "UserGroup",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
}
],
"directs": [
],
"noticeReviewer": false,
"noticeReviewCreator": false
},
"programs": {
"enable": true,
"path": "/user/local/bin/movels",
"parameters": [
"${folder_path}",
第 1 章 SPA Web API リファレンス
438
出力例(JSON 形式)
"${document_id}",
"${document_name}",
"任意文字列"
]
}
}
]
}
},
{
"id": "11",
"name": "template2",
"description": "desc2",
"completeNumber": 1,
"userExitPath": "path2",
"userExitParameter": [
"param1",
"param2"
],
"reviewers": [
{
"id": "1",
"name": "admin",
"domainId": "0",
"domainName": "local",
"fullname": "Admin",
"comment": "comment"
}
],
"notifications": {
"item": [
{
"description": "通知の説明",
第 1 章 SPA Web API リファレンス
439
出力例(JSON 形式)
"events": [
24,
25,
26
],
"mails": {
"enable": true,
"users": [
{
"id": "1",
"name": "admin1",
"fullName": "admin1",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
},
{
"id": "2",
"name": "user1",
"fullName": "user1",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
}
],
"groups": [
{
"id": "1",
"name": "AdminGroup",
"fullName": "AdminGroup",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
第 1 章 SPA Web API リファレンス
440
出力例(JSON 形式)
},
{
"id": "2",
"name": "UserGroup",
"fullName": "UserGroup",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
}
],
"directs": [
],
"noticeReviewer": false,
"noticeReviewCreator": false
},
"programs": {
"enable": true,
"path": "/user/local/bin/movels",
"parameters": [
"${folder_path}",
"${document_id}",
"${document_name}",
"任意文字列"
]
}
}
]
}
}
]
第 1 章 SPA Web API リファレンス
441
出力例(JSON 形式)
}
通知設定がない場合の出力例(JSON 形式)
{
"reviewTemplateList": [
{
"id": "10",
"name": "template1",
"description": "desc1",
"completeNumber": 2,
"userExitPath": "path1",
"userExitParameter": [
"param1",
"param2"
],
"reviewers": [
{
"id": "1",
"name": "admin",
"domainId": "0",
"domainName": "local",
"fullname": "Admin",
"comment": "comment"
},
{
"id": "2",
"name": "user1",
"domainId": "1",
"domainName": "ad1",
"fullname": "User1",
"comment": "comment1"
}
],
第 1 章 SPA Web API リファレンス
442
通知設定がない場合の出力例(JSON 形式)
"notifications": null
},
{
"id": "11",
"name": "template2",
"description": "desc2",
"completeNumber": 1,
"userExitPath": "path2",
"userExitParameter": [
"param1",
"param2"
],
"reviewers": [
{
"id": "1",
"name": "admin",
"domainId": "0",
"domainName": "local",
"fullname": "Admin",
"comment": "comment"
}
],
"notifications": null
}
]
}
■ データ内容
キー 値 説明
reviewTemplateList レビューテンプレートの一覧
id 文字列 レビューテンプレートの ID です。
name 文字列 レビューテンプレート名です。
第 1 章 SPA Web API リファレンス
443
キー 値 説明
description 文字列 レビューテンプレートの説明です。
completeNumber 数値 レビューを完了とするためのレビュアーの人数です。
「-1」の場合は、すべてのレビュアーを表します。
userExitPath 文字列 レビュー完了時に起動するプログラムのパスです。
操作権限「文書定義の設定」を持たないユーザーで実行した場合は空文字で出
力されます。
userExitParameter レビュー完了時に起動するプログラムのパラメーターの一覧
操作権限「文書定義の設定」を持たないユーザーで実行した場合は空の要素で
出力されます。
reviewers レビュアーの一覧
id 文字列 レビュアーのユーザーID です。
name 文字列 レビュアーのユーザー名です。
domainId 文字列 レビュアーが所属するドメインの ID です。
domainName 文字列 レビュアーが所属するドメイン名です。
fullname 文字列 レビュアーのユーザーのフルネームです。
comment 文字列 レビュアーのユーザーの説明です。
notifications 通知の設定
item 通知の設定の 1 件に該当
複数の通知の設定を行う場合は、この要素が複数出力されます。
description 通知の説明
evnets 通知のイベ
ント ID
通知の対象となるイベントの ID
本 API で出力される通知のイベント ID については、「通知のイベント
ID(P.444)」を参照してください。
mails 通知機能によるメール送信
enable true 通知機能によるメール送信が有効です。
false 通知機能によるメール送信が無効です。
users 宛先に設定するユーザー
id 文字列 ユーザーに割り当てられる一意の番号です。
name 文字列 ユーザー名です。
第 1 章 SPA Web API リファレンス
444
キー 値 説明
fullName 文字列 ユーザーのフルネームです。
domainId 文字列 ユーザーが所属するドメインの ID です。
domainName 文字列 ユーザーの所属するドメイン名です。
mailAddress 文字列 ユーザーのメールアドレスです。
groups 宛先に設定するグループ
id 文字列 グループに割り当てられる一意の番号です。
name 文字列 グループ名です。
fullName 文字列 グループのフルネームです。
domainId 文字列 グループが所属するドメインの ID です。
domainName 文字列 グループの所属するドメイン名です。
mailAddress 文字列 グループのメールアドレスです。
directs 宛先のメールアドレスを直接設定
noticeReviewer true レビュアーへの通知が有効です。
false レビュアーへの通知が無効です。
noticeReviewCreator true レビュー起票者への通知が有効です。
false レビュー起票者への通知が無効です。
programs 通知機能によるプログラム実行
enable true 通知機能によるプログラム実行が有効です。
false 通知機能によるプログラム実行が無効です。
path 文字列 通知機能の設定により起動する外部プログラムのフルパスです。
parameters 文字列 通知機能の設定により起動する外部プログラムのパラメーターです。
本 API で出力される外部プログラムのパラメーターについては、「外部プログ
ラムのパラメーター(P.445)」を参照してください。
通知のイベント ID
本 API で出力される通知のイベント ID は次のとおりです。外部プログラムのパラメーターについては、「外
部プログラムのパラメーター(P.445)」を参照してください。
第 1 章 SPA Web API リファレンス
445
イベント ID イベント名 外部プログラム起動で利用可能なパラメーター
24 レビューの起票 パス、文書名、ファイル ID、URL リンク、レビューステータス、実行結果、
ユーザーID、ドメイン名、ユーザー名
25 レビューの確認 パス、文書名、ファイル ID、URL リンク、レビューステータス、実行結果、
ユーザーID、ドメイン名、ユーザー名
26 レビューの差し戻し パス、文書名、ファイル ID、URL リンク、レビューステータス、実行結果、
ユーザーID、ドメイン名、ユーザー名
27 レビューの完了 パス、文書名、ファイル ID、URL リンク、レビューステータス、実行結果
28 レビューの作成 パス、文書名、ファイル ID、URL リンク、レビューステータス、実行結果、
ユーザーID、ドメイン名、ユーザー名
29 レビューの削除 パス、文書名、ファイル ID、URL リンク、レビューステータス、実行結果、
ユーザーID、ドメイン名、ユーザー名
30 レビューの取り消し パス、文書名、ファイル ID、URL リンク、レビューステータス、実行結果、
ユーザーID、ドメイン名、ユーザー名
外部プログラムのパラメーター
本 API で出力される外部プログラムのパラメーターに指定する変数は次のとおりです。
パラメーター 変数 備考
イベント ID ${event_id}
実行結果 ${event_status}
パス ${folder_path} 文書が保存されているパスです。
ファイル ID ${document_id}
文書名 ${document_name}
URL リンク ${direct_url}
ユーザーID ${user_id}
ドメイン名 ${domain_name}
ユーザー名 ${user_name}
レビューステータス ${review_status} 以下のいずれかです。
• 0
起票前
• 1
第 1 章 SPA Web API リファレンス
448
Archives Add(Ver. 2) 文書を指定したフォルダーにアーカイブします。
URI
http://<hostname>:44230/spa/service/archives_v2
HTTP メソッド
POST
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必
須
値 備考
folderId 処理対象フォルダーの
ID • folderId か path のどちらかを必ず指定する必要が
あります。
path 処理対象フォルダーの
絶対パス文字列 • folderId か path のどちらかを必ず指定する必要が
あります。
name アーカイブ時のファイ
ル名 • 指定がない場合は「file」キーから取得します。た
だし、マルチバイト文字を含む場合は文字化けが発
生するため、「name」キーで指定することをおす
すめします。
overwrite アーカイブ先に同一フ
ァイル名のファイルが
存在した場合の動作
• true
指定されたファイ
ルで上書きする
• true の場合、カスタムプロパティ作成の Web API
(Custom Properties Create)の「edit」パラメー
ター(カスタムプロパティの編集可否)の指定が
「false」(編集不可)であっても、
「customProperties」で指定されたカスタムプロ
パティ一括更新用ファイルの内容に従って更新され
ます。
第 1 章 SPA Web API リファレンス
449
キー 必
須
値 備考
• false(デフォル
ト)
エラーとする
overwriteLinkSource 上書きする際に、ペー
ジリンクのリンク元文
書であっても上書きを
許可するかどうか
• true
上書きを許可する
• false(デフォル
ト)
上書きを許可しな
い
• overwrite が true の場合にのみ有効です。true 以
外の場合、この値は無視されます。
• ページリンクの元文書に対して上書きアーカイブし
た場合は、作成されていたページリンクはすべて削
除されます。
• false のときに、ページリンクの元文書に対してア
ーカイブを行うとエラーになります。overwrite が
true で、かつ overwriteLinkSource も true の場合
は上書きアーカイブされます。
overwriteUpdate 上書きする際の文書の
更新方法
• true(デフォル
ト)
「文書の更新」と
して扱う
• false
新しい文書として
アーカイブする
• true の場合、アーカイブされている文書と同一の
文書 ID でアーカイブ(上書き)し、PDF ファイル
の作成日、アーカイブ時間が更新されます。それ以
外のプロパティは保持されます。
• false の場合、新しい文書 ID が付与されます。
force 解析エラーやパスワードの不一致、画像の解像度や色深度が基準に満たないなどの場合でも、強制的にアーカイブするかどうか
• true
強制的にアーカイ
ブする
• false(デフォル
ト)
• アーカイブ対象が PDF ファイルの場合のみ有効で
す。PDF ファイル以外の場合には、この値は無視
されます。
第 1 章 SPA Web API リファレンス
450
キー 必
須
値 備考
アーカイブしない
strict 厳密な解析を行うかどうか
• true
厳密な解析を行う
• false(デフォル
ト)
厳密な解析を行わ
ない
• アーカイブ対象が PDF ファイルの場合のみ有効で
す。PDF ファイル以外の場合には、この値は無視
されます。
• true の場合、PDF ファイルの本文テキストが抽出
できるかどうかをチェックします。本文テキストの
抽出に失敗した場合、アーカイブに失敗します。ア
ーカイブエラーとなる PDF ファイルでも、force オ
プションに true を指定することで強制的にアーカ
イブできます。この場合、PDF ファイルは「解析
完了[本文検索一部可]」というステータスでアーカ
イブされますが、解析できなかったページについて
は、全文検索ができません。
• false の場合、PDF ファイルの本文テキストが抽出
できるかどうかをチェックしません。本文テキスト
の抽出チェックを行わないため、解析できない
PDF ファイルでもアーカイブされます。解析でき
ない PDF ファイルは、「解析完了[本文検索一部
可]」というステータスでアーカイブされます。こ
の場合、解析できなかったページについては、全文
検索ができません。
mkdirs path で指定された親フ
ォルダーがすべて存在
しない場合の動作
• true(デフォル
ト)
親フォルダーを含
む必要なフォルダ
ーをすべて作成す
る
• false
エラーとする
• path を指定した場合のみ有効です。
password 暗号化された PDF ファ
イルのパスワード • 複数指定はできません。
第 1 章 SPA Web API リファレンス
451
キー 必
須
値 備考
• UTF-8 でエンコーディングします。
• password を指定しない場合は、パスワードなしと
して処理します。
• アーカイブ対象が PDF ファイルの場合のみ有効で
す。PDF ファイル以外の場合には、この値は無視
されます。
file アーカイブする文書 • 複数指定はできません。アーカイブ処理は、単一フ
ァイルのみが対象です。
• ファイル名にマルチバイト文字を含む場合は、文字
化けが発生する場合があるため、「name」パラメ
ーターの利用をおすすめします。
customProperties カスタムプロパティ一
括更新用ファイル • ファイルの書式については、「カスタムプロパティ
一括更新用ファイルの書式(P.425)」を参照してく
ださい。
• カスタムプロパティ値の更新が 1 つでも失敗した
場合、アーカイブもエラーになります。
• 新たに文書をアーカイブする場合、カスタムプロパ
ティ作成の Web API(Custom Properties Create)
の「edit」パラメーター(カスタムプロパティの編
集可否)の指定が「false」(編集不可)であって
も、「customProperties」で指定されたカスタムプ
ロパティ一括更新用ファイルの内容に従って更新さ
れます。
docTypeId 文書定義管理のレコー
ド ID(文書定義管理
ID)
• アーカイブする文書に付ける文書定義のレコード
ID(文書定義管理 ID)を指定します。
• 文書定義管理 ID の指定がない場合、「定義なし」と
してアーカイブされます。
documentEntityVersion 文書のエンティティバ
ージョン • 上書き更新で「文書の更新」を行う場合
(overwrite=true かつ、overwriteUpdate=true の
場合)に有効です。
第 1 章 SPA Web API リファレンス
452
キー 必
須
値 備考
• 文書のエンティティバージョンが異なる場合はエラ
ーになります。
propertyEntityVersion プロパティのエンティ
ティバージョン • 上書き更新で「文書の更新」を行う場合
(overwrite=true かつ、overwriteUpdate=true の
場合)に有効です。
• プロパティのエンティティバージョンが異なる場合
はエラーになります。
verifyImageDpi 画像の解像度(dpi)の
しきい値 • アーカイブ対象が PDF ファイルの場合のみ有効で
す。PDF ファイル以外の場合には、この値は無視
されます。
• このパラメーターに値が指定されている場合、画像
の解像度(dpi)をチェックし、指定された値を満
たさない場合はエラーになります。
• ページ内に複数の画像がある場合、PDF ファイル
内部で先に記述されている画像が検証対象となり、
それ以外の画像は検証されません。
• PDF ファイルに複数の画像がある場合、このパラ
メーターに指定された値を満たさない画像が検出さ
れた時点で画像の検証は終了し、エラーを返しま
す。
verifyImageBpp 画像の色深度(bpp)の
しきい値 • アーカイブ対象が PDF ファイルの場合のみ有効で
す。PDF ファイル以外の場合には、この値は無視
されます。
• このパラメーターに値が指定されている場合、画像
の色深度(bpp)をチェックし、指定された値を満
たさない場合はエラーになります。
• ページ内に複数の画像がある場合、PDF ファイル
内部で先に記述されている画像が検証対象となり、
それ以外の画像は検証されません。
• PDF ファイルに複数の画像がある場合、このパラ
メーターに指定された値を満たさない画像が検出さ
第 1 章 SPA Web API リファレンス
453
キー 必
須
値 備考
れた時点で画像の検証は終了し、エラーを返しま
す。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-Error-Property-Id ID カスタムプロパティ値の更新に失敗した場合、最初に失敗したカスタムプロパティの ID を付加します。
X-Spa-Error-Property-Code エラーコード カスタムプロパティ値の更新に失敗した場合、失敗の内容についてのエラーコードを付加します。
X-Spa-Error-Property-Message エラーメッセージ • カスタムプロパティ値の更新に失敗した場合、失敗の内容
についてのエラーメッセージを付加します。
• URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問題が
ある場合に出力されます。アーカイブ対象が PDF ファイルの場合のみ出力されま
す。
第 1 章 SPA Web API リファレンス
454
HTTP ステータ
ス
エラーコー
ド
備考
400 -104 SVF で出力された PDF ファイルではない場合に出力されます。SPA Limited のみ
で発生するエラーです。
400 -105 暗号化された PDF ファイルを復号できない場合に出力されます。アーカイブ対象
が PDF ファイルの場合のみ出力されます。
400 -108 画像の解像度(dpi)が、verifyImageDpi パラメーターに指定された値を満たさ
ない場合に出力されます。アーカイブ対象が PDF ファイルの場合のみ出力されま
す。
400 -109 画像の色深度(bpp)が、verifyImageBpp パラメーターに指定された値を満た
さない場合に出力されます。アーカイブ対象が PDF ファイルの場合のみ出力され
ます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
400 -304 フォルダーの階層が管理画面の[フォルダーの最大階層数]に設定された値を超
える場合に出力されます。
400 -308 パス名に誤りがあります。次のいずれかの場合に出力されます。
• フルパスが「/」から始まっていない
• 個々のフォルダー名に誤りがある(個々のフォルダー名が-307 エラーの条
件に該当する)
• フルパスが 250 バイトを超えている
400 -309 フォルダー数が、管理画面の[最大フォルダー数]に設定された値を超える場合
に出力されます。
400 -400 同名のファイルがすでに存在している場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -403 ファイル名に誤りがあります。次のいずれかの場合に出力されます。
• ファイル名が半角ドットから始まっている
• ファイル名に¥ / : * ? " < > |が使用されている
• ファイル名が 250 バイトを超えている
400 -408 ページリンクの元ファイルに上書きアーカイブをしようとした場合に出力されま
す。
第 1 章 SPA Web API リファレンス
455
HTTP ステータ
ス
エラーコー
ド
備考
400 -409 アーカイブされた文書を更新する際、対象の文書を開いたときのバージョンとサ
ーバーに保管されている文書のバージョンが一致しなかった場合に出力されま
す。
400 -458 プロパティ値の更新時にバージョンを更新条件としたが、指定したバージョンと
一致しなかった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
403 -9997 アーカイブ先に次のフォルダーが指定された場合など、指定した値に誤りがある
場合に出力されます。
• 「/」フォルダー
• ユーザールートフォルダー
• ドメインルートフォルダー(またはユーザールートフォルダー配下のドメイ
ンルートフォルダーと同階層のフォルダー)
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20804 アーカイブ、リンク作成、ページリンク作成において、カスタムプロパティ値の
更新に失敗した場合に出力されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Id」の値に最初に失敗したカ
スタムプロパティの ID が付加されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Code」の値に、エラーコー
ドが付加されます。
• レスポンスヘッダーの「X-Spa-Error-Property-Message」の値に、エラー
メッセージが付加されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
456
▌出力例
出力例(JSON 形式)
{
"id": "10",
"pageCount": 5,
"propertyEntityVersion": 1,
"documentEntityVersion": 1
}
■ データ内容
キー 値 備考
id 文字列 アーカイブした文書の ID です。
pageCount 数値 アーカイブした文書のページ数です。
propertyEntityVersion 数値 プロパティのエンティティバージョンです。
documentEntityVersion 数値 文書のエンティティバージョンです。
第 1 章 SPA Web API リファレンス
457
26 文書定義 文書定義に関する API は、次のとおりです。
• DocType Lookup(P.458)
• DocType List(Ver. 2)(P.461)
• DocType Get(Ver. 2)(P.465)
• DocType Get(Ver. 3)(P.471)
• DocType Create(Ver. 2)(P.477)
• DocType Create (Ver. 3)(P.484)
• DocType Update(Ver. 3)(P.491)
• DocType Update(Ver. 4) (P.499)
• DocType Delete(P.507)
第 1 章 SPA Web API リファレンス
458
DocType Lookup 文書定義 ID から文書定義管理 ID(文書定義に自動で割り振られる固有の ID)を取得します。
URI
http://<hostname>:44230/spa/service/doctype/lookup
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"lookupTableList": [
{
"name": "Document1"
},
{
"name": "Document2"
},
...
]
}
■ データ内容
キー 必須 値 説明
lookupTableList 文書定義 ID のリスト
第 1 章 SPA Web API リファレンス
459
キー 必須 値 説明
name 文字列 文書定義管理 ID(文書定義に自動で割り振られる固有の ID)を取得する文書定
義 ID です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
460
▌出力例
出力例(JSON 形式)
{
"lookupTableList": [
{
"name": "Document1",
"id": "10"
},
{
"name": "Document2",
"id": null
},
...
]
}
■ データ内容
キー 値 説明
lookupTableList 文書定義 ID のリスト
name 文字列 文書定義 ID です。
id 文字列 文書定義 ID に対応する文書定義管理 ID(文書定義に自動で割り振られる固有の ID)
です。
文書定義が存在しない場合は null が出力されます。
第 1 章 SPA Web API リファレンス
461
DocType List(Ver. 2) 文書定義の一覧を取得します。
URI
http://<hostname>:44230/spa/service/doctype_v2/list
HTTP メソッド
GET
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
462
▌出力例
出力例(JSON 形式)
{
"docTypeList" : [
{
"id" : "3",
"dispId" : "Title001",
"name" : "DocumentType_001",
"version" : 1,
"settings" : {
"retentionPeriod" : 200,
"overwriteForbidden" : true,
"lock" : true,
"deletionForbidden" : true,
"timestamp" : true,
"track" : true,
"trackDeletionRecords" : true,
"previewImageResolution" : 150,
"fileStoreId" : "2",
"previewCacheId" : "4",
"searchIndexId" : "6",
"versioning": "OFF",
"maxHistoryCount": 0
}
},
{
"id" : "4",
"dispId" : "文書定義 2",
"name" : "DocumentType_002",
"version" : 1,
"settings" : {
"retentionPeriod" : 200,
"overwriteForbidden" : true,
第 1 章 SPA Web API リファレンス
463
出力例(JSON 形式)
"lock" : true,
"deletionForbidden" : true,
"timestamp" : true,
"track" : true,
"trackDeletionRecords" : true,
"previewImageResolution" : 150,
"fileStoreId" : "2",
"previewCacheId" : "4",
"searchIndexId" : "6",
"versioning": "OFF",
"maxHistoryCount": 0
}
}
]
}
■ データ内容
キー 値 説明
id 文字
列
文書定義に自動で割り振られる固有の ID(文書定義管理 ID)です。
dispId 文字
列
文書定義 ID です。
name 文字
列
文書定義 ID の表示名です。
version 数値 文書定義に自動で設定される値です。
settings 文書管理ポリシー
retentionPeriod 数値 保存期間(日数)です。
0 は「指定なし」を意味します。
overwriteForbidden true 上書きアーカイブを禁止します。
false 上書きアーカイブを禁止しません。
第 1 章 SPA Web API リファレンス
464
キー 値 説明
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 削除を禁止します。
false 削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
previewImageResolution 数値 プレビュー画像の解像度(dpi)です。
150、300、450 のいずれかの値です。初期値は 150 です。
fileStoreId 文字
列
ファイル格納フォルダーの ID です。
previewCacheId 文字
列
プレビュー用画像キャッシュ格納フォルダーの ID です。
searchIndexId 文字
列
検索インデックス格納フォルダーの ID です。
versioning 文字
列
バージョン管理の設定です。初期値は OFF です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount 数値 バージョン管理をしている場合に保存できる履歴の最大数です。
• versioning が FORWARD_ONLY または FULL で、履歴の最大数が 0 の場
合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となります。
第 1 章 SPA Web API リファレンス
465
DocType Get(Ver. 2) 指定した文書定義を取得します。
URI
http://<hostname>:44230/spa/service/doctype_v2/<id>
• キー
キー 必須 値 備考
id 対象とする文書定義管理 ID
HTTP メソッド
GET
▌パラメーター
キー 必
須
値 備
考
field 指定された文書定義管理 ID を持つ文書定義に属している SVF 検索フィールドの情報を含めるかどうか
• true
情報を含める
• false(デフォルト)
情報を含めない
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
466
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -1003 対象の文書定義が存在しなかった場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id" : "102",
"dispId" : "Title102",
"name" : "DocumentType_102",
"version" : 1,
"settings" : {
"retentionPeriod" : 100,
"overwriteForbidden" : false,
第 1 章 SPA Web API リファレンス
467
出力例(JSON 形式)
"lock" : false,
"deletionForbidden" : false,
"timestamp" : false,
"track" : false,
"trackDeletionRecords" : false,
"previewImageResolution" : 150,
"fileStoreId" : "1",
"previewCacheId" : "1",
"searchIndexId" : "1",
"versioning": "OFF",
"maxHistoryCount": 0
},
"searchFields" : [
{
"id" : "3",
"docTypeId" : "102",
"name" : "filed001",
"formName" : "",
"fieldType" : "TEXT",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 001",
"searchable" : true
},
{
"id" : "5",
"docTypeId" : "102",
"name" : "filed002",
"formName" : "Form2",
"fieldType" : "NUMERIC",
"dateType" : "NONE",
第 1 章 SPA Web API リファレンス
468
出力例(JSON 形式)
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 002",
"searchable" : false
}
]
}
■ データ内容
キー 値 説明
id 文字列 文書定義に自動で割り振られる固有の ID(文書定義管理 ID)で
す。
dispId 文字列 文書定義 ID です。
name 文字列 文書定義 ID の表示名です。
version 数値 文書定義に自動で設定される値です。
settings 文書管理ポリシー
retentionPeriod 数値 保存期間(日数)です。
0 は「指定なし」を意味します。
overwriteForbidden true 上書きアーカイブを禁止します。
false 上書きアーカイブを禁止しません。
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 削除を禁止します。
false 削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
第 1 章 SPA Web API リファレンス
469
キー 値 説明
false 文書の削除記録を残しません。
previewImageResolution 数値 プレビュー画像の解像度(dpi)です。
150、300、450 のいずれかの値です。初期値は 150 です。
fileStoreId 文字列 ファイル格納フォルダーの ID です。
previewCacheId 文字列 プレビュー用画像キャッシュ格納フォルダーの ID です。
searchIndexId 文字列 検索インデックス格納フォルダーの ID です。
searchFields SVF 検索フィールド
field パラメーターが「true」でない場合、および、SVF 検索フィ
ールドが存在しない場合は、searchFields は空の配列となりま
す。
id 文字列 SVF 検索フィールドに割り振られた固有の ID です。
docTypeId 文字列 文書定義管理 ID です。
name 文字列 SVF 検索フィールド名です。
formName 文字列 様式名です。
fieldType TEXT SVF 検索フィールドのデータの型が「文字列型」です。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式「年月日時分」です。
yyyyMMdd 日時の出力の形式「年月日」です。
MMddHHmm 日時の出力の形式「月日時分」です。
MMdd 日時の出力の形式「月日」です。
HHmmss 日時の出力の形式「時分秒」です。
HHmm 日時の出力の形式「時分」です。
timezone NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定「タイムゾーンなし」のみです。
WithTimeZone タイムゾーン設定「タイムゾーンあり」のみです。
第 1 章 SPA Web API リファレンス
470
キー 値 説明
Both タイムゾーン設定「タイムゾーンあり」と「タイムゾーンなし」
の混在です。
repeatField true 繰り返しフィールドです。
false 繰り返しフィールドではありません。
loader true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName 文字列 検索名です。
searchable true 検索対象です。
false 検索対象ではありません。
versioning 文字列 バージョン管理の設定です。初期値は OFF です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount 数値 バージョン管理をしている場合に保存できる履歴の最大数です。
• versioning が FORWARD_ONLY または FULL で、履歴の最大
数が 0 の場合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となります。
第 1 章 SPA Web API リファレンス
471
DocType Get(Ver. 3) 指定した文書定義を取得します。本 Web API は、Ver. 10.1.0.3 以降で利用できます。
URI
http://<hostname>:44230/spa/service/doctype_v3/<id>
• キー
キー 必須 値 備考
id 対象とする文書定義管理 ID
HTTP メソッド
GET
▌パラメーター
キー 必
須
値 備
考
field 指定された文書定義管理 ID を持つ文書定義に属している SVF 検索フィールドの情報を含めるか
どうか
• true
情報を含める
• false(デフォルト)
情報を含めない
▌その他の注意事項 • HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても
JSON 形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
472
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
404 -1003 対象の文書定義が存在しなかった場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id" : "102",
"dispId" : "Title102",
"name" : "DocumentType_102",
"version" : 1,
"settings" : {
"retentionPeriod" : 100,
"overwriteForbidden" : false,
"lock" : false,
"deletionForbidden" : false,
"timestamp" : false,
第 1 章 SPA Web API リファレンス
473
出力例(JSON 形式)
"track" : false,
"trackDeletionRecords" : false,
"previewImageResolution" : 150,
"fileStoreId" : "1",
"previewCacheId" : "1",
"searchIndexId" : "1",
"versioning": "OFF",
"maxHistoryCount": 0
},
"searchFields" : [
{
"id" : "3",
"order" : "1",
"docTypeId" : "102",
"name" : "filed001",
"formName" : "",
"fieldType" : "TEXT",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 001",
"searchable" : true
},
{
"id" : "5",
"order" : "2",
"docTypeId" : "102",
"name" : "filed002",
"formName" : "Form2",
"fieldType" : "NUMERIC",
"dateType" : "NONE",
"timezone" : "NONE",
第 1 章 SPA Web API リファレンス
474
出力例(JSON 形式)
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 002",
"searchable" : false
}
]
}
■ データ内容
キー 値 説明
id 文字列 文書定義に自動で割り振られる固有の ID(文書定義管理 ID)で
す。
dispId 文字列 文書定義 ID です。
name 文字列 文書定義 ID の表示名です。
version 数値 文書定義に自動で設定される値です。
settings 文書管理ポリシー
retentionPeriod 数値 保存期間(日数)です。
0 は「指定なし」を意味します。
overwriteForbidden true 上書きアーカイブを禁止します。
false 上書きアーカイブを禁止しません。
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 削除を禁止します。
false 削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
第 1 章 SPA Web API リファレンス
475
キー 値 説明
previewImageResolution 数値 プレビュー画像の解像度(dpi)です。
150、300、450 のいずれかの値です。初期値は 150 です。
fileStoreId 文字列 ファイル格納フォルダーの ID です。
previewCacheId 文字列 プレビュー用画像キャッシュ格納フォルダーの ID です。
searchIndexId 文字列 検索インデックス格納フォルダーの ID です。
searchFields SVF 検索フィールド
field パラメーターが「true」でない場合、および、SVF 検索フィ
ールドが存在しない場合は、searchFields は空の配列となりま
す。
id 文字列 SVF 検索フィールドに割り振られた固有の ID です。
order NUMERIC SVF 検索フィールドのデータを CSV ファイルで出力する場合の並
び順です。
docTypeId 文字列 文書定義管理 ID です。
name 文字列 SVF 検索フィールド名です。
formName 文字列 様式名です。
fieldType TEXT SVF 検索フィールドのデータの型が「文字列型」です。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式「年月日時分」です。
yyyyMMdd 日時の出力の形式「年月日」です。
MMddHHmm 日時の出力の形式「月日時分」です。
MMdd 日時の出力の形式「月日」です。
HHmmss 日時の出力の形式「時分秒」です。
HHmm 日時の出力の形式「時分」です。
timezone NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定「タイムゾーンなし」のみです。
WithTimeZone タイムゾーン設定「タイムゾーンあり」のみです。
第 1 章 SPA Web API リファレンス
476
キー 値 説明
Both タイムゾーン設定「タイムゾーンあり」と「タイムゾーンなし」
の混在です。
repeatField true 繰り返しフィールドです。
false 繰り返しフィールドではありません。
loader true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName 文字列 検索名です。
searchable true 検索対象です。
false 検索対象ではありません。
versioning 文字列 バージョン管理の設定です。初期値は OFF です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount 数値 バージョン管理をしている場合に保存できる履歴の最大数です。
• versioning が FORWARD_ONLY または FULL で、履歴の最大数が 0 の場合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となります。
第 1 章 SPA Web API リファレンス
477
DocType Create(Ver. 2) 指定した文書定義を作成します。
URI
http://<hostname>:44230/spa/service/doctype_v2
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"id" : "0",
"dispId" : "文書定義 111",
"name" : "docType111",
"version" : 0,
"settings" : {
"retentionPeriod" : 100,
"overwriteForbidden" : false,
"lock" : false,
"deletionForbidden" : false,
"timestamp" : false,
"track" : false,
"trackDeletionRecords" : false,
"previewImageResolution" : 150,
"fileStoreId" : "2",
"previewCacheId" : "2",
"searchIndexId" : "2",
第 1 章 SPA Web API リファレンス
478
本体の例(JSON 形式)
"versioning": "OFF",
"maxHistoryCount": 0
},
"searchFields" : [
{
"id" : "0",
"docTypeId" : "0",
"name" : "filed001",
"formName" : "",
"fieldType" : "TEXT",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 001",
"searchable" : true
},
{
"id" : "0",
"docTypeId" : "0",
"name" : "filed002",
"formName" : "Form2",
"fieldType" : "NUMERIC",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 002",
"searchable" : false
}
]
}
第 1 章 SPA Web API リファレンス
479
■ データ内容
キー 必須 値 説明
id 文字列 文書定義に自動で割り振られる固有の ID(文書定義管
理 ID)です。
文書定義の作成時には何らかの数値を指定する必要が
あります。
dispId 文字列 文書定義 ID です。
name 文字列 文書定義 ID の表示名です。
version 数値 文書定義に自動で設定される値です。
文書定義の作成時には何らかの数値を指定する必要が
あります。
settings 文書管理ポリシー
retentionPeriod 数値 保存期間(日数)です。
0 は「指定なし」を意味します。
overwriteForbidden true 上書きアーカイブを禁止します。
false 上書きアーカイブを禁止しません。
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 削除を禁止します。
false 削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
previewImageResolution 数値 プレビュー画像の解像度(dpi)です。
150、300、450 のいずれかの値です。初期値は 150
です。
fileStoreId 文字列 ファイル格納フォルダーの ID です。
第 1 章 SPA Web API リファレンス
480
キー 必須 値 説明
previewCacheId 文字列 プレビュー用画像キャッシュ格納フォルダーの ID で
す。
searchIndexId 文字列 検索インデックス格納フォルダーの ID です。
searchFields SVF 検索フィールド
文書定義の作成時には、SVF 検索フィールドを作成し
ない場合でも、searchFields は空の配列として定義し
ておく必要があります。
id (*1) 文字列 SVF 検索フィールドに割り振られた固有の ID です。
文書定義の作成時には何らかの数値を指定する必要が
あります。
docTypeId (*1) 文字列 文書定義管理 ID です。
文書定義の作成時には何らかの数値を指定する必要が
あります。
name (*1) 文字列 SVF 検索フィールド名です。
formName (*1) 文字列 様式名です。
fieldType (*1) TEXT SVF 検索フィールドのデータの型が「文字列型」で
す。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType (*1) NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式「年月日時分」です。
yyyyMMdd 日時の出力の形式「年月日」です。
MMddHHmm 日時の出力の形式「月日時分」です。
MMdd 日時の出力の形式「月日」です。
HHmmss 日時の出力の形式「時分秒」です。
HHmm 日時の出力の形式「時分」です。
timezone (*1) NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定「タイムゾーンなし」のみです。
WithTimeZone タイムゾーン設定「タイムゾーンあり」のみです。
第 1 章 SPA Web API リファレンス
481
キー 必須 値 説明
Both タイムゾーン設定「タイムゾーンあり」と「タイムゾ
ーンなし」の混在です。
repeatField (*1) true 繰り返しフィールドです。
false 繰り返しフィールドではありません。
loader (*1) true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName (*1) 文字列 検索名です。
searchable (*1) true 検索対象です。
false 検索対象ではありません。
versioning 文字列 バージョン管理の設定です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount (*2) 数値 バージョン管理をしている場合に保存できる履歴の最大数です。
• versioning が FORWARD_ONLY または FULL
で、履歴の最大数が 1 以上の場合、その値を履
歴数の上限とします。
• versioning が FORWARD_ONLY または FULL
で、履歴の最大数が 0 の場合、履歴数を制限し
ません。
• versioning が OFF の場合は履歴の最大数は 0 と
なります。
*1 SVF 検索フィールドを作成する場合に必須です。
*2 「versioning」が「OFF」以外の場合に必須です。
第 1 章 SPA Web API リファレンス
482
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -1004 文書定義の作成時、作成しようとしている文書定義と同じ文書定義 ID の文書定
義が存在している場合に出力されます。
400 -1005 指定された文書定義 ID が 256 バイトを超えている場合に出力されます。
400 -1006 指定された文書定義 ID の表示名が 2048 バイトを超える場合に出力されます。
400 -1007 「アーカイブファイルの格納フォルダー」の ID に数値以外の値が指定された場
合に出力されます。
400 -1008 「キャッシュ用画像の格納フォルダー」の ID に数値以外の値が指定された場合
に出力されます。
400 -1009 「検索インデックス格納フォルダー」の ID に数値以外の値が指定された場合に
出力されます。
400 -1062 指定された SVF 検索フィールド名が 128 バイトを超える場合に出力されます。
400 -1063 指定された SVF 検索フィールドの様式名が、4,096 バイトを超える場合に出力さ
れます。
第 1 章 SPA Web API リファレンス
483
HTTP ステータ
ス
エラーコー
ド
備考
400 -1064 指定された SVF 検索フィールドの検索名が、256 バイトを超える場合に出力され
ます。
400 -1065 SVF 検索フィールドの登録/更新において、SVF 検索フィールドのデータの型、日
付のフォーマット、タイムゾーンの組み合わせに矛盾がある場合に出力されま
す。
404 -1180 保存先設定の更新や文書定義のインポートの際、対象の設定が存在しない場合に
出力されます。
400 -1190 ステータスが「利用可」ではない保存先が指定された場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
400 -20808 指定した値が許容範囲外の場合に出力されます。次のような場合に発生します。
• プレビュー画像の解像度に 150、300、450 以外が指定された場合
• 保存期間に 0 より小さい値が指定された場合
• 履歴の最大数に 0 より小さい値が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
• 正常に作成された場合は、「DocType Get(指定した文書定義の取得)」と同様の形式の情報を付けて返
します。
第 1 章 SPA Web API リファレンス
484
DocType Create(Ver. 3) 指定した文書定義を作成します。本 Web API は、Ver. 10.1.0.3 以降で利用できます。
URI
http://<hostname>:44230/spa/service/doctype_v3
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"id" : "0",
"dispId" : "文書定義 111",
"name" : "docType111",
"version" : 0,
"settings" : {
"retentionPeriod" : 100,
"overwriteForbidden" : false,
"lock" : false,
"deletionForbidden" : false,
"timestamp" : false,
"track" : false,
"trackDeletionRecords" : false,
"previewImageResolution" : 150,
"fileStoreId" : "2",
"previewCacheId" : "2",
"searchIndexId" : "2",
"versioning": "OFF",
第 1 章 SPA Web API リファレンス
485
本体の例(JSON 形式)
"maxHistoryCount": 0
},
"searchFields" : [
{
"id" : "0",
"order" : "1",
"docTypeId" : "0",
"name" : "filed001",
"formName" : "",
"fieldType" : "TEXT",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 001",
"searchable" : true
},
{
"id" : "0",
"order" : "2",
"docTypeId" : "0",
"name" : "filed002",
"formName" : "Form2",
"fieldType" : "NUMERIC",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "検索名 002",
"searchable" : false
}
]
}
第 1 章 SPA Web API リファレンス
486
■ データ内容
キー 必須 値 説明
id 文字列 文書定義に自動で割り振られる固有の ID(文書定義管理
ID)です。
文書定義の作成時には何らかの数値を指定する必要があ
ります。
dispId 文字列 文書定義 ID です。
name 文字列 文書定義 ID の表示名です。
version 数値 文書定義に自動で設定される値です。
文書定義の作成時には何らかの数値を指定する必要があ
ります。
settings 文書管理ポリシー
retentionPeriod 数値 保存期間(日数)です。
0 は「指定なし」を意味します。
overwriteForbidden true 上書きアーカイブを禁止します。
false 上書きアーカイブを禁止しません。
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 削除を禁止します。
false 削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
previewImageResolution 数値 プレビュー画像の解像度(dpi)です。
150、300、450 のいずれかの値です。初期値は 150 で
す。
fileStoreId 文字列 ファイル格納フォルダーの ID です。
第 1 章 SPA Web API リファレンス
487
キー 必須 値 説明
previewCacheId 文字列 プレビュー用画像キャッシュ格納フォルダーの ID で
す。
searchIndexId 文字列 検索インデックス格納フォルダーの ID です。
searchFields SVF 検索フィールド
文書定義の作成時には、SVF 検索フィールドを作成しな
い場合でも、searchFields は空の配列として定義してお
く必要があります。
id
(*1)
文字列 SVF 検索フィールドに割り振られた固有の ID です。
文書定義の作成時には何らかの数値を指定する必要があ
ります。
order NUMERIC SVF 検索フィールドのデータを CSV ファイルで出力す
る場合の並び順です。
docTypeId
(*1)
文字列 文書定義管理 ID です。
文書定義の作成時には何らかの数値を指定する必要があ
ります。
name
(*1)
文字列 SVF 検索フィールド名です。
formName
(*1)
文字列 様式名です。
fieldType
(*1)
TEXT SVF 検索フィールドのデータの型が「文字列型」です。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType
(*1)
NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式「年月日時分」です。
yyyyMMdd 日時の出力の形式「年月日」です。
MMddHHmm 日時の出力の形式「月日時分」です。
MMdd 日時の出力の形式「月日」です。
HHmmss 日時の出力の形式「時分秒」です。
HHmm 日時の出力の形式「時分」です。
第 1 章 SPA Web API リファレンス
488
キー 必須 値 説明
timezone
(*1)
NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定「タイムゾーンなし」のみです。
WithTimeZone タイムゾーン設定「タイムゾーンあり」のみです。
Both タイムゾーン設定「タイムゾーンあり」と「タイムゾー
ンなし」の混在です。
repeatField
(*1)
true 繰り返しフィールドです。
false 繰り返しフィールドではありません。
loader
(*1)
true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName
(*1)
文字列 検索名です。
searchable
(*1)
true 検索対象です。
false 検索対象ではありません。
versioning 文字列 バージョン管理の設定です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount
(*2)
数値 バージョン管理をしている場合に保存できる履歴の最大
数です。
• versioning が FORWARD_ONLY または FULL で、履歴の最大数が 1 以上の場合、その値を履歴数の上限とします。
• versioning が FORWARD_ONLY または FULL で、履歴の最大数が 0 の場合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となります。
*1 SVF 検索フィールドを作成する場合に必須です。
*2 「versioning」が「OFF」以外の場合に必須です。
第 1 章 SPA Web API リファレンス
489
▌その他の注意事項 • HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても
JSON 形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -1004 文書定義の作成時、作成しようとしている文書定義と同じ文書定義 ID の文
書定義が存在している場合に出力されます。
400 -1005 指定された文書定義 ID が 256 バイトを超えている場合に出力されます。
400 -1006 指定された文書定義 ID の表示名が 2048 バイトを超える場合に出力されま
す。
400 -1007 「アーカイブファイルの格納フォルダー」の ID に数値以外の値が指定され
た場合に出力されます。
400 -1008 「キャッシュ用画像の格納フォルダー」の ID に数値以外の値が指定された
場合に出力されます。
400 -1009 「検索インデックス格納フォルダー」の ID に数値以外の値が指定された場
合に出力されます。
400 -1062 指定された SVF 検索フィールド名が 128 バイトを超える場合に出力されま
す。
400 -1063 指定された SVF 検索フィールドの様式名が、4,096 バイトを超える場合に出
力されます。
400 -1064 指定された SVF 検索フィールドの検索名が、256 バイトを超える場合に出力
されます。
第 1 章 SPA Web API リファレンス
490
HTTP ステータス エラーコード 備考
400 -1065 SVF 検索フィールドの登録/更新において、SVF 検索フィールドのデータの
型、日付のフォーマット、タイムゾーンの組み合わせに矛盾がある場合に出
力されます。
404 -1180 保存先設定の更新や文書定義のインポートの際、対象の設定が存在しない場
合に出力されます。
400 -1190 ステータスが「利用可」ではない保存先が指定された場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
400 -20808 指定した値が許容範囲外の場合に出力されます。次のような場合に発生しま
す。
• プレビュー画像の解像度に 150、300、450 以外が指定された場合
• 保存期間に 0 より小さい値が指定された場合
• 履歴の最大数に 0 より小さい値が指定された場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。SVF 検索フィールド
のデータを CSV ファイルで出力する場合の並び順に、数値以外を指定した場
合に発生します。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500
Internal Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
• 正常に作成された場合は、「DocType Get(指定した文書定義の取得)」と同様の形式の情報を付けて返します。
第 1 章 SPA Web API リファレンス
491
DocType Update(Ver. 3) 指定した文書定義の内容を更新します。また、その文書定義に属するすべての SVF 検索フィールドの情報も
一括で更新します。
URI
http://<hostname>:44230/spa/service/doctype_v3
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"id" : "111",
"dispId" : "文書定義 111",
"name" : "docType111",
"version" : 0,
"settings" : {
"retentionPeriod" : 100,
"overwriteForbidden" : false,
"lock" : false,
"deletionForbidden" : false,
"timestamp" : false,
"track" : false,
"trackDeletionRecords" : false,
"previewImageResolution" : 150,
"fileStoreId" : "2",
"previewCacheId" : "2",
第 1 章 SPA Web API リファレンス
492
本体の例(JSON 形式)
"searchIndexId" : "2",
"versioning": "OFF",
"maxHistoryCount": 0
},
"update" : [
{SVF 検索フィールド情報},
{SVF 検索フィールド情報},
{SVF 検索フィールド情報}
],
"create" : [
{SVF 検索フィールド情報},
{SVF 検索フィールド情報},
],
"delete" : [
{SVF 検索フィールド情報}
],
"addTimestamp": true
}
■ データ内容
キー 必須 値 説明
id 文字列 文書定義に自動で割り振られる固有の ID(文書定義管理 ID)です。
更新対象とする文書定義の文書定義管理 ID を指定する必要がありま
す。
dispId 文字列 文書定義 ID です。
name 文字列 文書定義 ID の表示名です。
version 数値 文書定義に自動で設定される値です。
本 API 実行時には何らかの数値を指定する必要があります。
settings 文書管理ポリシー
retentionPeriod 数値 保存期間(日数)です。
0 は「指定なし」を意味します。
第 1 章 SPA Web API リファレンス
493
キー 必須 値 説明
overwriteForbidden true 上書きアーカイブを禁止します。
false 上書きアーカイブを禁止しません。
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 削除を禁止します。
false 削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
previewImageResolution 数値 プレビュー画像の解像度(dpi)です。
150、300、450 のいずれかの値です。初期値は 150 です。
fileStoreId 文字列 ファイル格納フォルダーの ID です。
previewCacheId 文字列 プレビュー用画像キャッシュ格納フォルダーの ID です。
searchIndexId 文字列 検索インデックス格納フォルダーの ID です。
update 更新対象の SVF 検索フィールドの情報
更新対象の情報がない場合は空配列を指定します。
「SVF 検索フィールド指定部分(P.494)」の説明を参照してくださ
い。
create 追加対象の SVF 検索フィールドの情報
追加対象の情報がない場合は空配列を指定します。
「SVF 検索フィールド指定部分(P.494)」の説明を参照してくださ
い。
delete 削除対象の SVF 検索フィールドの情報
削除対象の情報がない場合は空配列を指定します。
「SVF 検索フィールド指定部分(P.494)」の説明を参照してくださ
い。id 以外の情報は使用されません。
第 1 章 SPA Web API リファレンス
494
キー 必須 値 説明
addTimestamp true timestamp を「true」に変更する場合、アーカイブ済みの文書にも
タイムスタンプを付与します。
指定されていない場合は、true が指定されたものとします。
false timestamp を「true」に変更する場合、アーカイブ済みの文書には
タイムスタンプを付与しません。
versioning 文字列 バージョン管理の設定です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount (*1) 数値 バージョン管理をしている場合に保存できる履歴の最大数です。
• versioning が FORWARD_ONLY または FULL で、履歴の最大
数が 1 以上の場合、その値を履歴数の上限とします。
• versioning が FORWARD_ONLY または FULL で、履歴の最大
数が 0 の場合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となります。
*1 「versioning」が「OFF」以外の場合に必須です。
更新、追加、削除の対象となる SVF 検索フィールドがない場合は、update、create、delete の配列は空にし
ます。
SVF 検索フィールド指定部分
更新、追加、削除を行う場合の SVF 検索フィールドの情報は次のとおりです。
SVF 検索フィールド指定部分
{
"id" : "0",
"docTypeId" : "111",
"name" : "fieldText01",
"formName" : "",
"fieldType" : "TEXT",
第 1 章 SPA Web API リファレンス
495
SVF 検索フィールド指定部分
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "SearchName01",
"searchable" : true
}
キー 必須 値 説明
id 文字列 SVF 検索フィールドに自動で割り振られる固有の ID です。
更新および削除の場合は、更新対象とする SVF 検索フィールドの
ID を指定する必要があります。
docTypeId 文字列 文書定義管理 ID です。
name 文字列 SVF 検索フィールド名です。
formName 文字列 様式名です。
指定しない場合は空文字列とします。
fieldType TEXT SVF 検索フィールドのデータの型が「文字列型」です。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式「年月日時分」です。
yyyyMMdd 日時の出力の形式「年月日」です。
MMddHHmm 日時の出力の形式「月日時分」です。
MMdd 日時の出力の形式「月日」です。
HHmmss 日時の出力の形式「時分秒」です。
HHmm 日時の出力の形式「時分」です。
timezone
(*1) NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定「タイムゾーンなし」のみです。
WithTimeZone タイムゾーン設定「タイムゾーンあり」のみです。
第 1 章 SPA Web API リファレンス
496
キー 必須 値 説明
Both タイムゾーン設定「タイムゾーンあり」と「タイムゾーンなし」の
混在です。
repeatField true 繰り返しフィールドです。
false 繰り返しフィールドではありません。
loader true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName 文字列 検索名です。
searchable true 検索対象です。
false 検索対象ではありません。
*1 fieldType および dateType の値との関係は、次のようになります。
fieldType の値 dateType の値 timezone の値
TEXT NONE NONE
NUMERIC NONE NONE
DATE yyyyMMddHHmmss
yyyyMMddHHmm
Both
上記以外 WithoutTimeZone
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
497
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -1003 対象の文書定義が存在しなかった場合に出力されます。
400 -1005 指定された文書定義 ID が 256 バイトを超えている場合に出力されます。
400 -1006 指定された文書定義 ID の表示名が 2048 バイトを超える場合に出力されます。
400 -1007 「アーカイブファイルの格納フォルダー」の ID に数値以外の値が指定された場
合に出力されます。
400 -1008 「キャッシュ用画像の格納フォルダー」の ID に数値以外の値が指定された場合
に出力されます。
400 -1009 「検索インデックス格納フォルダー」の ID に数値以外の値が指定された場合に
出力されます。
403 -1010 アーカイブされている文書で使用されている文書定義を削除しようとした場合に
出力されます。保存先(格納フォルダーID)を更新しようとした場合です。
400 -1061 SVF 検索フィールドの登録または削除において、SVF 検索フィールドが持つ文書
定義管理 ID と、その SVF 検索フィールド情報の親となる文書定義情報にある文
書定義管理 ID が一致していない場合に出力されます。文書定義部分と SVF 検索
フィールド部分で、異なる文書定義管理 ID が指定されています。
400 -1062 指定された SVF 検索フィールド名が 128 バイトを超える場合に出力されます。
400 -1063 指定された SVF 検索フィールドの様式名が、4,096 バイトを超える場合に出力さ
れます。
400 -1064 指定された SVF 検索フィールドの検索名が、256 バイトを超える場合に出力され
ます。検索名が 256 文字を超えて指定されています。
400 -1065 SVF 検索フィールドの登録/更新において、SVF 検索フィールドのデータの型、日
付のフォーマット、タイムゾーンの組み合わせに矛盾がある場合に出力されま
す。
400 -1066 次のいずれかの場合に出力されます。
• Loader 設定画面の[文書定義]タブから参照されている SVF 検索フィール
ドを削除しようとした
第 1 章 SPA Web API リファレンス
498
HTTP ステータ
ス
エラーコー
ド
備考
• 管理画面の[文書定義の設定]において、Loader 設定画面で参照されてい
る SVF 検索フィールドの[振り分け]設定(SVF 検索フィールドの値を振
り分け先のパスやファイル名として使用できるようにするかどうか)をオフ
にしようとした
400 -1180 保存先設定の更新や文書定義のインポートの際、対象の設定が存在しない場合に
出力されます。
400 -1190 ステータスが「利用可」ではない保存先が指定された場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
400 -20808 指定した値が許容範囲外の場合に出力されます。次のような場合に発生します。
• プレビュー画像の解像度に 150、300、450 以外が指定された場合
• 保存期間に 0 より小さい値が指定された場合
• 履歴の最大数に 0 より小さい値が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
• 正常に更新された場合は、「DocType Get(指定した文書定義の取得)」と同様の形式の情報を付けて返
します。
第 1 章 SPA Web API リファレンス
499
DocType Update(Ver. 4) 指定した文書定義の内容を更新します。また、その文書定義に属するすべての SVF 検索フィールドの情報も
一括で更新します。本 Web API は、Ver. 10.1.0.3 以降で利用できます。
URI
http://<hostname>:44230/spa/service/doctype_v4
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
本体の例(JSON 形式)
{
"id" : "111",
"dispId" : "文書定義 111",
"name" : "docType111",
"version" : 0,
"settings" : {
"retentionPeriod" : 100,
"overwriteForbidden" : false,
"lock" : false,
"deletionForbidden" : false,
"timestamp" : false,
"track" : false,
"trackDeletionRecords" : false,
"previewImageResolution" : 150,
"fileStoreId" : "2",
"previewCacheId" : "2",
第 1 章 SPA Web API リファレンス
500
本体の例(JSON 形式)
"searchIndexId" : "2",
"versioning": "OFF",
"maxHistoryCount": 0
},
"update" : [
{SVF 検索フィールド情報},
{SVF 検索フィールド情報},
{SVF 検索フィールド情報}
],
"create" : [
{SVF 検索フィールド情報},
{SVF 検索フィールド情報},
],
"delete" : [
{SVF 検索フィールド情報}
],
"addTimestamp": true
}
■ データ内容
キー 必須 値 説明
id 文字列 文書定義に自動で割り振られる固有の ID(文書定義管理 ID)です。
更新対象とする文書定義の文書定義管理 ID を指定する必要がありま
す。
dispId 文字列 文書定義 ID です。
name 文字列 文書定義 ID の表示名です。
version 数値 文書定義に自動で設定される値です。
本 API 実行時には何らかの数値を指定する必要があります。
settings 文書管理ポリシー
retentionPeriod 数値 保存期間(日数)です。
0 は「指定なし」を意味します。
第 1 章 SPA Web API リファレンス
501
キー 必須 値 説明
overwriteForbidden true 上書きアーカイブを禁止します。
false 上書きアーカイブを禁止しません。
lock true 文書をロックします。
false 文書をロックしません。
deletionForbidden true 削除を禁止します。
false 削除を禁止しません。
timestamp true タイムスタンプを付与します。
false タイムスタンプを付与しません。
track true 追跡記録を保持します。
false 追跡記録を保持しません。
trackDeletionRecords true 文書の削除記録を残します。
false 文書の削除記録を残しません。
previewImageResolution 数値 プレビュー画像の解像度(dpi)です。
150、300、450 のいずれかの値です。初期値は 150 です。
fileStoreId 文字列 ファイル格納フォルダーの ID です。
previewCacheId 文字列 プレビュー用画像キャッシュ格納フォルダーの ID です。
searchIndexId 文字列 検索インデックス格納フォルダーの ID です。
update 更新対象の SVF 検索フィールドの情報
更新対象の情報がない場合は空配列を指定します。
「SVF 検索フィールド指定部分(P.502)」の説明を参照してくださ
い。
create 追加対象の SVF 検索フィールドの情報
追加対象の情報がない場合は空配列を指定します。
「SVF 検索フィールド指定部分(P.502)」の説明を参照してくださ
い。
delete 削除対象の SVF 検索フィールドの情報
削除対象の情報がない場合は空配列を指定します。
「SVF 検索フィールド指定部分(P.502)」の説明を参照してくださ
い。id 以外の情報は使用されません。
第 1 章 SPA Web API リファレンス
502
キー 必須 値 説明
addTimestamp true timestamp を「true」に変更する場合、アーカイブ済みの文書にも
タイムスタンプを付与します。
指定されていない場合は、true が指定されたものとします。
false timestamp を「true」に変更する場合、アーカイブ済みの文書には
タイムスタンプを付与しません。
versioning 文字列 バージョン管理の設定です。
• OFF
バージョン管理しない
• FORWARD_ONLY
閲覧のみ許可する
• FULL
閲覧と復元を許可する
maxHistoryCount
(*1)
数値 バージョン管理をしている場合に保存できる履歴の最大数です。
• versioning が FORWARD_ONLY または FULL で、履歴の最大数が 1 以上の場合、その値を履歴数の上限とします。
• versioning が FORWARD_ONLY または FULL で、履歴の最大数が 0 の場合、履歴数を制限しません。
• versioning が OFF の場合は履歴の最大数は 0 となります。
*1 「versioning」が「OFF」以外の場合に必須です。
更新、追加、削除の対象となる SVF 検索フィールドがない場合は、update、create、delete の配列は空にし
ます。
SVF 検索フィールド指定部分
更新、追加、削除を行う場合の SVF 検索フィールドの情報は次のとおりです。
SVF 検索フィールド指定部分
{
"id" : "0",
"order" : "1",
"docTypeId" : "111",
"name" : "fieldText01",
"formName" : "",
"fieldType" : "TEXT",
"dateType" : "NONE",
第 1 章 SPA Web API リファレンス
503
SVF 検索フィールド指定部分
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "SearchName01",
"searchable" : true
}
キー 必須 値 説明
id 文字列 SVF 検索フィールドに自動で割り振られる固有の ID です。
更新および削除の場合は、更新対象とする SVF 検索フィールドの ID
を指定する必要があります。
order NUMERIC SVF 検索フィールドのデータを CSV ファイルで出力する場合の並び
順です。
docTypeId 文字列 文書定義管理 ID です。
name 文字列 SVF 検索フィールド名です。
formName 文字列 様式名です。
指定しない場合は空文字列とします。
fieldType TEXT SVF 検索フィールドのデータの型が「文字列型」です。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式「年月日時分」です。
yyyyMMdd 日時の出力の形式「年月日」です。
MMddHHmm 日時の出力の形式「月日時分」です。
MMdd 日時の出力の形式「月日」です。
HHmmss 日時の出力の形式「時分秒」です。
HHmm 日時の出力の形式「時分」です。
timezone
(*1) NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定「タイムゾーンなし」のみです。
第 1 章 SPA Web API リファレンス
504
キー 必須 値 説明
WithTimeZone タイムゾーン設定「タイムゾーンあり」のみです。
Both タイムゾーン設定「タイムゾーンあり」と「タイムゾーンなし」の混
在です。
repeatField true 繰り返しフィールドです。
false 繰り返しフィールドではありません。
loader true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName 文字列 検索名です。
searchable true 検索対象です。
false 検索対象ではありません。
*1 fieldType および dateType の値との関係は、次のようになります。
fieldType の値 dateType の値 timezone の値
TEXT NONE NONE
NUMERIC NONE NONE
DATE yyyyMMddHHmmss
yyyyMMddHHmm
Both
上記以外 WithoutTimeZone
▌その他の注意事項 • ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
505
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -1003 対象の文書定義が存在しなかった場合に出力されます。
400 -1005 指定された文書定義 ID が 256 バイトを超えている場合に出力されます。
400 -1006 指定された文書定義 ID の表示名が 2048 バイトを超える場合に出力されます。
400 -1007 「アーカイブファイルの格納フォルダー」の ID に数値以外の値が指定された場
合に出力されます。
400 -1008 「キャッシュ用画像の格納フォルダー」の ID に数値以外の値が指定された場合
に出力されます。
400 -1009 「検索インデックス格納フォルダー」の ID に数値以外の値が指定された場合に
出力されます。
403 -1010 アーカイブされている文書で使用されている文書定義を削除しようとした場合に
出力されます。保存先(格納フォルダーID)を更新しようとした場合です。
400 -1061 SVF 検索フィールドの登録または削除において、SVF 検索フィールドが持つ文書
定義管理 ID と、その SVF 検索フィールド情報の親となる文書定義情報にある文
書定義管理 ID が一致していない場合に出力されます。文書定義部分と SVF 検索
フィールド部分で、異なる文書定義管理 ID が指定されています。
400 -1062 指定された SVF 検索フィールド名が 128 バイトを超える場合に出力されます。
400 -1063 指定された SVF 検索フィールドの様式名が、4,096 バイトを超える場合に出力さ
れます。
400 -1064 指定された SVF 検索フィールドの検索名が、256 バイトを超える場合に出力され
ます。検索名が 256 文字を超えて指定されています。
400 -1065 SVF 検索フィールドの登録/更新において、SVF 検索フィールドのデータの型、日
付のフォーマット、タイムゾーンの組み合わせに矛盾がある場合に出力されま
す。
400 -1066 次のいずれかの場合に出力されます。
• Loader 設定画面の[文書定義]タブから参照されている SVF 検索フィールドを削除しようとした
• 管理画面の[文書定義の設定]において、Loader 設定画面で参照されている SVF 検索フィールドの[振り分け]設定(SVF 検索フィールドの値を振
第 1 章 SPA Web API リファレンス
506
HTTP ステータ
ス
エラーコー
ド
備考
り分け先のパスやファイル名として使用できるようにするかどうか)をオフにしようとした
400 -1180 保存先設定の更新や文書定義のインポートの際、対象の設定が存在しない場合に
出力されます。
400 -1190 ステータスが「利用可」ではない保存先が指定された場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
400 -20808 指定した値が許容範囲外の場合に出力されます。次のような場合に発生します。
• プレビュー画像の解像度に 150、300、450 以外が指定された場合
• 保存期間に 0 より小さい値が指定された場合
• 履歴の最大数に 0 より小さい値が指定された場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。SVF 検索フィールドのデ
ータを CSV ファイルで出力する場合の並び順に、数値以外を指定した場合に発生
します。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
• 正常に更新された場合は、「DocType Get(指定した文書定義の取得)」と同様の形式の情報を付けて返します。
第 1 章 SPA Web API リファレンス
507
DocType Delete 指定した文書定義を削除します。また、その文書定義に属する SVF 検索フィールドもすべて削除されます。
URI
http://<hostname>:44230/spa/service/doctype/<id>
• キー
キー 必須 値 備考
id 対象とする文書定義管理 ID
HTTP メソッド
DELETE
Content-Type ヘッダー
application/json
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
第 1 章 SPA Web API リファレンス
508
HTTP ステータ
ス
エラーコー
ド
備考
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -1003 対象の文書定義が存在しなかった場合に出力されます。
400 -1010 アーカイブされている文書で使用されている文書定義を削除しようとした場合に
出力されます。
400 -1011 文書定義が振り分けの処理定義で使用されている場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
本 API では、「ログイン中ではない場合」に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
510
Timestamp Verify 指定した文書に対してタイムスタンプのベリファイを実行します。
Ver. 10.1 以降では、リンクおよびページリンクの場合は、リンク元文書のタイムスタンプのベリファイを実
行します。
URI
http://<hostname>:44230/spa/service/timestamp
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必須 値 備考
ids ベリファイを実行する文書の ID カンマ区切りで複数指定可能です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
511
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
400 -401 指定したファイルが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"verifyResults": [
{
"id": "1",
"name": "ccc.pdf",
"folderPath": "/aaa/bbb/"
"status": "2",
"verified": "true",
"onTime": "true",
"trusted": "false",
"timestampedDate": "2000-01-01T12:00:00.999+0900",
"expirationDate": "2020-01-01T12:00:00.999+0900",
"imageInfo": "[1,300,24,RGB,595,842],[4,200,24,RGB,595,842],[7,300,24,RGB,612,792],[10]"
},
第 1 章 SPA Web API リファレンス
512
出力例(JSON 形式)
{
"id": "2",
"name": "123.pdf",
"folderPath": "/aaa/bbb/"
"status": "3",
"verified": "false",
"onTime": "false",
"trusted": "false",
"timestampedDate": null,
"expirationDate": null,
"imageInfo": null
}
],
"summary": {
"notOnTimeCount": "0",
"notTrustedCount": "1",
"notVerifiedCount": "0"
"excludedCount": "0"
}
}
■ データ内容
キー 値 説明
verifyResults ベリファイの結果
id 文字列 文書 ID です。
name 文字列 文書名です。
folderPath 文字列 文書が存在するフォルダーのパスです。
status 0 文書の状態が「タイムスタンプを付与しない文書」です。
1 文書の状態が「タイムスタンプ付与待ち」です。
2 文書の状態が「タイムスタンプ付与済み」です。
3 文書の状態が「タイムスタンプ付与失敗または付与できないファイル」です。
第 1 章 SPA Web API リファレンス
513
キー 値 説明
4 文書の状態が「マスク適用待ち」です。
5 文書の状態が「タイムスタンプ対象外」です。
verified true ベリファイ結果が「改ざんされていない」です。
false ベリファイ結果が「改ざんされている」です。
status「2」以外の場合は false になります。
onTime true タイムスタンプの有効時間内です。
false タイムスタンプの有効時間超過です。
status「2」以外の場合は false になります。
trusted true 証明書が信頼できます(信頼済ルート証明をたどれる)。
false 証明書が信頼できません。
status「2」以外の場合は false になります。
timestampedDate 文字列 タイムスタンプ署名日時です。
status「2」以外の場合は null になります。
expirationDate 文字列 署名の失効日時です。
status「2」以外の場合は null になります。
imageInfo 文字列 タイムスタンプを付与した文書のイメージ情報です。
次の形式で出力します。
[<page>,<dpi>,<bit(per pixel)>,<color(RGB/GrayScale/CMYK/Unknown)>,<page 幅
(point)>,<page 高(point)>]
出力例
[1,300,24,RGB,595,842]
1 ぺージ目の画像が取得できない場合、status「2」以外の場合は、null になります。
2 ページ目以降に 1 ぺージ目と異なる画像情報ぺージがある場合は、1 ページ目の情報
のあとに続けて出力されます。
summary ベリファイ結果のまとめ
notOnTimeCount 文字列 タイムスタンプが有効時間を超過している文書数です。
notTrustedCount 文字列 証明書が信頼できない文書数です。
notVerifiedCount 文字列 改ざんされている文書数です。
excludedCount 文字列 タイムスタンプ対象外の文書数です。
第 1 章 SPA Web API リファレンス
514
28 マスクの適用 マスクの適用に関する API は次のとおりです。
• Mask Apply(Ver. 2)(P.515)
• Mask Apply Search Result(P.520)
第 1 章 SPA Web API リファレンス
515
Mask Apply(Ver. 2) マスク(マスクのパターン)または任意の矩形情報を指定して、マスクを文書に適用します。
URI
http://<hostname>:44230/spa/service/masks_v2/apply
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"documentId": "10",
"maskPattern": {
"id": "1",
"pageNums": [
1,
3,
...
]
},
"maskRects": {
"fillType": 1,
"rectInfo": [
{
"pageNum": 1,
"rects": [
{
第 1 章 SPA Web API リファレンス
516
オブジェクトの例(JSON 形式)
"height": 26,
"width": 260,
"x": 107,
"y": 159
},
{
"height": 77,
"width": 136,
"x": 58,
"y": 76
}
]
},
{
"pageNum": 3,
"rects": [
{
"height": 225,
"width": 290,
"x": 462,
"y": 620
}
]
}
]
},
"condition": {
"documentEntityVersion": 1,
"useDocumentEntityVersion": true
}
}
第 1 章 SPA Web API リファレンス
517
■ データ内容
キー 必須 値 備考
documentid 文字列 文書 ID です。
maskPattern (*1) 適用するマスク(マスクのパターン)と適用するページの情報
id 文字列 マスクの ID です。
pageNums マスク適用するページ番号のリストです。
指定されていない場合は、全ページにマスクを適用します。
maskRects (*1) マスクとする矩形に関する情報
fillType 数値 マスクの表示形式です。「maskPattern」が指定されている場合
は、使用されるマスク(マスクのパターン)の設定に従いま
す。
• 0
黒塗り
• 1
白抜き
• 2
アスタリスク
pageNum 数値 マスク適用するページ番号です。
必ず指定します。
rects 矩形の位置とサイズの情報
x 数値 左上を基点とした矩形の開始位置(X 座標)です。
y 左上を基点とした矩形の開始位置(Y 座標)です。
width 矩形の幅です。
height 矩形の高さです。
condition マスク適用時の条件
指定されていない場合は、「useDocumentEntityVersion」が
「false」の場合と同じになります。
useDocumentEntityVersion true 条件として文書のエンティティバージョンを指定します。
false 条件として文書のエンティティバージョンを指定しません。
指定されていない場合は、false が指定されたものとします。
第 1 章 SPA Web API リファレンス
518
キー 必須 値 備考
documentEntityVersion (*2) 数値 文書のエンティティバージョンです。
*1 どちらか 1 つの指定が必須です。
*2 「useDocumentEntityVersion」が「true」の場合に必須です。
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -409 アーカイブされた文書を更新する際、対象の文書を開いたときのバージョンとサ
ーバーに保管されている文書のバージョンが一致しなかった場合に出力されま
す。
400 -418 リンクに対して、手動でマスクを適用しようとした場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
第 1 章 SPA Web API リファレンス
519
HTTP ステータ
ス
エラーコー
ド
備考
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。以下の場合が該当しま
す。
• 「maskPattern」と「maskRects」のどちらも指定されていない場合
• 「maskRects」指定時に矩形に関する情報が指定されていない場合
• 「maskPattern」指定時に「id」の値が文書に設定されているマスクの ID
と異なる場合
「文書に設定されているマスクの ID」とは、Loader の振り分け設定で指定
された ID、または、フォルダーの文書管理ポリシーで設定された ID です。
両者が指定されている場合は前者が優先されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
520
Mask Apply Search Result 検索条件に合致した部分にマスクを適用します。
URI
http://<hostname>:44230/spa/service/masks/apply/search
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"documentIds": [
"1",
"2",
"3"
],
"mask": {
"fillType": 0
},
"searchCondition": {
"searchWord": "searchword and Search",
"operator": "AND",
"conditions": [
{
"conditionType": "svfField",
"name": "field1",
"docTypeId": "1",
第 1 章 SPA Web API リファレンス
521
オブジェクトの例(JSON 形式)
"formName": "form1",
"dataType": "date",
"dateFormat": 1,
"from": "19700101090000",
"to": "19700101180000",
"offset": "9"
},
{
"conditionType": "svfField",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "numeric",
"min": "1",
"max": "10"
},
{
"conditionType": "svfField",
"name": "field2",
"docTypeId": "1",
"formName": "form1",
"dataType": "numeric",
"anyValue": true
},
{
"conditionType": "pageContent",
"name": "annotation",
"value": "annotation text",
"type": "contains",
"exact": "true"
}
]
}
第 1 章 SPA Web API リファレンス
522
オブジェクトの例(JSON 形式)
}
■ データ内容
キー 必須 値 備考
documentIds 文字
列
マスク適用の対象とする文書 ID です。
mask 適用するマスクの情報
fillType 数値 適用するマスクの表示形式です。
• 0
黒塗り
• 1
白抜き
• 2
アスタリスク
searchCondition マスク適用の対象とする文書の検索条件
指定した検索条件に合致したページを対象にマスクが適用されます。
searchWord
(*1)
文字
列
全文検索での検索文字列です。
operator AND すべての条件に一致(複数の検索条件を指定した場合の各検索条件の連結方
法)
指定されていない場合は、AND が指定されたものとします。
OR いずれかの条件に一致(複数の検索条件を指定した場合の各検索条件の連結
方法)
conditions
(*1)
各検索条件のリスト
検索条件の種類は、conditionType の値で指定します。
• svfField
SVF 検索フィールド
• details
明細検索
• pageContent
第 1 章 SPA Web API リファレンス
523
キー 必須 値 備考
ページコンテンツ(注釈、ページメモ)
*1 どちらか 1 つの指定が必須です。
• SVF 検索フィールドの検索条件の指定方法について
SVF 検索フィールドの検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定
します。
name キーの値 dataType キーの値 備考
SVF 検索フィー
ルドの検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できます。
text value キーに検索の対象となる文字列を指定します。
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定可能なキーは異なります。「 」は、指定できることを示し
ます。「 」については「type キー(P.524)」を参照してください。空欄は指定できないことを示しま
す。
dataTyp
e
キーの値
指定可能なキー
docTypeId formName from to min max value type dateFormat exact offset anyValue
numeric
text
date
○ docTypeID キー
SVF 検索フィールドの検索において利用する文書定義管理 ID を指定します。docTypeId キー自体
を記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された
場合は、文書定義管理 ID の指定なしとして検索します。また、値に null が指定された場合は、文
書定義管理 ID の横断検索を行います。
○ formName キー
SVF 検索フィールドの検索において利用する様式ファイル名を指定します。formName キー自体を
記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された場
合は、様式ファイル名の「指定なし」として検索します。また、値に null が指定された場合は、様
式ファイル名の横断検索を行います。
第 1 章 SPA Web API リファレンス
524
○ from/to キー(SVF 検索フィールドの検索条件)
日時指定のフォーマットについては、「dateFormat キー(P.524)」を参照してください。文書プロパ
ティの日時指定と異なるので注意が必要です。
○ min/max キー(SVF 検索フィールドの検索条件)
指定可能な数値の範囲は、-9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)です。
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ dateFormat キー
from キーや to キーの値を指定する際のフォーマットを指定します。以下の 1 から 7 までの 7 種類
の数値が指定できます。この値は、検索対象の SVF 検索フィールドの日付のフォーマットと一致し
ている必要があります。
指定できる値 備考
1 yyyyMMddHHmmss(年月日時分秒)
2 yyyyMMddHHmm(年月日時分)
3 yyyyMMdd(年月日)
4 MMddHHmm(月日時分)
5 MMdd(月日)
6 HHmmss(時分秒)
7 HHmm(時分)
第 1 章 SPA Web API リファレンス
525
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
SVF 検索フィールドでは常に値が存在するため、「値が存在しないこと」を条件とする empty キー
は指定できません。
○ offset キー
SVF 検索フィールドの dataType キーの値が「date」の場合、かつ、dateFormat キーの値が「1」
または「2」のとき(つまり、年月日時分秒または年月日時分を使った日時検索のとき)、指定した
日時にタイムゾーンも考慮して検索を行いたい場合に指定します。
指定できる値は、協定世界時との差(UTC offset)の数値(-12 から 14 まで)です。
■ 指定例
▫ 日本は、UTC +9:00 なので「offset=9」
▫ ベネズエラは、UTC -4:30 なので「offset=-4.5」
▫ ニュージーランドのチャタム諸島は、UTC +12:45 なので、「offset=12.75」
■ 詳細説明
SVF 検索フィールドの日付型のデータには、内部的に「タイムゾーンつき」のデータと「タイム
ゾーンなし」のデータの 2 種類が存在しています。offset キーを指定しない場合は、「タイムゾ
ーンなし」の日付型データのみを検索対象とし、offset キーを指定すると、「タイムゾーンな
し」と「タイムゾーンつき」の両方の日付型データを検索対象とします。
■ 検索例
▫ offset キーなし
from="20141011103000" to="20141022235959" (2014 年 10 月 11 日 10 時 30 分 00 秒か
ら 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンなし」のデー
タから上記の期間に該当するデータを抽出します。
▫ offset キーつき
from="20141011103000" to="20141022235959" offset="9" (2014 年 10 月 11 日 10 時 30
分 00 秒から 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンな
し」のデータから上記の期間に該当するデータを抽出し、「タイムゾーンつき」のデータから
も上記の期間に該当するデータを抽出します。
第 1 章 SPA Web API リファレンス
526
日本標準時(JST)の「2014-10-22T23:59:59.000+0900」(「2014-10-22T14:59:59.000+0000」
と同じ)で登録されている「タイムゾーンつき」データが抽出されます。
米国カリフォルニア(太平洋標準時(PST))の「2014-10-22T06:59:59.000-0800」(「2014-10-
22T14:59:59.000+0000」と同じ)で登録されている「タイムゾーンつき」データが抽出され
ます。
○ anyValue キー
指定可能な値は「true」のみです。
指定された項目に値が存在するものを抽出します。「true」に指定された場合には、他の検索用キー
の指定の有無にかかわらず、値の有無だけが抽出の条件となります。
• 明細検索の検索条件の指定方法について
明細検索の検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定します。基
本的には SVF 検索フィールドと同様のキーを指定しますが、検索条件に関する部分については
detailsConditions キーの値として複数指定できます。
name キーの値 dataType キーの値 備考
SVF 検索フィー
ルドの検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できます。
text value キーに検索の対象となる文字列を指定します。
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定できるキーが異なります。「 」は、指定できることを示し
ます。空欄は指定できないことを示します。
dataType キーの
値
指定可能なキー
docTypeId formName dateFormat offset datailsConditions
numeric
text
date
○ detailsConditions キー
detailsConditions キーには、検索条件をリストで指定します。detailsConditions キー内に指定す
るキーは、次のとおりです。
「 」は、指定できることを示します。「 」については「type キー(P.524)」を参照してくださ
い。空欄は指定できないことを示します。
第 1 章 SPA Web API リファレンス
527
dataType キーの値 指定可能なキー
from to min max value type exact
numeric *1
text *2
date *3
■ *1 数値の最小値と最大値、または、いずれか一方を指定できます。
■ *2 value キーに検索の対象となる文字列を指定します。
■ *3 日時の開始と終了、または、いずれか一方を指定できます。
• ページコンテンツの検索条件の指定方法について
ページコンテンツの検索条件で指定する name キーの値は、次のとおりです。
name キーの
値
検索対象 備考
annotation 注釈 value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指
定した文字列そのもので検索します。
pagememo ページメモ value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指
定した文字列そのもので検索します。
選択した name キーによって、検索条件として指定できるキーは異なります。「 」は、指定できるこ
とを示します。空欄は指定できないことを示します。
name キーの値 指定可能なキー
value type exact empty
annotation
pagememo
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
第 1 章 SPA Web API リファレンス
528
type キーの値 説明
endswith で終わる
notequals と一致しない
notcontains を含まない
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
第 1 章 SPA Web API リファレンス
529
HTTP ステータ
ス
エラーコー
ド
備考
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -418 リンクに対して、手動でマスクを適用しようとした場合に出力されます。
400 -700 検索実行時、プレビューでのハイライト表示時、検索データ作成時に何らかのエ
ラーが発生した場合に出力されます。
404 -707 全文検索機能がオフに設定されている状態で、全文検索または文書内検索を実行
しようとした場合に発生します。
400 -1002 指定した SVF 検索フィールドが存在しなかった場合に出力されます。
400 -1121 マスク適用中のファイルを操作しようとした場合に出力されます。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20703 全文検索の検索条件に 1,025 バイト以上の文字を指定した場合、または、文書内
検索の検索条件に 257 バイト以上の文字列を指定した場合に出力されます。
400 -20705 全文検索の対象となる文字列の指定に問題がある場合に出力されます。
400 -20706 検索条件の指定において、括弧の使い方が正しくない場合に出力されます。
400 -20707 検索条件の指定において、ダブルクォーテーションが閉じられていない場合に出
力されます。
400 -20708 検索条件の指定において、演算子の位置が誤っている場合に出力されます。
400 -20709 全文検索以外の検索文字列で最大文字数(256)を超えている、検索条件の指定
が 1 つもないなどの場合に出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
530
29 SVF 検索フィールド SVF 検索フィールドに関する API は、次のとおりです。
• SearchFields List(P.531)
• SearchFields Get(P.537)
• SearchFields Parse PDF(P.541)
• SearchFields Parse Form(P.544)
第 1 章 SPA Web API リファレンス
531
SearchFields List 指定した条件に合致する SVF 検索フィールドの一覧を取得します。
URI
http://<hostname>:44230/spa/service/searchfields/list
HTTP メソッド
GET
▌パラメーター
キー 必須
(検索名指定
時)
必須
(検索名指定なし
時)
値 備考
docTypeId 文書定義管理 ID
formName 様式名 指定しない場
合、すべての様
式名を対象に検
索を行います。
searchName 検索名
fieldType SVF 検索フィールドのデータの型
• TEXT
文字列型
• NUMERIC
数値型
• DATE
日付型
検索名を指定し
ない場合は、指
定できません。
dateType 日付型の SVF 検索フィールドの形式
• NONE
fieldType が DATE 以外の場合
• yyyyMMddHHmmss
検索名を指定し
ない場合は、指
定できません。
第 1 章 SPA Web API リファレンス
532
キー 必須
(検索名指定
時)
必須
(検索名指定なし
時)
値 備考
年月日時分秒
• yyyyMMddHHmm
年月日時分
• yyyyMMdd
年月日
• MMddHHmm
月日時分
• MMdd
月日
• HHmmss
時分秒
• HHmm
時分
repeatField 繰り返しフィールドかどうか
• true
繰り返しの SVF 検索フィールド
のみを抽出します。
• false
すべての SVF 検索フィールドを
抽出します。
指定しない場
合、すべての
SVF 検索フィー
ルドを抽出しま
す。
loader 振り分け処理定義で利用可能かどうか
• true
振り分け処理定義で利用可能な
SVF 検索フィールドのみを抽出
します。
• false
すべての SVF 検索フィールドを
抽出します。
指定しない場
合、すべての
SVF 検索フィー
ルドを抽出しま
す。
第 1 章 SPA Web API リファレンス
533
キー 必須
(検索名指定
時)
必須
(検索名指定なし
時)
値 備考
searchable 検索対象かどうか
• true
検索対象の SVF 検索フィールド
のみを抽出します。
• false
すべての SVF 検索フィールドを
抽出します。
指定しない場
合、すべての
SVF 検索フィー
ルドを抽出しま
す。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
534
HTTP ステータ
ス
エラーコー
ド
備考
400 -29001 パラメーターの指定に誤りがある場合に出力されます。必須項目の指定がなかっ
た場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"searchField" : [
{
"id" : "3",
"docTypeId" : "1001",
"name" : "fieldText01",
"formName" : "FormR2",
"fieldType" : "TEXT",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "SearchName01",
"searchable" : true
},
{
"id" : "4",
"docTypeId" : "1001",
"name" : "fieldDate03",
"formName" : "FormR2",
"fieldType" : "DATE",
"dateType" : "yyyyMMddHHmmss",
第 1 章 SPA Web API リファレンス
535
出力例(JSON 形式)
"timezone" : "Both",
"repeatField" : false,
"loader" : true,
"searchName" : "SearchName02",
"searchable" : true
}
]
}
■ データ内容
キー 値 説明
searchFields SVF 検索フィールド
id 文字列 SVF 検索フィールドに割り振られた固有の ID です。
docTypeId 文字列 文書定義管理 ID です。
name 文字列 SVF 検索フィールド名です。
formName 文字列 様式名です。
fieldType TEXT SVF 検索フィールドのデータの型が「文字列型」です。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式が「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式が「年月日時分」です。
yyyyMMdd 日時の出力の形式が「年月日」です。
MMddHHmm 日時の出力の形式が「月日時分」です。
MMdd 日時の出力の形式が「月日」です。
HHmmss 日時の出力の形式が「時分秒」です。
HHmm 日時の出力の形式が「時分」です。
timezone NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定が「タイムゾーンなし」のみです。
第 1 章 SPA Web API リファレンス
536
キー 値 説明
WithTimeZone タイムゾーン設定が「タイムゾーンあり」のみです。
Both タイムゾーン設定が「タイムゾーンあり」と「タイムゾーンなし」の混在で
す。
repeatField true 繰り返しフィールドです。
false 繰り返しフィールドではありません。
loader true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName 文字列 検索名です。
searchable true 検索対象です。
false 検索対象ではありません。
第 1 章 SPA Web API リファレンス
537
SearchFields Get 指定した条件に合致する SVF 検索フィールドを取得します。
URI
http://<hostname>:44230/spa/service/searchfields
HTTP メソッド
GET
▌パラメーター
キー 必
須
値 備考
docTypeId 文書定義管理 ID
formName 様式名 指定しない場合、すべての様式名を対象に検索を行いま
す。
name SVF 検索フィールド名
fieldType SVF 検索フィールドのデータの型
• TEXT
文字列型
• NUMERIC
数値型
• DATE
日付型
dateType 日付型の SVF 検索フィールドの形
式
• NONE
fieldType が DATE 以外の場合
• yyyyMMddHHmmss
年月日時分秒
第 1 章 SPA Web API リファレンス
538
キー 必
須
値 備考
• yyyyMMddHHmm
年月日時分
• yyyyMMdd
年月日
• MMddHHmm
月日時分
• MMdd
月日
• HHmmss
時分秒
• HHmm
時分
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
539
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -1052 SVF 検索フィールドの情報を取得する際、指定した条件に合致する SVF 検索フィ
ールドが存在しなかった場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。必須項目の指定がなかっ
た場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id" : "3",
"docTypeId" : "1001",
"name" : "fieldText01",
"formName" : "",
"fieldType" : "TEXT",
"dateType" : "NONE",
"timezone" : "NONE",
"repeatField" : false,
"loader" : true,
"searchName" : "SearchName01",
"searchable" : true
}
第 1 章 SPA Web API リファレンス
540
■ データ内容
キー 値 説明
id 文字列 SVF 検索フィールドに割り振られた固有の ID です。
docTypeId 文字列 文書定義管理 ID です。
name 文字列 SVF 検索フィールド名です。
formName 文字列 様式名です。
fieldType TEXT SVF 検索フィールドのデータの型が「文字列型」です。
NUMERIC SVF 検索フィールドのデータの型が「数値型」です。
DATE SVF 検索フィールドのデータの型が「日付型」です。
dateType NONE fieldType が DATE(日付型)以外の場合です。
yyyyMMddHHmmss 日時の出力の形式が「年月日時分秒」です。
yyyyMMddHHmm 日時の出力の形式が「年月日時分」です。
yyyyMMdd 日時の出力の形式が「年月日」です。
MMddHHmm 日時の出力の形式が「月日時分」です。
MMdd 日時の出力の形式が「月日」です。
HHmmss 日時の出力の形式が「時分秒」です。
HHmm 日時の出力の形式が「時分」です。
timezone NONE fieldType が DATE(日付型)以外の場合です。
WithoutTimeZone タイムゾーン設定が「タイムゾーンなし」のみです。
WithTimeZone タイムゾーン設定が「タイムゾーンあり」のみです。
Both タイムゾーン設定が「タイムゾーンあり」と「タイムゾーンなし」の混在で
す。
repeatField true 繰り返しフィールドです。
false 繰り返しフィールドでありません。
loader true 振り分け処理定義で利用可能です。
false 振り分け処理定義で利用できません。
searchName 文字列 検索名です。
searchable true 検索対象です。
false 検索対象ではありません。
第 1 章 SPA Web API リファレンス
541
SearchFields Parse PDF PDF ファイルを解析して SVF 検索フィールドを取得します。
URI
http://<hostname>:44230/spa/service/searchfields/pdf
HTTP メソッド
POST
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必須 値 備考
file 解析する PDF ファイル
password 暗号化された PDF ファイルのパスワード • デフォルト値なし
• 文字エンコードは UTF-8 とします
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
第 1 章 SPA Web API リファレンス
542
キー 値の内容 備考
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
400 -103 指定されたファイルが PDF ファイルではない場合に出力されます。
400 -105 暗号化された PDF ファイルを復号できない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。登録するファイルが指定さ
れていない場合です。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"searchField": [
{
SVF 検索フィールド
},
...
],
"errorField": [
{
SVF 検索フィールド
第 1 章 SPA Web API リファレンス
543
出力例(JSON 形式)
},
...
]
}
■ データ内容
キー 値 説明
searchField SVF 検索フィールドのリスト
下位階層の構成要素については、「SearchFields List(P.531)」の出力例を参照してください。
errorField 使用できない SVF 検索フィールドのリスト
日付型で日付のフォーマットが使用できない場合が該当します。
下位階層の構成要素は、searchField と同じです。
第 1 章 SPA Web API リファレンス
544
SearchFields Parse Form 様式ファイルを解析して SVF 検索フィールドを取得します。
URI
http://<hostname>:44230/spa/service/searchfields/form
HTTP メソッド
POST
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必須 値 備考
file 解析する様式ファイル
page 解析対象の綴りページ番号 指定がない場合は、「1」として実行します。
filter SVF 検索フィールド名の条件 指定された文字列と前方一致した SVF 検索フィールド名のみを出力します。
指定がない場合および空文字の場合は、すべての SVF 検索フィールドを出力します。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
545
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
404 -401 指定したファイルが存在しない場合に出力されます。登録するファイルが指定さ
れていない場合です。
400 -1067 指定されたファイルが SVF の様式ファイルではない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29002 ページ番号の指定に問題がある場合に出力されます。page の値が範囲外の場合
です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"searchField": [
{
SVF 検索フィールド
},
第 1 章 SPA Web API リファレンス
546
出力例(JSON 形式)
...
],
"errorField": [
{
SVF 検索フィールド
},
...
]
}
■ データ内容
キー 値 説明
searchField SVF 検索フィールドのリスト
下位階層の構成要素については、「SearchFields List(P.531)」の出力例を参照してください。
errorField 使用できない SVF 検索フィールドのリスト
日付型で日付のフォーマットが使用できない場合が該当します。
下位階層の構成要素は、searchField と同じです。
第 1 章 SPA Web API リファレンス
547
30 SVF 検索フィールドデータの CSV ファイ
ル出力 SVF 検索フィールドデータの CSV ファイル出力に関する API は、次のとおりです。
• Request Search Data Csv From Documents(Ver. 4)(P.548)
• Request Search Data Csv From Documents(Ver. 5)(P.555)
• Request Search Data Csv From Search Results(Ver. 4)(P.563)
• Request Search Data Csv From Search Results(Ver. 5)(P.581)
• Output Search Data Csv Status(P.600)
• Output Search Data Csv Get(P.604)
第 1 章 SPA Web API リファレンス
548
Request Search Data Csv From Documents
(Ver. 4) 指定した文書内にある SVF 検索フィールドデータを対象として、CSV データの作成を依頼します。
URI
http://<hostname>:44230/spa/service/output_v4/searchdatacsv/request/document
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"documentIds": [
"1000",
"1200",
"1500",
"2014",
"54543"
],
"headerNameType": "searchName",
"outputMethod": "splitFile",
"splitFileLimitBreak": 10000,
"outputColumns": [
{
"type": "general",
"name": "docpath"
第 1 章 SPA Web API リファレンス
549
オブジェクトの例(JSON 形式)
},
{
"type": "system",
"name": "title"
},
{
"type": "page",
"name": "pageNumber"
}
],
"bom": "true",
"zipFileName": "comp001.zip",
"zipEncoding": "MS932"
}
■ データ内容
キー 必須 値 備考
documentIds 文字列 CSV ファイルにデータを出力する文書の文書 ID です。複数の文書
ID を指定する場合は、リストで指定します。
docPages 文字列 データを出力する対象とするページ番号です。指定されていない場
合は全ページが対象になります。「documentIds」で 1 つの文書が
指定されている場合にのみ、この指定が有効になります。
カンマ区切りによる指定(1,3,4)、ハイフンによる範囲指定(1-5)
で指定できます。同じページを複数回指定することも可能です。
headerNameType searchName ヘッダーに SVF 検索フィールドの検索名を出力します。
指定されていない場合は、searchName が指定されたものとしま
す。
svfField ヘッダーに SVF 検索フィールド名を出力します。
outputMethod splitFile 文書定義および SVF 検索フィールドの様式名ごとに CSV ファイルを
分割して、SVF 検索フィールドデータを出力します。
指定されていない場合は、splitFile が指定されたものとします。
svfUcx CSV ファイルを分割しません。様式名の切り替え情報(Universal
Connect/X で使用する CSV ファイルで様式ファイルを切り替えると
第 1 章 SPA Web API リファレンス
550
キー 必須 値 備考
きの形式)を出力した上で連続して SVF 検索フィールドデータを出
力します。
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 1,SVF 検索フィールド 2
データ 1,データ 2
データ 3,データ 4
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 3
データ 5
データ 6
splitFileLimitBreak (*1) 数値 1 ファイルに出力できる最大行数を 0~2,147,483,647 までで指定し
ます。0 を指定した場合は無制限となります。
outputMethod で splitFile が指定された場合にのみ指定は有効で
す。
outputColumns CSV ファイルに追加で出力する項目
type 文字列 追加で出力する項目のタイプを以下から指定します。
• general
全般
• system
PDF プロパティ
• page
ページ(SVF 検索フィールドデータの CSV ファイル出力で使用
する専用の項目)
• custom
カスタムプロパティ
name 文字列 項目のタイプに応じた名称または ID を指定します。
第 1 章 SPA Web API リファレンス
551
キー 必須 値 備考
• type に general を指定した場合
「全般の name キーの値(P.551)」を参照してください。
• type に system を指定した場合
「PDF プロパティの name キーの値(P.553)」を参照してくだ
さい。
• type に page を指定した場合
「ページの name キーの値(P.553)」を参照してください。
• type に custom を指定した場合
出力するカスタムプロパティの ID を指定します。
bom true BOM を付加した CSV ファイルを出力します。
指定されていない場合は、true が指定されたものとします。
false BOM を付加しない CSV ファイルを出力します。
zipFileName 文字列 圧縮ファイルのファイル名を指定します。
zipEncoding 文字列 圧縮ファイルに含む CSV ファイル名のエンコーディングを指定しま
す。
指定されていない場合は、UTF-8 が指定されたものとします。
*1 outputMethod に「splitFile」を指定した場合に必須です。
全般の name キーの値
name キーの値 説明
id 文書 ID
name ファイル名
docpath フォルダーパス
size サイズ
pagecount ページ数
adddate 作成日
adduser 作成ユーザー
adduserdomain 作成ユーザーのドメイン
updatedate アーカイブ日時
updateuser アーカイブユーザー
第 1 章 SPA Web API リファレンス
552
name キーの値 説明
updateuserdomain アーカイブユーザーのドメイン
filetype 種類
linkpath リンク元パス
viewuser 最終閲覧ユーザー
viewuserdomain 最終閲覧ユーザーのドメイン
viewdate 最終閲覧日時
downloaduser 最終ダウンロードユーザー
downloaduserdomain 最終ダウンロードユーザーのドメイン
downloaddate 最終ダウンロード日時
printuser 最終印刷ユーザー
printuserdomain 最終印刷ユーザーのドメイン
printdate 最終印刷日時
doctype_id 文書定義 ID
doctype_dispname 文書定義名
stamp タイムスタンプ(Ver. 10.1 以降では、リンクおよびページリンクの場合は、リンク元文
書の情報)
stamped_image_info タイムスタンプの画像情報(Ver. 10.1 以降では、リンクおよびページリンクの場合は、
リンク元文書の情報)
doctype_key 文書定義管理 ID
parsed_status 文書ステータス
review_status レビューステータス
document_version 文書のバージョン
svffield_editable_status SVF 検索フィールドの編集ステータス
annotation_existence 注釈の有無
convert_doc_status Document Converter 変換ステータス
doc_convert_error Document Converter 変換のエラーコード
doc_convert_connection Document Converter の接続先情報
content_type コンテンツタイプ
第 1 章 SPA Web API リファレンス
553
PDF プロパティの name キーの値
name キーの値 説明
title タイトル
author PDF 作成者
subject サブタイトル
keywords キーワード
createdate PDF 作成日時
modifydate PDF 更新日時
creator 作成アプリケーション
producer PDF 変換
ページの name キーの値
name キーの値 説明
formName 様式名
pageNumber ページ番号
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
554
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在しな
かった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。文書 ID(documentIds)
が複数指定されており、さらにページ番号(docPages)が指定されている場合
に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
正常に受付された場合の出力例(JSON 形式)
{
"requestId": "100001"
}
■ データ内容
キー 値 備考
requestId 文字列 CSV データ作成処理の受付番号です。
この ID が、ステータス取得や生成後の Zip 圧縮ファイルの取得のキーとなります。
第 1 章 SPA Web API リファレンス
555
Request Search Data Csv From Documents
(Ver. 5) 指定した文書内にある SVF 検索フィールドデータを対象として、CSV データの作成を依頼します。本 Web
API は、Ver. 10.1 以降で利用できます。
URI
http://<hostname>:44230/spa/service/output_v5/searchdatacsv/request/document
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"documentIds": [
"1000",
"1200",
"1500",
"2014",
"54543"
],
"headerNameType": "searchName",
"outputMethod": "splitFile",
"splitFileLimitBreak": 10000,
"outputColumns": [
{
"type": "general",
第 1 章 SPA Web API リファレンス
556
オブジェクトの例(JSON 形式)
"name": "docpath"
},
{
"type": "system",
"name": "title"
},
{
"type": "page",
"name": "pageNumber"
}
],
"bom": "true",
"zipFileName": "comp001.zip",
"zipEncoding": "MS932",
"useRawData": true,
"removeEmptyLines": true
}
■ データ内容
キー 必須 値 備考
documentIds 文字列 CSV ファイルにデータを出力する文書の文書 ID です。複数の文書 ID
を指定する場合は、リストで指定します。
docPages 文字列 データを出力する対象とするページ番号です。指定されていない場合
は全ページが対象になります。「documentIds」で 1 つの文書が指定
されている場合にのみ、この指定が有効になります。
カンマ区切りによる指定(1,3,4)、ハイフンによる範囲指定(1-5)で
指定できます。同じページを複数回指定することも可能です。
headerNameType searchName ヘッダーに SVF 検索フィールドの検索名を出力します。
指定されていない場合は、searchName が指定されたものとします。
svfField ヘッダーに SVF 検索フィールド名を出力します。
outputMethod splitFile 文書定義および SVF 検索フィールドの様式名ごとに CSV ファイルを
分割して、SVF 検索フィールドデータを出力します。
第 1 章 SPA Web API リファレンス
557
キー 必須 値 備考
指定されていない場合は、splitFile が指定されたものとします。
svfUcx CSV ファイルを分割しません。様式名の切り替え情報(Universal
Connect/X で使用する CSV ファイルで様式ファイルを切り替えるとき
の形式)を出力した上で連続して SVF 検索フィールドデータを出力し
ます。
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 1,SVF 検索フィールド 2
データ 1,データ 2
データ 3,データ 4
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 3
データ 5
データ 6
splitFileLimitBreak (*1) 数値 1 ファイルに出力できる最大行数を 0~2,147,483,647 までで指定しま
す。0 を指定した場合は無制限となります。
outputMethod で splitFile が指定された場合にのみ指定は有効です。
outputColumns CSV ファイルに追加で出力する項目
type 文字列 追加で出力する項目のタイプを以下から指定します。
• general
全般
• system
PDF プロパティ
• page
ページ(SVF 検索フィールドデータの CSV ファイル出力で使用
する専用の項目)
• custom
カスタムプロパティ
第 1 章 SPA Web API リファレンス
558
キー 必須 値 備考
name 文字列 項目のタイプに応じた名称または ID を指定します。
• type に general を指定した場合
「全般の name キーの値(P.559)」を参照してください。
• type に system を指定した場合
「PDF プロパティの name キーの値(P.560)」を参照してくださ
い。
• type に page を指定した場合
「ページの name キーの値(P.561)」を参照してください。
• type に custom を指定した場合
出力するカスタムプロパティの ID を指定します。
bom true BOM を付加した CSV ファイルを出力します。
指定されていない場合は、true が指定されたものとします。
false BOM を付加しない CSV ファイルを出力します。
zipFileName 文字列 圧縮ファイルのファイル名を指定します。
zipEncoding 文字列 圧縮ファイルに含む CSV ファイル名のエンコーディングを指定しま
す。
指定されていない場合は、UTF-8 が指定されたものとします。
useRawData true Ver. 10.0 までの出力形式です。SPA に取り込まれたデータがそのまま
出力されます。たとえば、日付型の SVF 検索フィールドに
「2019/02/30」というデータがある場合、「2019/02/30」が出力され
ます。
false SPA に取り込まれたデータが、フィールドに設定されているデータ型
(文字列、日付、数値)に応じて型変換されて出力されます。たとえ
ば、日付型の SVF 検索フィールドに「2019/02/30」というデータがあ
る場合、SPA が行う有効な日付かどうかの判定において無効な日付で
あると判断され、""(空)が出力されます。
指定されていない場合は、false が指定されたものとします。
removeEmptyLines true Ver. 10.0 までの出力形式です。明細データにおいて、データが存在す
る最後の行までが出力されます。最終行以降のデータが存在しない行
(空行)は出力されません。
第 1 章 SPA Web API リファレンス
559
キー 必須 値 備考
false 明細データにおいて、データが存在する行だけでなく、データが存在
する最後の行以降にあるデータが存在しない行(空行)も出力されま
す。
指定されていない場合は、false が指定されたものとします。
*1 outputMethod に「splitFile」を指定した場合に必須です。
全般の name キーの値
name キーの値 説明
id 文書 ID
name ファイル名
docpath フォルダーパス
size サイズ
pagecount ページ数
adddate 作成日
adduser 作成ユーザー
adduserdomain 作成ユーザーのドメイン
updatedate アーカイブ日時
updateuser アーカイブユーザー
updateuserdomain アーカイブユーザーのドメイン
filetype 種類
linkpath リンク元パス
viewuser 最終閲覧ユーザー
viewuserdomain 最終閲覧ユーザーのドメイン
viewdate 最終閲覧日時
downloaduser 最終ダウンロードユーザー
downloaduserdomain 最終ダウンロードユーザーのドメイン
downloaddate 最終ダウンロード日時
printuser 最終印刷ユーザー
printuserdomain 最終印刷ユーザーのドメイン
第 1 章 SPA Web API リファレンス
560
name キーの値 説明
printdate 最終印刷日時
doctype_id 文書定義 ID
doctype_dispname 文書定義名
stamp タイムスタンプ(リンクおよびページリンクの場合は、リンク元文書の情報)
stamped_image_info タイムスタンプの画像情報(リンクおよびページリンクの場合は、リンク元文書の情報)
doctype_key 文書定義管理 ID
parsed_status 文書ステータス
review_status レビューステータス
document_version 文書のバージョン
svffield_editable_status SVF 検索フィールドの編集ステータス
annotation_existence 注釈の有無
convert_doc_status Document Converter 変換ステータス
doc_convert_error Document Converter 変換のエラーコード
doc_convert_connection Document Converter の接続先情報
content_type コンテンツタイプ
PDF プロパティの name キーの値
name キーの値 説明
title タイトル
author PDF 作成者
subject サブタイトル
keywords キーワード
createdate PDF 作成日時
modifydate PDF 更新日時
creator 作成アプリケーション
producer PDF 変換
第 1 章 SPA Web API リファレンス
561
ページの name キーの値
name キーの値 説明
formName 様式名
pageNumber ページ番号
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在しな
かった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
第 1 章 SPA Web API リファレンス
562
HTTP ステータ
ス
エラーコー
ド
備考
400 -29002 ページ番号の指定に問題がある場合に出力されます。文書 ID(documentIds)
が複数指定されており、さらにページ番号(docPages)が指定されている場合
に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
正常に受付された場合の出力例(JSON 形式)
{
"requestId": "100001"
}
■ データ内容
キー 値 備考
requestId 文字列 CSV データ作成処理の受付番号です。
この ID が、ステータス取得や生成後の Zip 圧縮ファイルの取得のキーとなります。
第 1 章 SPA Web API リファレンス
563
Request Search Data Csv From Search
Results(Ver. 4) 検索でヒットした文書内にある SVF 検索フィールドデータを対象として、CSV データの作成を依頼します。
URI
http://<hostname>:44230/spa/service/output_v4/searchdatacsv/request/search/<id>
• キー
キー 必須 値 備考
id 検索対象のフォルダーの ID
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"searchDocsType": "hitPages",
"searchCondition": {
"searchWord": "type == 1",
"operator": "AND",
"recursive": true,
"conditions": [
{
"conditionType": "system",
"name": "name",
"value": "document.pdf",
第 1 章 SPA Web API リファレンス
564
オブジェクトの例(JSON 形式)
"type": "equals"
},
{
"conditionType": "system",
"name": "filetype",
"value": "file"
},
{
"conditionType": "svfField",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "date",
"dateFormat": 1,
"from": "19700101090000",
"to": "19700101180000",
"offset": "9"
},
{
"conditionType": "details",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "numeric",
"detailsConditions": [
{
"min": "1",
"max": "10"
},
{
"min": "100",
"max": "110"
}
第 1 章 SPA Web API リファレンス
565
オブジェクトの例(JSON 形式)
]
},
{
"conditionType": "pageContent",
"name": "annotation",
"value": "annotation text",
"type": "contains",
"exact": "true"
}
]
},
"headerNameType": "searchName",
"outputMethod": "splitFile",
"splitFileLimitBreak": 10000,
"outputColumns": [
{
"type": "page",
"name": "formName"
},
{
"type": "system",
"name": "title"
},
{
"type": "page",
"name": "pageNumber"
}
],
"bom": "true",
"zipFileName": "comp001.zip",
"zipEncoding": "MS932"
}
第 1 章 SPA Web API リファレンス
566
■ データ内容
キー 必須 値 備考
documentIds 文字列 検索でヒットした文書の中から CSV ファイルにデータを出力する文
書の文書 ID を指定します。複数の文書 ID を指定する場合は、リス
トで指定します。
指定されていない場合は、検索でヒットしたすべての文書が対象に
なります。
searchDocsType allPages 文書の全ページのデータを出力します。「documentIds」で文書を
選択した場合にのみ有効です。
指定がされていない場合は、allPages が指定されたものとします。
hitPages 検索でヒットしたページのデータのみを出力します。
「documentIds」で文書を選択した場合にのみ有効です。
hitRows 検索でヒットした明細行のデータのみを出力します。
「documentIds」で文書を選択した場合にのみ有効です。
searchContition 検索条件です。必ず指定する必要があります。
searchWord (*1) 文字列 全文検索の対象となる文字列を指定します。
operator AND conditions 要素の各検索条件の連結方法を「すべてに一致」としま
す。
指定されていない場合は、AND が指定されたものとします。
OR conditions 要素の各検索条件の連結方法を「いずれかに一致」とし
ます。
recursive true サブフォルダーも検索します。
指定されていない場合は、true が指定されたものとします。
false サブフォルダーは検索しません。
conditions (*1) 各検索条件のリスト
検索条件の種類は、conditionType の値で指定します。
• system
文書プロパティ
• custom
カスタムプロパティ
• svfField
SVF 検索フィールド
第 1 章 SPA Web API リファレンス
567
キー 必須 値 備考
• details
明細検索
• pageContent
ページコンテンツ(注釈、ページメモ)
headerNameType searchName ヘッダーに SVF 検索フィールドの検索名を出力します。
指定されていない場合は、serchName が指定されたものとします。
svfField ヘッダーに SVF 検索フィールド名を出力します。
outputMethod splitFile 文書定義および SVF 検索フィールドの様式名ごとに CSV ファイルを
分割して、SVF 検索フィールドデータを出力します。
指定されていない場合は、splitFile が指定されたものとします。
svfUcx CSV ファイルを分割しません。様式名の切り替え情報(Universal
Connect/X で使用する CSV ファイルで様式ファイルを切り替えると
きの形式)を出力した上で連続して SVF 検索フィールドデータを出
力します。
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 1,SVF 検索フィールド 2
データ 1,データ 2
データ 3,データ 4
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 3
データ 5
データ 6
splitFileLimitBreak (*2) 数値 1 ファイルに出力できる最大行数を 0~2147483647 までで指定しま
す。0 を指定した場合は無制限となります。
outputMethod で splitFile が指定された場合にのみ指定は有効で
す。
outputColumns CSV ファイルに追加で出力する項目
第 1 章 SPA Web API リファレンス
568
キー 必須 値 備考
type 文字列 追加で出力する項目のタイプを以下から指定します。
• general
全般
• system
PDF プロパティ
• page
ページ(SVF 検索フィールドデータの CSV ファイル出力で使用
する専用の項目)
• custom
カスタムプロパティ
name 文字列 項目のタイプに応じた名称または ID を指定します。
• type に general を指定した場合
「全般の name キーの値(P.551)」を参照してください。
• type に system を指定した場合
「PDF プロパティの name キーの値(P.553)」を参照してくだ
さい。
• type に page を指定した場合
「ページの name キーの値(P.553)」を参照してください。
• type に custom を指定した場合
出力するカスタムプロパティの ID を指定します。
bom true BOM を付加した CSV ファイルを出力します。
指定されていない場合は、true が指定されたものとします。
false BOM を付加しない CSV ファイルを出力します。
zipFileName 文字列 圧縮ファイルのファイル名を指定します。
zipEncoding 文字列 圧縮ファイルに含む CSV ファイル名のエンコーディングを指定しま
す。
指定されていない場合は、UTF-8 が指定されたものとします。
*1 どちらか 1 つの指定が必須です。
*2 outputMethod に「splitFile」を指定した場合に必須です。
第 1 章 SPA Web API リファレンス
569
• 文書プロパティの検索条件の指定方法について
文書プロパティの検索条件で指定する name キーの値は、次のとおりです。
name キーの
値
詳細条件の種類 備考
name ファイル名 value キーに検索の対象となる文字列を指定します。
filetype 種類 value キーを指定します。指定できるキーは次のとおりです。指
定されていない場合は、file が指定されたものとします。
• file
PDF ファイルと PDF ファイル以外のファイルです。
• link
リンク
• pagelink
ページリンク
• multilink
マルチリンク
archivedate 初回アーカイブの日時 日時の開始と終了、または、いずれか一方を指定できます。
archiveuser 初回アーカイブしたユ
ーザーの ID
value キーに検索の対象となる文字列を指定します。
updatedate アーカイブ(上書きア
ーカイブ含む)された
日時
日時の開始と終了、または、いずれか一方を指定できます。
updateuser アーカイブ(上書きア
ーカイブ含む)したユ
ーザーの ID
value キーに検索の対象となる文字列を指定します。
pagecount ページ数 数値の最小値と最大値、または、いずれか一方を指定できます。
size ファイルサイズ(KB) 数値の最小値と最大値、または、いずれか一方を指定できます。
title タイトル value キーに検索の対象となる文字列を指定します。
subject サブタイトル value キーに検索の対象となる文字列を指定します。
keywords キーワード value キーに検索の対象となる文字列を指定します。
author PDF 作成者 value キーに検索の対象となる文字列を指定します。
creator 作成アプリケーション value キーに検索の対象となる文字列を指定します。
第 1 章 SPA Web API リファレンス
570
name キーの
値
詳細条件の種類 備考
producer PDF 変換 value キーに検索の対象となる文字列を指定します。
createdate PDF 作成日時 日時の開始と終了、または、いずれか一方を指定できます。
modifydate PDF 更新日時 日時の開始と終了、または、いずれか一方を指定できます。
doctype_id 文書定義管理 ID value キーに検索の対象となる文書定義管理 ID を指定します。
comment 文書のコメント value キーに検索の対象となる文字列を指定します。
review_status レビューステータス value キーに次の文字列で指定します。
• 0
起票前
• 1
起票
• 2
処理中
• 3
完了
選択した name キーによって、検索条件として指定できるキーは異なります。「 」は、指定できるこ
とを示します。「 」については「type キー(P.571)」を参照してください。空欄は指定できないこと
を示します。
name キーの値 指定可能なキー
value from to min max type exact empty
name
filetype
archivedate
archiveuser
updatedate
updateuser
pagecount
size
title
第 1 章 SPA Web API リファレンス
571
name キーの値 指定可能なキー
value from to min max type exact empty
subject
keywords
author
creator
producer
createdate
modifydate
doctype_id
comment
review_status
○ from/to キー
日時指定のフォーマットは、DateFormat クラスで解析可能な「yyyy-MM-dd'T'HH:mm:ss.SSSZ」
形式で記述してください。
例
2016-07-17T07:25:48.000+0900
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
第 1 章 SPA Web API リファレンス
572
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
• SVF 検索フィールドの検索条件の指定方法について
SVF 検索フィールドの検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定
します。
name キーの値 dataType キーの値 備考
SVF 検索フィー
ルドの検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できます。
text value キーに検索の対象となる文字列を指定します。
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定可能なキーは異なります。「 」は、指定できることを示し
ます。「 」については「type キー(P.573)」を参照してください。空欄は指定できないことを示しま
す。
dataTyp
e
キーの値
指定可能なキー
docTypeI
d
formNam
e
fro
m
t
o
mi
n
ma
x
valu
e
typ
e
dateForma
t
exac
t
offse
t
anyValu
e
numeric
text
date
○ docTypeID キー
SVF 検索フィールドの検索において利用する文書定義管理 ID を指定します。docTypeId キー自体
を記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された
場合は、文書定義管理 ID の指定なしとして検索します。また、値に null が指定された場合は、文
書定義管理 ID の横断検索を行います。
○ formName キー
第 1 章 SPA Web API リファレンス
573
SVF 検索フィールドの検索において利用する様式ファイル名を指定します。formName キー自体を
記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された場
合は、様式ファイル名の「指定なし」として検索します。また、値に null が指定された場合は、様
式ファイル名の横断検索を行います。
○ from/to キー(SVF 検索フィールドの検索条件)
日時指定のフォーマットについては、「dateFormat キー(P.573)」を参照してください。文書プロパ
ティの日時指定と異なるので注意が必要です。
○ min/max キー(SVF 検索フィールドの検索条件)
指定可能な数値の範囲は、-9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)です。
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ dateFormat キー
from キーや to キーの値を指定する際のフォーマットを指定します。以下の 1 から 7 までの 7 種類
の数値が指定できます。この値は、検索対象の SVF 検索フィールドの日付のフォーマットと一致し
ている必要があります。
指定できる値 備考
1 yyyyMMddHHmmss(年月日時分秒)
2 yyyyMMddHHmm(年月日時分)
3 yyyyMMdd(年月日)
4 MMddHHmm(月日時分)
第 1 章 SPA Web API リファレンス
574
指定できる値 備考
5 MMdd(月日)
6 HHmmss(時分秒)
7 HHmm(時分)
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
SVF 検索フィールドでは常に値が存在するため、「値が存在しないこと」を条件とする empty キー
は指定できません。
○ offset キー
SVF 検索フィールドの dataType キーの値が「date」の場合、かつ、dateFormat キーの値が「1」
または「2」のとき(つまり、年月日時分秒または年月日時分を使った日時検索のとき)、指定した
日時にタイムゾーンも考慮して検索を行いたい場合に指定します。
指定できる値は、協定世界時との差(UTC offset)の数値(-12 から 14 まで)です。
■ 指定例
▫ 日本は、UTC +9:00 なので「offset=9」
▫ ベネズエラは、UTC -4:30 なので「offset=-4.5」
▫ ニュージーランドのチャタム諸島は、UTC +12:45 なので、「offset=12.75」
■ 詳細説明
SVF 検索フィールドの日付型のデータには、内部的に「タイムゾーンつき」のデータと「タイム
ゾーンなし」のデータの 2 種類が存在しています。offset キーを指定しない場合は、「タイムゾ
ーンなし」の日付型データのみを検索対象とし、offset キーを指定すると、「タイムゾーンな
し」と「タイムゾーンつき」の両方の日付型データを検索対象とします。
■ 検索例
▫ offset キーなし
from="20141011103000" to="20141022235959" (2014 年 10 月 11 日 10 時 30 分 00 秒か
ら 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンなし」のデー
タから上記の期間に該当するデータを抽出します。
第 1 章 SPA Web API リファレンス
575
▫ offset キーつき
from="20141011103000" to="20141022235959" offset="9" (2014 年 10 月 11 日 10 時 30
分 00 秒から 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンな
し」のデータから上記の期間に該当するデータを抽出し、「タイムゾーンつき」のデータから
も上記の期間に該当するデータを抽出します。
日本標準時(JST)の「2014-10-22T23:59:59.000+0900」(「2014-10-22T14:59:59.000+0000」
と同じ)で登録されている「タイムゾーンつき」データが抽出されます。
米国カリフォルニア(太平洋標準時(PST))の「2014-10-22T06:59:59.000-0800」(「2014-10-
22T14:59:59.000+0000」と同じ)で登録されている「タイムゾーンつき」データが抽出され
ます。
○ anyValue キー
指定可能な値は「true」のみです。
指定された項目に値が存在するものを抽出します。「true」に指定された場合には、他の検索用キー
の指定の有無にかかわらず、値の有無だけが抽出の条件となります。
• 明細検索の検索条件の指定方法について
明細検索の検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定します。基
本的には SVF 検索フィールドと同様のキーを指定しますが、検索条件に関する部分については
detailsConditions キーの値として複数指定できます。
name キーの値 dataType キーの値 備考
SVF 検索フィー
ルドの検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できます。
text value キーに検索の対象となる文字列を指定します。
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定できるキーが異なります。「 」は、指定できることを示
します。空欄は指定できないことを示します。
dataType キーの
値
指定可能なキー
docTypeId formName dateFormat offset datailsConditions
numeric
text
date
○ detailsConditions キー
第 1 章 SPA Web API リファレンス
576
detailsConditions キーには、検索条件をリストで指定します。detailsConditions キー内に指定す
るキーは、次のとおりです。
「 」は、指定できることを示します。「 」については「type キー(P.577)」を参照してくださ
い。空欄は指定できないことを示します。
dataType キーの値 指定可能なキー
from to min max value type exact
numeric *1
text *2
date *3
■ *1 数値の最小値と最大値、または、いずれか一方を指定できます。
■ *2 value キーに検索の対象となる文字列を指定します。
■ *3 日時の開始と終了、または、いずれか一方を指定できます。
• カスタムプロパティの検索条件の指定方法について
カスタムプロパティの検索条件で指定する id キーの値には、カスタムプロパティのデータの型を指定
します。
id キーの値 カスタムプロパティの
データの型
備考
カスタムプロパ
ティ ID
数値型 数値の最小値と最大値、または、いずれか一方を指定できます。
文字列型 value キーに検索の対象となる文字列を指定します。
日付型 日時の開始と終了、または、いずれか一方を指定できます。
Boolean 型 true/false のどちらかを指定できます。
ハイパーリンク型 value キーに検索の対象となる文字列を指定します。
選択したカスタムプロパティのデータの型により、指定できるキーは異なります。「 」は、指定でき
ることを示します。「 」については「type キー(P.577)」を参照してください。空欄は指定できない
ことを示します。
カスタムプロパティのデータの型 指定可能なキー
from to min max value type exact empty
数値型
文字列型
日付型
第 1 章 SPA Web API リファレンス
577
カスタムプロパティのデータの型 指定可能なキー
from to min max value type exact empty
Boolean 型
ハイパーリンク型
○ from/to キー
日付指定のフォーマットについては、「dateFormat キー(P.573)」を参照してください。文書プロパ
ティの日時指定と異なるので注意が必要です。
○ min/max キー
数値の種類により指定可能な範囲は異なります。
数値の種類 指定可能な範囲
整数のみの数値 -9,223,372,036,854,775,808~9,223,372,036,854,775,807
小数を含んだ数値 -9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)
小数点には「.(ピリオド)」のみ使用できます。
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
第 1 章 SPA Web API リファレンス
578
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
• ページコンテンツの検索条件の指定方法について
ページコンテンツの検索条件で指定する name キーの値は、次のとおりです。
name キーの
値
検索対象 備考
annotation 注釈 value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指
定した文字列そのもので検索します。
pagememo ページメモ value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指
定した文字列そのもので検索します。
選択した name キーによって、検索条件として指定できるキーは異なります。「 」は、指定できるこ
とを示します。空欄は指定できないことを示します。
name キーの値 指定可能なキー
value type exact empty
annotation
pagememo
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
第 1 章 SPA Web API リファレンス
579
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在し
なかった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新を
しようとした場合に出力されます。
400 -707 全文検索機能がオフに設定されている状態で、全文検索または文書内検索を実
行しようとした場合に発生します。
第 1 章 SPA Web API リファレンス
580
HTTP ステータス エラーコード 備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20703 全文検索の検索条件に 1,025 バイト以上の文字を指定した場合、または、文書
内検索の検索条件に 257 バイト以上の文字列を指定した場合に出力されます。
400 -20705 全文検索の対象となる文字列の指定に問題がある場合に出力されます。
400 -20706 検索条件の指定において、括弧の使い方が正しくない場合に出力されます。
400 -20707 検索条件の指定において、ダブルクォーテーションが閉じられていない場合に
出力されます。
400 -20708 検索条件の指定において、演算子の位置が誤っている場合に出力されます。
400 -20709 全文検索以外の検索文字列で最大文字数(256)を超えている、検索条件の指
定が 1 つもないなどの場合に出力されます。最小値が最大値よりも大きい場
合、日時の指定形式に誤りがある場合にも出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。指定された日付のフォ
ーマット(dateFormat キー)の値と、指定された日時の値の組み合わせが正
しくない場合などです。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
正常に受付された場合の出力例(JSON 形式)
{
"requestId": "100001"
}
■ データ内容
キー 値 備考
requestId 文字列 CSV データ作成処理の受付番号です。
この ID が、ステータス取得や生成後の Zip 圧縮ファイルの取得のキーとなります。
第 1 章 SPA Web API リファレンス
581
Request Search Data Csv From Search
Results(Ver. 5) 検索でヒットした文書内にある SVF 検索フィールドデータを対象として、CSV データの作成を依頼します。
本 Web API は、Ver. 10.1 以降で利用できます。
URI
http://<hostname>:44230/spa/service/output_v5/searchdatacsv/request/search/<id>
• キー
キー 必須 値 備考
id 検索対象のフォルダーの ID
HTTP メソッド
POST
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"searchDocsType": "hitPages",
"searchCondition": {
"searchWord": "type == 1",
"operator": "AND",
"recursive": true,
"conditions": [
{
"conditionType": "system",
"name": "name",
第 1 章 SPA Web API リファレンス
582
オブジェクトの例(JSON 形式)
"value": "document.pdf",
"type": "equals"
},
{
"conditionType": "system",
"name": "filetype",
"value": "file"
},
{
"conditionType": "svfField",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "date",
"dateFormat": 1,
"from": "19700101090000",
"to": "19700101180000",
"offset": "9"
},
{
"conditionType": "details",
"name": "field1",
"docTypeId": "1",
"formName": "form1",
"dataType": "numeric",
"detailsConditions": [
{
"min": "1",
"max": "10"
},
{
"min": "100",
"max": "110"
第 1 章 SPA Web API リファレンス
583
オブジェクトの例(JSON 形式)
}
]
},
{
"conditionType": "pageContent",
"name": "annotation",
"value": "annotation text",
"type": "contains",
"exact": "true"
}
]
},
"headerNameType": "searchName",
"outputMethod": "splitFile",
"splitFileLimitBreak": 10000,
"outputColumns": [
{
"type": "page",
"name": "formName"
},
{
"type": "system",
"name": "title"
},
{
"type": "page",
"name": "pageNumber"
}
],
"bom": "true",
"zipFileName": "comp001.zip",
"zipEncoding": "MS932"
"useRawData": true,
第 1 章 SPA Web API リファレンス
584
オブジェクトの例(JSON 形式)
"removeEmptyLines": true
}
■ データ内容
キー 必須 値 備考
documentIds 文字列 検索でヒットした文書の中から CSV ファイルにデータを出力する文
書の文書 ID を指定します。複数の文書 ID を指定する場合は、リス
トで指定します。
指定されていない場合は、検索でヒットしたすべての文書が対象に
なります。
searchDocsType allPages 文書の全ページのデータを出力します。「documentIds」で文書を
選択した場合にのみ有効です。
指定がされていない場合は、allPages が指定されたものとします。
hitPages 検索でヒットしたページのデータのみを出力します。
「documentIds」で文書を選択した場合にのみ有効です。
hitRows 検索でヒットした明細行のデータのみを出力します。
「documentIds」で文書を選択した場合にのみ有効です。
searchContition 検索条件です。必ず指定する必要があります。
searchWord (*1) 文字列 全文検索の対象となる文字列を指定します。
operator AND conditions 要素の各検索条件の連結方法を「すべてに一致」としま
す。
指定されていない場合は、AND が指定されたものとします。
OR conditions 要素の各検索条件の連結方法を「いずれかに一致」とし
ます。
recursive true サブフォルダーも検索します。
指定されていない場合は、true が指定されたものとします。
false サブフォルダーは検索しません。
conditions (*1) 各検索条件のリスト
検索条件の種類は、conditionType の値で指定します。
• system
文書プロパティ
第 1 章 SPA Web API リファレンス
585
キー 必須 値 備考
• custom
カスタムプロパティ
• svfField
SVF 検索フィールド
• details
明細検索
• pageContent
ページコンテンツ(注釈、ページメモ)
headerNameType searchName ヘッダーに SVF 検索フィールドの検索名を出力します。
指定されていない場合は、serchName が指定されたものとしま
す。
svfField ヘッダーに SVF 検索フィールド名を出力します。
outputMethod splitFile 文書定義および SVF 検索フィールドの様式名ごとに CSV ファイル
を分割して、SVF 検索フィールドデータを出力します。
指定されていない場合は、splitFile が指定されたものとします。
svfUcx CSV ファイルを分割しません。様式名の切り替え情報(Universal
Connect/X で使用する CSV ファイルで様式ファイルを切り替えると
きの形式)を出力した上で連続して SVF 検索フィールドデータを出
力します。
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 1,SVF 検索フィールド 2
データ 1,データ 2
データ 3,データ 4
<start>
vrsetform=xxxxxxxxxxx
<end>
SVF 検索フィールド 3
データ 5
データ 6
第 1 章 SPA Web API リファレンス
586
キー 必須 値 備考
splitFileLimitBreak (*2) 数値 1 ファイルに出力できる最大行数を 0~2147483647 までで指定しま
す。0 を指定した場合は無制限となります。
outputMethod で splitFile が指定された場合にのみ指定は有効で
す。
outputColumns CSV ファイルに追加で出力する項目
type 文字列 追加で出力する項目のタイプを以下から指定します。
• general
全般
• system
PDF プロパティ
• page
ページ(SVF 検索フィールドデータの CSV ファイル出力で使
用する専用の項目)
• custom
カスタムプロパティ
name 文字列 項目のタイプに応じた名称または ID を指定します。
• type に general を指定した場合
「全般の name キーの値(P.551)」を参照してください。
• type に system を指定した場合
「PDF プロパティの name キーの値(P.553)」を参照してくだ
さい。
• type に page を指定した場合
「ページの name キーの値(P.553)」を参照してください。
• type に custom を指定した場合
出力するカスタムプロパティの ID を指定します。
bom true BOM を付加した CSV ファイルを出力します。
指定されていない場合は、true が指定されたものとします。
false BOM を付加しない CSV ファイルを出力します。
zipFileName 文字列 圧縮ファイルのファイル名を指定します。
第 1 章 SPA Web API リファレンス
587
キー 必須 値 備考
zipEncoding 文字列 圧縮ファイルに含む CSV ファイル名のエンコーディングを指定しま
す。
指定されていない場合は、UTF-8 が指定されたものとします。
useRawData true Ver. 10.0 までの出力形式です。SPA に取り込まれたデータがそのま
ま出力されます。たとえば、日付型の SVF 検索フィールドに
「2019/02/30」というデータがある場合、「2019/02/30」が出力さ
れます。
false SPA に取り込まれたデータが、フィールドに設定されているデータ
型(文字列、日付、数値)に応じて型変換されて出力されます。た
とえば、日付型の SVF 検索フィールドに「2019/02/30」というデー
タがある場合、SPA が行う有効な日付かどうかの判定において無効
な日付であると判断され、""(空)が出力されます。
指定されていない場合は、false が指定されたものとします。
removeEmptyLines true Ver. 10.0 までの出力形式です。明細データにおいて、データが存在
する最後の行までが出力されます。最終行以降のデータが存在しな
い行(空行)は出力されません。
false 明細データにおいて、データが存在する行だけでなく、データが存
在する最後の行以降にあるデータが存在しない行(空行)も出力さ
れます。
指定されていない場合は、false が指定されたものとします。
*1 どちらか 1 つの指定が必須です。
*2 outputMethod に「splitFile」を指定した場合に必須です。
• 文書プロパティの検索条件の指定方法について
文書プロパティの検索条件で指定する name キーの値は、次のとおりです。
name キーの値 詳細条件の種類 備考
name ファイル名 value キーに検索の対象となる文字列を指定します。
filetype 種類 value キーを指定します。指定できるキーは次のとおりです。
指定されていない場合は、file が指定されたものとします。
• file
PDF ファイルと PDF ファイル以外のファイルです。
• link
リンク
第 1 章 SPA Web API リファレンス
588
name キーの値 詳細条件の種類 備考
• pagelink
ページリンク
• multilink
マルチリンク
archivedate 初回アーカイブの日時 日時の開始と終了、または、いずれか一方を指定できます。
archiveuser 初回アーカイブしたユーザーの ID
value キーに検索の対象となる文字列を指定します。
updatedate アーカイブ(上書きアー
カイブ含む)された日時
日時の開始と終了、または、いずれか一方を指定できます。
updateuser アーカイブ(上書きアー
カイブ含む)したユーザ
ーの ID
value キーに検索の対象となる文字列を指定します。
pagecount ページ数 数値の最小値と最大値、または、いずれか一方を指定できます。
size ファイルサイズ(KB) 数値の最小値と最大値、または、いずれか一方を指定できます。
title タイトル value キーに検索の対象となる文字列を指定します。
subject サブタイトル value キーに検索の対象となる文字列を指定します。
keywords キーワード value キーに検索の対象となる文字列を指定します。
author PDF 作成者 value キーに検索の対象となる文字列を指定します。
creator 作成アプリケーション value キーに検索の対象となる文字列を指定します。
producer PDF 変換 value キーに検索の対象となる文字列を指定します。
createdate PDF 作成日時 日時の開始と終了、または、いずれか一方を指定できます。
modifydate PDF 更新日時 日時の開始と終了、または、いずれか一方を指定できます。
doctype_id 文書定義管理 ID value キーに検索の対象となる文書定義管理 ID を指定します。
comment 文書のコメント value キーに検索の対象となる文字列を指定します。
review_status レビューステータス value キーに次の文字列で指定します。
• 0
起票前
• 1
起票
第 1 章 SPA Web API リファレンス
589
name キーの値 詳細条件の種類 備考
• 2
処理中
• 3
完了
選択した name キーによって、検索条件として指定できるキーは異なります。「 」は、指定できるこ
とを示します。「 」については「type キー(P.590)」を参照してください。空欄は指定できないこと
を示します。
name キーの値 指定可能なキー
value from to min max type exact empty
name
filetype
archivedate
archiveuser
updatedate
updateuser
pagecount
size
title
subject
keywords
author
creator
producer
createdate
modifydate
doctype_id
comment
review_status
第 1 章 SPA Web API リファレンス
590
○ from/to キー
日時指定のフォーマットは、DateFormat クラスで解析可能な「yyyy-MM-dd'T'HH:mm:ss.SSSZ」
形式で記述してください。
例
2016-07-17T07:25:48.000+0900
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
• SVF 検索フィールドの検索条件の指定方法について
SVF 検索フィールドの検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定
します。
name キーの値 dataType キーの値 備考
SVF 検索フィー
ルドの検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できます。
text value キーに検索の対象となる文字列を指定します。
第 1 章 SPA Web API リファレンス
591
name キーの値 dataType キーの値 備考
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定可能なキーは異なります。「 」は、指定できることを示し
ます。「 」については「type キー(P.591)」を参照してください。空欄は指定できないことを示しま
す。
dataTyp
e
キーの値
指定可能なキー
docTypeI
d
formNam
e
fro
m
t
o
mi
n
ma
x
valu
e
typ
e
dateForma
t
exac
t
offse
t
anyValu
e
numeric
text
date
○ docTypeID キー
SVF 検索フィールドの検索において利用する文書定義管理 ID を指定します。docTypeId キー自体
を記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された
場合は、文書定義管理 ID の指定なしとして検索します。また、値に null が指定された場合は、文
書定義管理 ID の横断検索を行います。
○ formName キー
SVF 検索フィールドの検索において利用する様式ファイル名を指定します。formName キー自体を
記述しなかった場合は、値に null が指定されたものとして扱います。値に空文字列が指定された場
合は、様式ファイル名の「指定なし」として検索します。また、値に null が指定された場合は、様
式ファイル名の横断検索を行います。
○ from/to キー(SVF 検索フィールドの検索条件)
日時指定のフォーマットについては、「dateFormat キー(P.592)」を参照してください。文書プロパ
ティの日時指定と異なるので注意が必要です。
○ min/max キー(SVF 検索フィールドの検索条件)
指定可能な数値の範囲は、-9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)です。
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
第 1 章 SPA Web API リファレンス
592
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ dateFormat キー
from キーや to キーの値を指定する際のフォーマットを指定します。以下の 1 から 7 までの 7 種類
の数値が指定できます。この値は、検索対象の SVF 検索フィールドの日付のフォーマットと一致し
ている必要があります。
指定できる値 備考
1 yyyyMMddHHmmss(年月日時分秒)
2 yyyyMMddHHmm(年月日時分)
3 yyyyMMdd(年月日)
4 MMddHHmm(月日時分)
5 MMdd(月日)
6 HHmmss(時分秒)
7 HHmm(時分)
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
SVF 検索フィールドでは常に値が存在するため、「値が存在しないこと」を条件とする empty キー
は指定できません。
○ offset キー
SVF 検索フィールドの dataType キーの値が「date」の場合、かつ、dateFormat キーの値が「1」
または「2」のとき(つまり、年月日時分秒または年月日時分を使った日時検索のとき)、指定した
日時にタイムゾーンも考慮して検索を行いたい場合に指定します。
第 1 章 SPA Web API リファレンス
593
指定できる値は、協定世界時との差(UTC offset)の数値(-12 から 14 まで)です。
■ 指定例
▫ 日本は、UTC +9:00 なので「offset=9」
▫ ベネズエラは、UTC -4:30 なので「offset=-4.5」
▫ ニュージーランドのチャタム諸島は、UTC +12:45 なので、「offset=12.75」
■ 詳細説明
SVF 検索フィールドの日付型のデータには、内部的に「タイムゾーンつき」のデータと「タイム
ゾーンなし」のデータの 2 種類が存在しています。offset キーを指定しない場合は、「タイムゾ
ーンなし」の日付型データのみを検索対象とし、offset キーを指定すると、「タイムゾーンな
し」と「タイムゾーンつき」の両方の日付型データを検索対象とします。
■ 検索例
▫ offset キーなし
from="20141011103000" to="20141022235959" (2014 年 10 月 11 日 10 時 30 分 00 秒か
ら 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンなし」のデー
タから上記の期間に該当するデータを抽出します。
▫ offset キーつき
from="20141011103000" to="20141022235959" offset="9" (2014 年 10 月 11 日 10 時 30
分 00 秒から 2014 年 10 月 22 日 23 時 59 分 59 秒)で検索を行った場合、「タイムゾーンな
し」のデータから上記の期間に該当するデータを抽出し、「タイムゾーンつき」のデータから
も上記の期間に該当するデータを抽出します。
日本標準時(JST)の「2014-10-22T23:59:59.000+0900」(「2014-10-22T14:59:59.000+0000」
と同じ)で登録されている「タイムゾーンつき」データが抽出されます。
米国カリフォルニア(太平洋標準時(PST))の「2014-10-22T06:59:59.000-0800」(「2014-10-
22T14:59:59.000+0000」と同じ)で登録されている「タイムゾーンつき」データが抽出され
ます。
○ anyValue キー
指定可能な値は「true」のみです。
指定された項目に値が存在するものを抽出します。「true」に指定された場合には、他の検索用キー
の指定の有無にかかわらず、値の有無だけが抽出の条件となります。
• 明細検索の検索条件の指定方法について
第 1 章 SPA Web API リファレンス
594
明細検索の検索条件で指定する name キーの値には、SVF 検索フィールドの検索名を指定します。基
本的には SVF 検索フィールドと同様のキーを指定しますが、検索条件に関する部分については
detailsConditions キーの値として複数指定できます。
name キーの値 dataType キーの値 備考
SVF 検索フィールドの検索名
numeric 数値の最小値と最大値、または、いずれか一方を指定できます。
text value キーに検索の対象となる文字列を指定します。
date 日時の開始と終了、または、いずれか一方を指定できます。
選択した dataType キーの値により、指定できるキーが異なります。「 」は、指定できることを示し
ます。空欄は指定できないことを示します。
dataType キーの
値
指定可能なキー
docTypeId formName dateFormat offset datailsConditions
numeric
text
date
○ detailsConditions キー
detailsConditions キーには、検索条件をリストで指定します。detailsConditions キー内に指定す
るキーは、次のとおりです。
「 」は、指定できることを示します。「 」については「type キー(P.595)」を参照してくださ
い。空欄は指定できないことを示します。
dataType キーの値 指定可能なキー
from to min max value type exact
numeric *1
text *2
date *3
■ *1 数値の最小値と最大値、または、いずれか一方を指定できます。
■ *2 value キーに検索の対象となる文字列を指定します。
■ *3 日時の開始と終了、または、いずれか一方を指定できます。
• カスタムプロパティの検索条件の指定方法について
カスタムプロパティの検索条件で指定する id キーの値には、カスタムプロパティのデータの型を指定
します。
第 1 章 SPA Web API リファレンス
595
id キーの値 カスタムプロパティの
データの型
備考
カスタムプロ
パティ ID
数値型 数値の最小値と最大値、または、いずれか一方を指定できます。
文字列型 value キーに検索の対象となる文字列を指定します。
日付型 日時の開始と終了、または、いずれか一方を指定できます。
Boolean 型 true/false のどちらかを指定できます。
ハイパーリンク型 value キーに検索の対象となる文字列を指定します。
選択したカスタムプロパティのデータの型により、指定できるキーは異なります。「 」は、指定でき
ることを示します。「 」については「type キー(P.595)」を参照してください。空欄は指定できない
ことを示します。
カスタムプロパティのデータの型 指定可能なキー
from to min max value type exact empty
数値型
文字列型
日付型
Boolean 型
ハイパーリンク型
○ from/to キー
日付指定のフォーマットについては、「dateFormat キー(P.592)」を参照してください。文書プロパ
ティの日時指定と異なるので注意が必要です。
○ min/max キー
数値の種類により指定可能な範囲は異なります。
数値の種類 指定可能な範囲
整数のみの数値 -9,223,372,036,854,775,808~9,223,372,036,854,775,807
小数を含んだ数値 -9,999,999,999,999,999,999.99999999999999999999~
9,999,999,999,999,999,999.99999999999999999999(整数部 19 桁、小数部 20 桁)
小数点には「.(ピリオド)」のみ使用できます。
○ type キー
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
第 1 章 SPA Web API リファレンス
596
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
印のある項目(データが日時または数値の場合)は、not のみが指定できます。
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
• ページコンテンツの検索条件の指定方法について
ページコンテンツの検索条件で指定する name キーの値は、次のとおりです。
name キーの
値
検索対象 備考
annotation 注釈 value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指定した文字列そのもので検索します。
pagememo ページメモ value キーに検索の対象となる文字列を指定します。全文検索とは異なり、指定した文字列そのもので検索します。
選択した name キーによって、検索条件として指定できるキーは異なります。「 」は、指定できる
ことを示します。空欄は指定できないことを示します。
name キーの値 指定可能なキー
value type exact empty
annotation
pagememo
○ type キー
第 1 章 SPA Web API リファレンス
597
文字列の検索方法または期限や範囲の否定を指定します。「 」のある項目(データが文字列の場
合)は、以下の値が指定できます。指定されていない場合は、equals が指定されたものとします。
type キーの値 説明
equals と一致する
contains を含む
startswith で始まる
endswith で終わる
notequals と一致しない
notcontains を含まない
○ exact キー
文字列を対象に、完全一致の検索を行うかどうかを指定します。完全一致の検索を行う場合
「true」を指定します。「false」が指定されると、大文字/小文字を区別しないあいまいな検索が可
能になります。指定されていない場合は、「false」が指定されたものとします。
○ empty キー
指定可能な値は true のみです。指定された項目に値が存在しないものを抽出します。この値が
true に指定された場合には、他の検索用キーの指定があっても、値の有無だけを見るようになりま
す。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
第 1 章 SPA Web API リファレンス
598
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -451 カスタムプロパティの更新、削除、値の取得の際、対象のプロパティが存在しな
かった場合に出力されます。
403 -461 表示する設定になっていないカスタムプロパティに対して、値の取得や更新をし
ようとした場合に出力されます。
400 -707 全文検索機能がオフに設定されている状態で、全文検索または文書内検索を実行
しようとした場合に発生します。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20703 全文検索の検索条件に 1,025 バイト以上の文字を指定した場合、または、文書内
検索の検索条件に 257 バイト以上の文字列を指定した場合に出力されます。
400 -20705 全文検索の対象となる文字列の指定に問題がある場合に出力されます。
400 -20706 検索条件の指定において、括弧の使い方が正しくない場合に出力されます。
400 -20707 検索条件の指定において、ダブルクォーテーションが閉じられていない場合に出
力されます。
400 -20708 検索条件の指定において、演算子の位置が誤っている場合に出力されます。
400 -20709 全文検索以外の検索文字列で最大文字数(256)を超えている、検索条件の指定
が 1 つもないなどの場合に出力されます。最小値が最大値よりも大きい場合、日
時の指定形式に誤りがある場合にも出力されます。
400 -29001 パラメーターの指定に誤りがある場合に出力されます。指定された日付のフォー
マット(dateFormat キー)の値と、指定された日時の値の組み合わせが正しく
ない場合などです。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
599
▌出力例
正常に受付された場合の出力例(JSON 形式)
{
"requestId": "100001"
}
■ データ内容
キー 値 備考
requestId 文字列 CSV データ作成処理の受付番号です。
この ID が、ステータス取得や生成後の Zip 圧縮ファイルの取得のキーとなります。
第 1 章 SPA Web API リファレンス
600
Output Search Data Csv Status ログインしているユーザーの CSV データ作成状況の一覧を取得します。
URI
http://<hostname>:44230/spa/service/output/searchdatacsv/status
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
601
HTTP ステータ
ス
エラーコー
ド
備考
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"list": [
{
"status": 1,
"id": "1023",
"acceptDate": "2016-11-20T11:03:43.639+0900",
"endDate": "2016-11-20T15:06:45.349+0900",
"fileName": "comp001.zip",
"errorCode":"0",
"errorMessage":""
},
{
"status": 0,
"id": "1024",
"acceptDate": "2016-11-20T17:06:19.112+0900",
"endDate": "",
"fileName": "comp002.zip"
"errorCode":"",
"errorMessage":""
},
{
"status": 1
"id": "1025",
第 1 章 SPA Web API リファレンス
602
出力例(JSON 形式)
"acceptDate": "2016-11-20T12:05:43.639+0900",
"endDate": "2016-11-20T15:06:47.229+0900",
"fileName": "comp003.zip",
"errorCode":"-413",
"errorMessage":"一部のリンク元のページが存在しません。"
},
{
"status": 0,
"id": "1026",
"acceptDate": "2016-11-20T17:09:44.887+0900",
"endDate": "",
"fileName": "comp004.zip"
"errorCode":"",
"errorMessage":""
},
...
]
}
■ データ内容
キー 値 備考
list CSV データ作成状況のリスト
status 1 CSV データ作成済みです。
0 CSV データ作成中です。
id 文字列 CSV データ作成処理の受付番号です。
acceptDate 文字列 CSV データ作成処理の受付日時です。
ISO8601 RFC3339 W3CDTF(日付と時刻を T でつなげる)に準拠した文字列(例 "2016-
11-22T11:18:43.933+0900")で出力します。
endDate 文字列 CSV データ作成処理の完了日時です。正常終了またはエラー終了の日時です。
ISO8601 RFC3339 W3CDTF(日付と時刻を T でつなげる)に準拠した文字列(例 "2016-
11-22T11:18:43.933+0900")で出力します。
fileName 文字列 CSV データの作成依頼時に指定した圧縮ファイルのファイル名です。
第 1 章 SPA Web API リファレンス
603
キー 値 備考
errorCode 文字列 エラーコードです。
errorMessage 文字列 エラーメッセージです。
API を実行したユーザーの表示言語設定に従った言語で出力されます。
第 1 章 SPA Web API リファレンス
604
Output Search Data Csv Get 指定した受付番号に対応する、SVF 検索フィールドデータの CSV ファイル(ZIP ファイルに圧縮されたも
の)を取得します。
URI
http://<hostname>:44230/spa/service/output/searchdatacsv/<id>
• キー
キー 必須 値 備考
id CSV データ作成処理の受付番号
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
ダウンロードされるファイルは常に ZIP ファイルです。
■ レスポンスヘッダー
キー 値の内容 備考
Content-Disposition ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となる。
attachment; filename*=utf-8''{ファイル名の URL エンコード}
ファイル名が「data 1.zip」の場合
attachment; filename*=utf-8''data%201.zip
X-Spa-Error-Code エラーコード
第 1 章 SPA Web API リファレンス
605
キー 値の内容 備考
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。指定した受付番号のファイ
ルが、作業待ち、作業中、エラー終了などで存在しない場合です。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
607
Records List(Ver. 2) 指定された文書の追跡記録を取得します。
URI
http://<hostname>:44230/spa/service/record_v2/track/<id>
• キー
キー 必須 値 備考
id 取得したい文書の ID
HTTP メソッド
GET
▌パラメーター
キー 必
須
値 備考
limit 取得される情報の最大件数 指定がない場合、および、0 以下の数値を指定した場合は無制限となり
ます。
from 操作を開始した日時 「yyyy-MM-dd'T'HH:mm:ss.SSSZ」形式で指定します。
例:2013-07-17T07:25:48.000+0900
to 操作を終了した日時 「yyyy-MM-dd'T'HH:mm:ss.SSSZ」形式で指定します。
例:2013-07-17T07:25:48.000+0900
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
608
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"size": 10,
"records": [
{
"id": "1",
"documentId": "10",
"userId": "20",
"userName": "user",
第 1 章 SPA Web API リファレンス
609
出力例(JSON 形式)
"userFullname": "fullname",
"deleteUser": false,
"type": 6,
"note": "",
"recordDate": "2015-11-20T11:03:43.639+0900",
"folderPath": "",
"documentName": "",
"fileType": 0,
"appendix": "任意情報"
},
...
]
}
■ データ内容
キー 値 説明
size 数値 指定した条件に合致する追跡記録の総数です。
「limit」パラメーターで最大件数を指定した場合には、records 内に取得される追跡記録
の件数(最大件数)を超える場合があります。
records 追跡記録一覧(日付順)
追跡記録が存在しない場合は空配列が返ります。
id 文字列 追跡記録 ID です。
documentId 文字列 文書 ID です。
userId 文字列 ユーザーに割り当てられた一意の番号です。
システムが自動的に記録する操作は、userId: -1 です。
userName 文字列 ユーザー名です。
システムが自動的に記録する操作は、userName: ""です。
userFullname 文字列 ユーザーフルネームです。
システムが自動的に記録する操作は、userFullname: ""です。
deleteUser true ユーザーの状態が「すでに削除されたユーザー」です。
false ユーザーの状態が「現在も存在するユーザー」です。
第 1 章 SPA Web API リファレンス
610
キー 値 説明
システムが自動的に記録する操作は、deleteUser: false です。
type 1 記録種別が「作成」です。
リンクとマルチリンクが作成されたときも含みます。
2 記録種別が「削除」です(本 API では出力されません)。
3 記録種別が「移動」です。
4 記録種別が「上書き」です。
5 記録種別が「閲覧」です。
6 記録種別が「印刷」です。
7 記録種別が「ダウンロード」です。
8 記録種別が「注釈」です。
9 記録種別が「ページメモ」です。
10 記録種別が「自動マスク」です。
11 記録種別が「手動マスク」です。
12 記録種別が「プロパティ更新」です。
ファイル名変更、拡張属性(運用開始日、マスク番号、ロック、削除禁止、追跡記録、
削除記録)、カスタムプロパティ、文書メモが更新されたときに記録されます。
13 記録種別が「タイムスタンプ付与」です。
14 記録種別が「ごみ箱に移動」です。
15 記録種別が「ごみ箱から復元」です。
16 記録種別が「レビュー起票」です。
17 記録種別が「レビュー確認」です。
18 記録種別が「レビュー差し戻し」です。
19 記録種別が「レビュー完了」です。
20 記録種別が「レビュー開始」です。
21 記録種別が「レビュー削除」です。
22 記録種別が「レビュー取り消し」です。
23 記録種別が「検索結果へのマスク適用」です。
24 記録種別が「CSV ファイルの出力」です。
第 1 章 SPA Web API リファレンス
611
キー 値 説明
25 記録種別が「CSV ファイルのダウンロード」です。
26 記録種別が「バージョン更新」です。
27 記録種別が「復元」です。
28 記録種別が「SVF 検索フィールドの編集」です。
29 記録種別が「回転」です。
note 文字列 type によって内容が変わります。
• 5(閲覧)
バージョン番号(過去バージョンを閲覧した場合)
• 8(注釈)
更新されたページ番号(カンマ区切り)
• 9(ページメモ)
更新されたページ番号(カンマ区切り)
• 10(自動マスク)
マスク定義名
• 11(手動マスク)
マスク定義名とページ番号(複数の場合はカンマ区切り)
• 23(検索結果へのマスク適用)
マスクされたページ番号(複数の場合はカンマ区切り)
• 26(バージョン更新)
バージョン番号
• 27(復元)
バージョン番号(復元したバージョン番号)
• 28(SVF 検索フィールドの編集)
ページ番号,SVF 検索フィールド名,変更前の値,変更後の値(,行数)
○ 複数の SVF 検索フィールドを編集した場合は、上記の内容を複数個出力しま
す。
○ 明細行にある SVF 検索フィールドを編集した場合は「行数」を出力します。
• 29(回転)
第 1 章 SPA Web API リファレンス
612
キー 値 説明
ページ番号(全ページの場合は「all」)と回転についての情報(複数の場合はカン
マ区切り)
回転についての情報は、次のいずれかが出力されます。
○ 0
変更なし、または基準に戻す
○ 1
時計回りで 90 度を加算した角度(右へ 90 度回転)
○ 2
時計回りで 180 度を加算した角度(180 度回転)
○ 3
時計回りで 270 度を加算した角度(左へ 90 度回転)
• その他
出力なし
recordDate 文字列 操作日時です。
folderPath 文字列 フォルダーパスです。
documentName 文字列 文書名です。
fileType 0 PDF ファイルです。
1 リンクです。
2 ページリンクです。
3 マルチリンクです。
appendix 文字列 ログインリクエスト時に送られるリクエストヘッダーで「ログイン付帯情報」として指
定された HTTP ヘッダーの値です。
第 1 章 SPA Web API リファレンス
614
DeleteRecords List(Ver. 3) 削除履歴の一覧を取得します。
URI
http://<hostname>:44230/spa/service/record_v3/delete/
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必
須
値 備考
folderPath 履歴を取得したいフォルダー
パス
指定がない場合はフォルダーパスでフィルターしません。
documentName 履歴を取得したい文書の文書
名
指定がない場合は文書名でフィルターしません。
limit 取得される情報の最大件数 指定がない場合、および、0 以下の数値を指定した場合は
無制限となります。
from 操作を開始した日時 「yyyy-MM-dd'T'HH:mm:ss.SSSZ」形式で指定します。
例:2013-07-17T07:25:48.000+0900
to 操作を終了した日時 yyyy-MM-dd'T'HH:mm:ss.SSSZ」形式で指定します。
例:2013-07-17T07:25:48.000+0900
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
615
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"size": 10,
"records": [
{
"id": "1"
"documentId": "10",
"userId": "20",
"userName": "user",
第 1 章 SPA Web API リファレンス
616
出力例(JSON 形式)
"userFullname": "fullname",
"deleteUser": false,
"type": 2,
"note": "",
"recordDate": "2015-11-20T11:03:43.639+0900",
"folderPath": "",
"documentName": "",
"fileType": 0,
"appendix": "",
"contentType": 1
},
...
]
}
■ データ内容
キー 値 説明
size 数値 指定した条件に合致する削除記録の総数です。
「limit」パラメーターで最大件数を指定した場合には、records 内に取得される削除記録の件数(最大件数)を超える場合があります。
records 追跡記録一覧(日付順)
追跡記録が存在しない場合は空配列が返ります。
id 文字列 追跡記録の ID です。
documentId 文字列 文書 ID です。
userId 文字列 ユーザーに割り当てられた一意の番号です。
システムが自動的に記録する操作は、userId: -1 です。
userName 文字列 ユーザー名です。
システムが自動的に記録する操作は、userName: ""です。
userFullname 文字列 ユーザーフルネームです。
システムが自動的に記録する操作は、userFullname: ""です。
deleteUser true ユーザーの状態が「すでに削除されたユーザー」です。
false ユーザーの状態が「現在も存在するユーザー」です。
第 1 章 SPA Web API リファレンス
617
キー 値 説明
システムが自動的に記録する操作は、deleteUser: false です。
type 2 記録種別が「削除」であることを表します。
note 文字列 type によって内容が変わります。
• 8(注釈)
更新されたページ番号(カンマ区切り)
• 9(ページメモ)
更新されたページ番号(カンマ区切り)
• 10(自動マスク)
マスク定義名
• 11(手動マスク)
マスク定義名とページ番号(複数の場合はカンマ区切り)
• 23(検索結果へのマスク適用)
マスクされたページ番号(複数の場合はカンマ区切り)
• その他
出力なし
recordDate 文字列 操作日時です。
folderPath 文字列 フォルダーパスです。
documentName 文字列 文書名です。
fileType 0 PDF ファイルです。
1 リンクです。
2 ページリンクです。
3 マルチリンクです。
appendix 文字列 ログインリクエスト時に送られるリクエストヘッダーで「ログイン付帯情報」として指
定された HTTP ヘッダーの値です。
contentType 0 PDF ファイル以外のファイルです。
1 PDF ファイルです。
第 1 章 SPA Web API リファレンス
618
33 証跡確認 証跡確認に関する API は次のとおりです。
• Upload File Trail Get(P.619)
• Trail Get(P.623)
• Trail Update(P.626)
第 1 章 SPA Web API リファレンス
619
Upload File Trail Get PDF ファイルをアップロードし、埋め込まれている証跡情報を取得します。
URI
http://<hostname>:44230/spa/service/trail/upload
HTTP メソッド
POST
Content-Type ヘッダー
multipart/form-data
▌パラメーター
キー 必須 値 備考
file 証跡を確認する PDF ファイル
password PDF ファイルのパスワード • デフォルト値はありません。
• UTF-8 でエンコードされます。
• 複数指定はできません。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
620
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -100 解析できない PDF ファイルが指定されているか、解析時のファイル操作に問
題がある場合に出力されます。また、アップロードされた文書が PDF ファイ
ルでない場合にも出力されます。
400 -105 暗号化された PDF ファイルを復号できない場合に出力されます。
400 -401 指定したファイルが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"info": {
"証跡情報のキー1": "値 1",
"証跡情報のキー2": "値 2",
...
第 1 章 SPA Web API リファレンス
621
出力例(JSON 形式)
"証跡情報のキーN": "値 N"
}
}
■ データ内容
キー 値 備考
info 証跡情報
詳細は、「証跡情報のキーと値について(P.621)」を参照してください。
証跡情報のキーと値について
キー 値 説明
DownloadId 文字列 ダウンロード ID です。必ず表示されます。
• 値の例
D1448500982657-8eace8e5-d1e2-45bb-af90-5f524ceacffa
GenerateDate 文字列 ダウンロード日時です。ダウンロード日時と協定世界時の UTC1970 年 1 月 1 日午
前 0 時との差を測定して、ミリ秒で表示します。
• 値の例
1448500982766
UserId 文字列 ダウンロードしたユーザーの ID です。ユーザーID[ドメイン名]の形式で表示されます。
• 値の例
admin[local]
UserName 文字列 ダウンロードしたユーザーの名前です。
• 値の例
admin
FileName 文字列 ダウンロード時のファイル名です。
• 値の例
00000001 (1).PDF
FolderPath 文字列 ダウンロード時のフォルダーです。
• 値の例
/folderpath
第 1 章 SPA Web API リファレンス
622
キー 値 説明
FileType 文字列 ダウンロードしたファイルの種類(リンクまたはファイル)です。ファイルは「0」、リンクは「1」、ページリンクは「2」、マルチリンクは「3」が表示されます。
• 値の例
1
PageExtract 文字列 ダウンロード時に指定したページです。全ページの場合は「all」、ページ番号を指定した場合は指定したページ番号が表示されます。
• 値の例
1-10,16,20
Protocol 文字列 文書をダウンロードした端末のリクエストプロトコルです。
• 値の例
HTTP/1.1
IPAddress 文字列 文書をダウンロードした端末または最終プロキシの IP アドレスです。
• 値の例
192.168.XX.10
RemoteHost 文字列 文書をダウンロードした端末または最終プロキシの完全修飾ドメイン名です。
• 値の例
xxx.servername.com
RemotePort 文字列 文書をダウンロードした端末または最終プロキシのポート番号です。
• 値の例
56322
UserSpecifiedValue 文字列 ユーザーが任意に指定した文字列です。
ArchiveServerVersion 文字列 アーカイブサーバーのバージョンです。必ず表示されます。
• 値の例
9.3.0.0
第 1 章 SPA Web API リファレンス
623
Trail Get ダウンロード時に埋め込む証跡情報に関する設定値を取得します。
URI
http://<hostname>:44230/spa/service/trail
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
624
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"info": {
"証跡設定のキー1": "値 1",
"証跡設定のキー2": "値 2",
...
"証跡設定のキーN": "値 N"
}
}
■ データ内容
キー 値 備考
info 証跡設定の設定内容
詳細は、「証跡設定のキーと値について(P.624)」を参照してください。
証跡設定のキーと値について
キー 値 備考
DownloadId - システムが付加するダウンロード ID です。常に出力されます。
GenerateDate true ダウンロード日時を証跡として出力します。
false ダウンロード日時を証跡として出力しません。
UserId true ダウンロードしたユーザーの ID を証跡として出力します。
false ダウンロードしたユーザーの ID を証跡として出力しません。
UserName true ダウンロードしたユーザーの名前を証跡として出力します。
false ダウンロードしたユーザーの名前を証跡として出力しません。
第 1 章 SPA Web API リファレンス
625
キー 値 備考
FileName true ダウンロード時のファイル名を証跡として出力します。
false ダウンロード時のファイル名を証跡として出力しません。
FolderPath true ダウンロード時のフォルダーを証跡として出力します。
false ダウンロード時のフォルダーを証跡として出力しません。
FileType true ダウンロードしたファイル種類(リンクまたはファイル)を証跡として出力します。
false ダウンロードしたファイル種類(リンクまたはファイル)を証跡として出力しません。
PageExtract true ダウンロード時の指定ページを証跡として出力します。
false ダウンロード時の指定ページを証跡として出力しません。
Protocol true 文書をダウンロードした端末のリクエストプロトコルを証跡として出力します。
false 文書をダウンロードした端末のリクエストプロトコルを証跡として出力しません。
IPAddress true 文書をダウンロードした端末または最終プロキシの IP アドレスを証跡として出力しま
す。
false 文書をダウンロードした端末または最終プロキシの IP アドレスを証跡として出力しま
せん。
RemoteHost true 文書をダウンロードした端末または最終プロキシの完全修飾ドメイン名を証跡として出
力します。
false 文書をダウンロードした端末または最終プロキシの完全修飾ドメイン名を証跡として出
力しません。
RemotePort true 文書をダウンロードした端末または最終プロキシのポートを証跡として出力します。
false 文書をダウンロードした端末または最終プロキシのポートを証跡として出力しません。
UserSpecified true ユーザー任意文字列を証跡として出力します。
false ユーザー任意文字列を証跡として出力しません。
UserSpecifiedValue 文字列 ユーザーが任意に指定した文字列です。
ArchiveServerVersion - アーカイブサーバーのバージョンです。常に出力されます。
第 1 章 SPA Web API リファレンス
626
Trail Update ダウンロード時に埋め込む証跡情報について設定します。
URI
http://<hostname>:44230/spa/service/trail
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"info": {
"証跡設定のキー1": "値 1",
"証跡設定のキー2": "値 2",
...
"証跡設定のキーN": "値 N"
}
}
■ データ内容
キー 必須 値 備考
DownloadId - システムが付加するダウンロード ID です。
GenerateDate true ダウンロード日時を証跡として出力します。
false ダウンロード日時を証跡として出力しません。
UserId true ダウンロードしたユーザーの ID を証跡として出力します。
false ダウンロードしたユーザーの ID を証跡として出力しません。
第 1 章 SPA Web API リファレンス
627
キー 必須 値 備考
UserName true ダウンロードしたユーザーの名前を証跡として出力します。
false ダウンロードしたユーザーの名前を証跡として出力しません。
FileName true ダウンロード時のファイル名を証跡として出力します。
false ダウンロード時のファイル名を証跡として出力しません。
FolderPath true ダウンロード時のフォルダーを証跡として出力します。
false ダウンロード時のフォルダーを証跡として出力しません。
FileType true ダウンロードしたファイル種類(リンクまたはファイル)を証跡として出力
します。
false ダウンロードしたファイル種類(リンクまたはファイル)を証跡として出力
しません。
PageExtract true ダウンロード時の指定ページを証跡として出力します。
false ダウンロード時の指定ページを証跡として出力しません。
Protocol true 文書をダウンロードした端末のリクエストプロトコルを証跡として出力しま
す。
false 文書をダウンロードした端末のリクエストプロトコルを証跡として出力しま
せん。
IPAddress true 文書をダウンロードした端末または最終プロキシの IP アドレスを証跡とし
て出力します。
false 文書をダウンロードした端末または最終プロキシの IP アドレスを証跡とし
て出力しません。
RemoteHost true 文書をダウンロードした端末または最終プロキシの完全修飾ドメイン名を証
跡として出力します。
false 文書をダウンロードした端末または最終プロキシの完全修飾ドメイン名を証
跡として出力しません。
RemotePort true 文書をダウンロードした端末または最終プロキシのポートを証跡として出力
します。
false 文書をダウンロードした端末または最終プロキシのポートを証跡として出力
しません。
UserSpecified true ユーザー任意文字列を証跡として出力します。
false ユーザー任意文字列を証跡として出力しません。
UserSpecifiedValue 文字列 ユーザーが任意に指定する文字列です。
第 1 章 SPA Web API リファレンス
628
キー 必須 値 備考
ArchiveServerVersion - アーカイブサーバーのバージョンです。
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
X-Spa-Error-Validation-Property 証跡情報のキー名 証跡情報の値に問題がある場合、エラーとなったキーの名
称が出力されます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -20812 証跡情報の値が 2000 バイト以上ある場合に出力されます。エラーが発生した場
合、X-Spa-Error-Validation-Property にエラーとなったキーの名称が出力されま
す。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
629
34 セッション管理 セッション管理に関する API は、次のとおりです。
• Session Current Get(Ver. 2)(P.630)
第 1 章 SPA Web API リファレンス
630
Session Current Get(Ver. 2) 現在ログイン中のユーザーに関するセッション情報を取得します。
URI
http://<hostname>:44230/spa/service/sessions_v2/current
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータス エラーコード 備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
第 1 章 SPA Web API リファレンス
631
HTTP ステータス エラーコード 備考
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外
は-5000 を返します。
▌出力例
出力例(JSON 形式)
{
"tenantId" : -1,
"sessionTicketId" : "1",
"userName" : "user1",
"userId" : "3",
"domainName" : "local",
"domainId" : "0",
"fullName" : "full name",
"autoLogin" : false,
"appendix" : "任意情報"
}
■ データ内容
キー 値 備考
tenantId 数値 テナント ID です。
sessionTicketId 文字列 セッションチケット ID です。
userName 文字列 ユーザー名です。
userId 文字列 ユーザーID です。
domainName 文字列 ドメイン名です。
domainId 文字列 ドメインの ID です。
fullName 文字列 ユーザーのフルネームです。
autoLogin true 自動ログインです。
false 通常ログインです。
appendix 文字列 ログインリクエスト時に送られるリクエストヘッダーで「ログイン付帯情報」として
指定された HTTP ヘッダーの値です。
第 1 章 SPA Web API リファレンス
632
35 メンテナンスモード設定 メンテナンスモード設定に関する API は、次のとおりです。
• Maintenance Mode Status Get(P.633)
• Maintenance Mode Status Update(P.635)
第 1 章 SPA Web API リファレンス
633
Maintenance Mode Status Get メンテナンスモードの状態を取得します。
URI
http://<hostname>:44230/spa/service/mntmode/
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
634
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"status": "PAUSED",
"defaultTimeout": "60000"
}
■ データ内容
キー 値 備考
status PAUSED メンテナンスモード停止中です。
START_PENDING メンテナンスモード起動待ちです。
RUNNING メンテナンスモード起動中です。
defaultTimeout 文字列 メンテナンスモードの状態更新時に失敗とみなすデフォルトのタイムアウト時
間(単位はミリ秒)です。
第 1 章 SPA Web API リファレンス
635
Maintenance Mode Status Update
URI
http://<hostname>:44230/spa/service/mntmode/
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必
須
値 備
考
mode 更新するメンテナンスモードの値
• 0
メンテナンスモード停止
• 1
メンテナンスモード起動
timeout 更新を失敗とみなすタイムアウト時間(単位:ミリ秒)
10000 から 120000 以内で指定します。指定がない場合はデフォルトのタイムアウト時間
(60 秒)で動作します。
▌その他の注意事項
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
636
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
400 -9995 メンテナンスモードの状態を変更できなかった(タイムアウトした)場合に出力
されます。
400 -9997 指定した値に誤りがある場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
637
36 サーバー情報の取得 サーバー情報の取得に関する API は、次のとおりです。
• Config Version(P.638)
• Config Activation(P.643)
第 1 章 SPA Web API リファレンス
638
Config Version SPA(アーカイブサーバー、Web サーバー、検索サーバー、Loader サーバー)のバージョンを取得します。
URI
• アーカイブサーバー
http://<hostname>:44230/spa/service/config/version/archive
• Web サーバー
http://<hostname>:44230/spa/service/config/version/webapp
• 検索サーバー
http://<hostname>:44230/spa/service/config/version/search
• Loader サーバー
http://<hostname>:44230/spa/service/config/version/loader
HTTP メソッド
GET
▌パラメーター
キー 必須 値 備考
id サーバーを特定するための ID Loader サーバーのバージョン取得時のみ指定が必要です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
第 1 章 SPA Web API リファレンス
639
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。Loader サーバーの指定
がない、または、不正な Loader サーバーの ID が指定された場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"server" : "Archive",
"id" : "",
"version" : "1.0.0.0 (2017/11/02 09:41:09 JST)",
"copyright" : "(c) 2013 WingArc1st Inc. All rights reserved.",
"libraries" : [
{
"id" : "spa-core",
第 1 章 SPA Web API リファレンス
640
出力例(JSON 形式)
"name" : "com.wingarc.svf.spa.SpaCoreVersionInfo",
"version" : "1.0.0.0",
"build" : "2017/11/02 09:40:52 JST",
"description" : "SPA Ver.10 : spa-core"
},
{
"id" : "spa-misc-lib",
"name" : "com.wingarc.svf.spa.SpaMiscLibVersionInfo",
"version" : "1.0.0.0",
"build" : "2017/11/02 09:39:35 JST",
"description" : "SPA Ver.10 : spa-misc-lib"
},
{
"id" : "spa-search-client",
"name" : "com.wingarc.svf.spa.SpaSearchClientVersionInfo",
"version" : "1.0.0.0",
"build" : "2017/11/02 09:40:43 JST",
"description" : "SPA Ver.10 : spa-search-client"
},
{
"id" : "spa-search-comps",
"name" : "com.wingarc.svf.spa.SpaSearchCompsVersionInfo",
"version" : "1.0.0.0",
"build" : "2017/11/02 09:40:22 JST",
"description" : "SPA Ver.10 : spa-search-comps"
},
{
"id" : "spa-server",
"name" : "com.wingarc.svf.spa.SpaServerVersionInfo",
"version" : "1.0.0.0",
"build" : "2017/11/02 09:41:09 JST",
"description" : "SPA Ver.10 : spa-server"
},
第 1 章 SPA Web API リファレンス
641
出力例(JSON 形式)
{
"id" : "spa-server-rt",
"name" : "com.wingarc.svf.spa.SpaServerRtVersionInfo",
"version" : "1.0.0.0",
"build" : "2017/11/02 09:40:10 JST",
"description" : "SPA Ver.10 : spa-server-rt"
},
{
"id" : "spa-store",
"name" : "com.wingarc.svf.spa.SpaStoreVersionInfo",
"version" : "1.0.0.0",
"build" : "2017/11/02 09:40:27 JST",
"description" : "SPA Ver.10 : spa-store"
},
{
"id" : "smdlib",
"name" : "com.wingarc.svf.smdlib.PackageInfo",
"version" : "10.0.0.0",
"build" : "20171001175344",
"description" : "(c) 2013 WingArc1st Inc. All rights reserved."
},
{
"id" : "svf-pdf-library",
"name" : "com.wingarc.pdf.PackageInfo",
"version" : "1.0.0.5",
"build" : "",
"description" : ""
}
]
}
第 1 章 SPA Web API リファレンス
642
■ データ内容
キー 値 備考
server Archive サーバーの種類は「アーカイブサーバー」です。
Application サーバーの種類は「Web サーバー」です。
Search サーバーの種類は「検索サーバー」です。
Loader サーバーの種類は「Loader サーバー」です。
id 文字列 サーバーを特定するための ID です。
Loader サーバーでのみ使用します。
version 文字列 バージョン情報です。
copyright 文字列 著作権表示です。
libraries 主要ライブラリの詳細情報
id 文字列 ライブラリを特定するための文字列です。
name 文字列 ライブラリのバージョン情報を出力するためのクラス名です。
version 文字列 バージョン情報です。
build 文字列 ビルド情報(番号または日付)です。
Loader サーバーでは取得できません。
description 文字列 概要説明です。
Loader サーバーでは取得できません。
第 1 章 SPA Web API リファレンス
643
Config Activation SPA のアクティベーション情報を取得します。
URI
http://<hostname>:44230/spa/service/config/activation
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
第 1 章 SPA Web API リファレンス
644
HTTP ステータ
ス
エラーコー
ド
備考
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"available" : true,
"expireDate" : "none",
"features" : {
"std" : "true"
},
"options" : {
"tablet" : "true",
"seiko" : "true",
"ts:interval" : "30",
"ocr:tegaki" : "true",
"connectpack" : "true",
"connectpack:bridgeServiceMaxCount" : 0
}
}
■ データ内容
キー 値 備考
available true アクティベーションが「有効」です。
false アクティベーションが「無効」です。
expireDate 文字列 アクティベーションの有効期限です。
有効期限がない場合は"none"と出力されます。
features 基本機能が利用できるかどうか
第 1 章 SPA Web API リファレンス
645
キー 値 備考
std 文字列 • 「true」の場合
SPA Standard が利用可能です。
• 「false」の場合
SPA Limited が利用可能です。
options オプション機能が利用できるかどうか
tablet 文字列 「true」の場合、タブレットオプションが利用可能です。
利用不可の場合は出力されません。
seiko 文字列 「true」の場合、「SEIKO Timestamp Service」が利用可能で
す。
利用不可の場合は出力されません。
terrada 文字列 「true」の場合、「TERRADA Timestamp Service」が利用可能で
す。
利用不可の場合は出力されません。
ts:interval 文字列 タイムスタンプ間隔です。
「seiko」または「terrada」の値が「true」の場合のみ出力され
ます。
ocr:tegaki 文字列 「true」の場合、「Tegaki Option」が利用可能です。
利用不可の場合は出力されません。
connectpack 文字列 「true」の場合、「SPA Connect Pack Option」が利用可能です。
利用不可の場合は出力されません。
connectpack:bridgeServiceMaxCount 文字列 Bridge サービスの最大接続数です。
「connectpack」の値が「true」の場合のみ出力されます。
第 1 章 SPA Web API リファレンス
646
37 フォルダーへの通知の設定 フォルダーへの通知の設定に関する API は、次のとおりです。
• Event Notification Get(P.647)
• Event Notification Update(P.660)
第 1 章 SPA Web API リファレンス
647
Event Notification Get 指定したフォルダーの通知の設定を取得します。
URI
http://<hostname>:44230/spa/service/notification/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
GET
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
第 1 章 SPA Web API リファレンス
648
HTTP ステータ
ス
エラーコー
ド
備考
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
通知の設定がある場合の出力例(JSON 形式)
{
"status": "ON",
"inheritFolderId": "-1",
"settings": {
"item": [
{
"description": "通知の説明",
"events": [
1,
2,
3
],
"mails": {
"enable": true,
"summary": true,
"users": [
{
"id": "1",
"name": "admin1",
"fullname": "admin1",
第 1 章 SPA Web API リファレンス
649
通知の設定がある場合の出力例(JSON 形式)
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
},
{
"id": "2",
"name": "user1",
"fullname": "user1",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
}
],
"groups": [
{
"id": "1",
"name": "AdminGroup",
"fullname": "AdminGroup",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
},
{
"id": "2",
"name": "UserGroup",
"fullname": "UserGroup",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
}
],
"directs": [
第 1 章 SPA Web API リファレンス
650
通知の設定がある場合の出力例(JSON 形式)
]
},
"programs": {
"enable": true,
"path": "/user/local/bin/move",
"parameters": [
"${folder_path}",
"${document_id}",
"${document_name}",
"任意文字列"
]
}
}
]
}
}
通知の設定が無い場合の出力例(JSON 形式)
{
"status": "OFF",
"inheritFolderId": "-1",
"settings": null
}
通知の設定が親フォルダーの設定を継承する場合の出力例(JSON 形式)
{
"status": "ON",
"inheritFolderId": "-1",
"settings": {
"item": [
{
第 1 章 SPA Web API リファレンス
651
通知の設定が親フォルダーの設定を継承する場合の出力例(JSON 形式)
"description": "通知の説明",
"events": [
1,
2,
3
],
"mails": {
"enable": true,
"summary": true,
"users": [
{
"id": "1",
"name": "admin1",
"fullname": "admin1",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
},
{
"id": "2",
"name": "user1",
"fullname": "user1",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
}
],
"groups": [
{
"id": "1",
"name": "AdminGroup",
"fullname": "AdminGroup",
"domainId": "1",
第 1 章 SPA Web API リファレンス
652
通知の設定が親フォルダーの設定を継承する場合の出力例(JSON 形式)
"domainName": "local",
"mailAddress": "[email protected]"
},
{
"id": "2",
"name": "UserGroup",
"fullname": "UserGroup",
"domainId": "1",
"domainName": "local",
"mailAddress": "[email protected]"
}
],
"directs": [
]
}
}
]
}
}
■ データ内容
キー 値 備考
status INHERITED 通知の設定について、親フォルダーの設定を継承します。
OFF 通知の設定をしません。
ON 通知の設定をします。
inheritFolderId 文字列 継承しているフォルダーID です(status が「INHERITED」の場合のみ)。
settings 通知の設定
• status が「INHERITED」の場合
第 1 章 SPA Web API リファレンス
653
キー 値 備考
継承しているフォルダーの通知の設定
• status が「OFF」の場合
通知の設定なし
item 通知の設定の 1 件に該当
複数の通知の設定を行う場合は、この要素が複数出力されます。
description 通知の説明
evnets 通知のイベント
ID
通知の対象となるイベントの ID
イベントの ID については、「通知のイベントの ID(P.654)」を参照してくださ
い。
mails メール送信での通知設定
enable true メール送信での通知が有効です。
false メール送信での通知が無効です。
summary true メールの本文に処理件数だけを出力します。
false メールの本文に個々の文書の情報と、処理件数を出力します。
users 宛先に設定するユーザー
id 文字列 ユーザーに割り当てられる一意の番号です。
name 文字列 ユーザー名です。
fullName 文字列 ユーザーのフルネームです。
domainId 文字列 ユーザーが所属するドメインの ID です。
domainName 文字列 ユーザーの所属するドメイン名です。
mailAddress 文字列 ユーザーのメールアドレスです。
groups 宛先に設定するグループ
id 文字列 グループに割り当てられる一意の番号です。
name 文字列 グループ名です。
fullName 文字列 グループのフルネームです。
domainId 文字列 グループが所属するドメインの ID です。
domainName 文字列 グループの所属するドメイン名です。
mailAddress 文字列 グループのメールアドレスです。
directs 宛先のメールアドレスを直接設定
第 1 章 SPA Web API リファレンス
654
キー 値 備考
programs プログラム実行での通知設定
enable true プログラム実行での通知が有効です。
false プログラム実行での通知が無効です。
path 文字列 起動する外部プログラムのフルパスです。
parameters 文字列 起動する外部プログラムのパラメーターです。
外部プログラムのパラメーターについては、「外部プログラムのパラメーター
(P.657)」を参照してください。
通知のイベントの ID
通知のイベントの ID は次のとおりです。外部プログラムのパラメーターについては、「外部プログラムのパ
ラメーター(P.657)」を参照してください。
イベント
ID
イベント名 外部プログラム起動で利用可能なパラメーター 備考
1 作成 イベント ID、パス、文書名、ファイル ID、実行
結果、ユーザーID、ドメイン名、ユーザー名
ファイルの他、リンクとマルチリン
クが作成されたときも含みます。 イ
ベントの実行後に検索インデックス
の作成が完了したタイミングで通知
します。
2 移動 イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
ファイル、フォルダーが移動された
とき、およびフォルダー名が変更さ
れたときも含みます。
3 上書き イベント ID、パス、文書名、ファイル ID、実行
結果、ユーザーID、ドメイン名、ユーザー名
上書きアーカイブ、マルチリンクの
構成が変更されたときも含みます。
イベントの実行後に検索インデック
スの作成が完了したタイミングで通
知します。
4 閲覧 イベント ID、パス、文書名、ファイル ID、実行
結果、ユーザーID、ドメイン名、ユーザー名
5 印刷 イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
第 1 章 SPA Web API リファレンス
655
イベント
ID
イベント名 外部プログラム起動で利用可能なパラメーター 備考
6 ダウンロー
ド
イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
7 無加工ダウ
ンロード
イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
8 注釈 イベント ID、パス、文書名、ファイル ID、ペー
ジ番号、実行結果、ユーザーID、ドメイン名、
ユーザー名
9 ページメモ イベント ID、パス、文書名、ファイル ID、ペー
ジ番号、ページメモ、実行結果、ユーザーID、
ドメイン名、ユーザー名
10 自動マスク イベント ID、パス、文書名、ファイル ID、マス
ク名、実行結果、ユーザーID、ドメイン名、ユ
ーザー名
イベントの実行後に検索インデック
スの作成が完了したタイミングで通
知します。
11 手動マスク イベント ID、パス、文書名、ファイル ID、マス
ク名、ページ番号、実行結果、ユーザーID、ド
メイン名、ユーザー名
イベントの実行後に検索インデック
スの作成が完了したタイミングで通
知します。
12 プロパティ
更新
イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
ファイル名、ページメモ、カスタム
プロパティが更新されたときも含み
ます。
13 文書のコメ
ント
イベント ID、パス、文書名、ファイル ID、コメ
ント、実行結果、ユーザーID、ドメイン名、ユ
ーザー名
14 タイムスタ
ンプ付与
イベント ID、パス、文書名、ファイル ID
15 ごみ箱へ移
動
イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
16 ごみ箱から
復元
イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
第 1 章 SPA Web API リファレンス
656
イベント
ID
イベント名 外部プログラム起動で利用可能なパラメーター 備考
17 文書の削除 イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
18 検索結果へ
のマスク適
用
イベント ID、パス、文書名、ファイル ID、矩形
を適用したページ番号、実行結果、ユーザー
ID、ドメイン名、ユーザー名
イベントの実行後に検索インデック
スの作成が完了したタイミングで通
知します。
19 CSV ファイ
ルの出力
イベント ID、パス、文書名、ファイル ID、対象
件数、成功件数、失敗件数、実行結果、ユーザ
ーID、ドメイン名、ユーザー名
20 CSV ファイ
ルのダウン
ロード
イベント ID、受付番号、実行結果、ユーザー
ID、ドメイン名、ユーザー名
21 バージョン
更新
イベント ID、パス、文書名、ファイル ID、バー
ジョン番号、実行結果、ユーザーID、ドメイン
名、ユーザー名
イベントの実行後に検索インデック
スの作成が完了したタイミングで通
知します。
22 文書の復元 イベント ID、パス、文書名、ファイル ID、バー
ジョン番号、実行結果、ユーザーID、ドメイン
名、ユーザー名
バージョン番号は、復元したバージ
ョンの値です。イベントの実行後に
検索インデックスの作成が完了した
タイミングで通知します。
23 SVF 検索フ
ィールドの
編集
イベント ID、パス、文書名、ファイル ID、ペー
ジ番号、SVF 検索フィールド、実行結果、ユー
ザーID、ドメイン名、ユーザー名
24 レビューの
起票
イベント ID、パス、文書名、ファイル ID、URL
リンク、レビューステータス、実行結果、ユー
ザーID、ドメイン名、ユーザー名
25 レビューの
確認
イベント ID、パス、文書名、ファイル ID、URL
リンク、レビューステータス、実行結果、ユー
ザーID、ドメイン名、ユーザー名
26 レビューの
差し戻し
イベント ID、パス、文書名、ファイル ID、URL
リンク、レビューステータス、実行結果、ユー
ザーID、ドメイン名、ユーザー名
27 レビューの
完了
イベント ID、パス、文書名、ファイル ID、URL
リンク、レビューステータス、実行結果
第 1 章 SPA Web API リファレンス
657
イベント
ID
イベント名 外部プログラム起動で利用可能なパラメーター 備考
28 レビューの
作成
イベント ID、パス、文書名、ファイル ID、URL
リンク、レビューステータス、実行結果、ユー
ザーID、ドメイン名、ユーザー名
29 レビューの
削除
イベント ID、パス、文書名、ファイル ID、URL
リンク、レビューステータス、実行結果、ユー
ザーID、ドメイン名、ユーザー名
30 レビューの
取り消し
イベント ID、パス、文書名、ファイル ID、URL
リンク、レビューステータス、実行結果、ユー
ザーID、ドメイン名、ユーザー名
31 振り分け完
了
イベント ID、処理定義名、文書定義 ID、文書定
義名、対象件数、成功件数、失敗件数
イベントの実行後に検索インデック
スの作成が完了したタイミングで通
知します。
32 回転情報の
設定
イベント ID、パス、文書名、ファイル ID、ペー
ジ番号、回転情報、実行結果、ドメイン名、ユ
ーザーID、ユーザー名
「回転情報」は、アーカイブ直後の
文書のページを基準とした以下の値
です。
• 0
基準から変更なし/基準に戻す
• 1
時計回りで 90 度加えた角度
(右へ 90 度回転)
• 2
時計回りで 180 度加えた角度
(180 度回転)
• 3
時計回りで 270 度加えた角度
(左へ 90 度回転)
なお、メジャーバージョンアップし
た場合は、バージョンアップ直後の
ページが基準となります。
外部プログラムのパラメーター
外部プログラムのパラメーターに指定する変数は次のとおりです。
第 1 章 SPA Web API リファレンス
658
パラメーター 変数 備考
イベント ID ${event_id}
実行結果 ${event_status}
パス ${folder_path} 文書が保存されているパスです。
ファイル ID ${document_id}
文書名 ${document_name}
URL リンク ${direct_url}
ユーザーID ${user_id}
ドメイン名 ${domain_name}
ユーザー名 ${user_name}
コメント ${comment}
ページ番号 ${page_num}
ページメモ ${pagememo}
バージョン番号 ${version}
SVF 検索フィールド ${svf_field}
レビューステータス ${review_status} 以下のいずれかです。
• 0
起票前
• 1
起票
• 2
処理中
• 3
完了
対象件数 ${total_count} 複数件同時に処理した場合の文書の対象件数です。
成功件数 ${success_count}
失敗件数 ${error_count}
文書定義 ID ${doctype_id}
文書定義名 ${doctype_dispname}
第 1 章 SPA Web API リファレンス
659
パラメーター 変数 備考
処理定義名 ${definition_name}
マスク名 ${mask_name}
矩形を適用したページ番号 ${rect_page_num}
受付番号 ${request_id} ダウンロード用 CSV ファイルに付与される受付番号です。
第 1 章 SPA Web API リファレンス
660
Event Notification Update 指定したフォルダーの通知の設定を変更します。
URI
http://<hostname>:44230/spa/service/notification/<id>
• キー
キー 必須 値 備考
id 処理対象フォルダーの ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
通知の設定を行う場合の本体の例(JSON 形式)
{
"status": "ON",
"settings": {
"item": [
{
"description": "通知の説明",
"events": [
1,
2,
3
],
"mails": {
"enable": true,
第 1 章 SPA Web API リファレンス
661
通知の設定を行う場合の本体の例(JSON 形式)
"summary": true,
"users": [
{
"id": "1"
},
{
"id": "2"
}
],
"groups": [
{
"id": "1"
},
{
"id": "2"
}
],
"directs": [
]
},
"programs": {
"enable": true,
"path": "/user/local/bin/move",
"parameters": [
"${folder_path}",
"${document_id}",
"${document_name}",
"任意文字列"
]
}
第 1 章 SPA Web API リファレンス
662
通知の設定を行う場合の本体の例(JSON 形式)
}
]
}
}
通知の設定を行わない場合の本体の例(JSON 形式)
{
"status": "OFF",
"settings": null
}
親フォルダーの通知の設定を継承する場合の本体の例(JSON 形式)
{
"status": "INHERITED",
"settings": null
}
■ データ内容
キー 必須 値 備考
status(*1) INHERITED 通知の設定について、親フォルダーの設定を継承します。
OFF 通知の設定をしません。
ON 通知の設定をします。
settings (*2) 通知の設定
• status が「INHERITED」、または「OFF」の場合
null
item 通知の設定の 1 件に該当
複数の通知の設定を行う場合は、この要素を複数指定します。
description 通知の説明
evnets (*2) 通知のイベ
ントの ID
通知の対象となるイベントの ID
通知のイベントの ID については、「通知のイベントの ID(P.654)」を参照し
てください。
mails 通知機能によるメール送信
第 1 章 SPA Web API リファレンス
663
キー 必須 値 備考
enable true 通知機能によるメール送信を有効にします。
false 通知機能によるメール送信を無効にします。
summary true メールの本文に処理件数だけを出力します。
false メールの本文に個々の文書の情報と、処理件数を出力します。
users (*3) 宛先に設定するユーザー
id (*4) 文字列 ユーザーに割り当てられる一意の番号です。
name 文字列 ユーザー名です。
fullName 文字列 ユーザーのフルネームです。
domainId 文字列 ユーザーが所属するドメインの ID です。
domainName 文字列 ユーザーの所属するドメイン名です。
mailAddress 文字列 ユーザーのメールアドレスです。
groups (*3) 宛先に設定するグループ
id (*5) 文字列 グループに割り当てられる一意の番号です。
name 文字列 グループ名です。
fullName 文字列 グループのフルネームです。
domainId 文字列 グループが所属するドメインの ID です。
domainName 文字列 グループの所属するドメイン名です。
mailAddress 文字列 グループのメールアドレスです。
directs (*3) 宛先のメールアドレスを直接設定
programs (*6) 通知機能によるプログラム実行
enable true 通知機能によるプログラム実行を有効にします。
false 通知機能によるプログラム実行を無効にします。
path (*7) 文字列 起動する外部プログラムのフルパスです。
parameters 文字列 起動する外部プログラムのパラメーターです。
外部プログラムのパラメーターについては、「外部プログラムのパラメータ
ー(P.657)」を参照してください。
*1 特殊なフォルダーについて
以下のフォルダーについては、通知の設定が制限されます。
第 1 章 SPA Web API リファレンス
664
• 「/」(ルート)フォルダー
status は「ON(設定する)」、「OFF(設定しない)」のみ設定可能です。
• ログインしているユーザーのホームフォルダー(/Users/<ユーザー名>)
設定できません。
• マイフォルダー
設定できません。
*2 「status」が「ON」の場合に必須です。
*3 「users」、「groups」、「directs」のいずれか 1 つの指定が必須です。
*4 「users」を指定した場合に必須です。
*5 「groups」を指定した場合に必須です。
*6 「directs」を指定した場合に必須です。
*7 「directs」を指定した場合で、「enable」が「true」の場合に必須です。
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
第 1 章 SPA Web API リファレンス
665
HTTP ステータ
ス
エラーコー
ド
備考
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -301 指定したフォルダーが存在しない場合に出力されます。
404 -501 対象のユーザーが存在しない場合に出力されます。
404 -601 グループの削除やグループ情報の更新、グループの指定において、対象のグルー
プが存在しない場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
400 -9997 指定した値に誤りがある場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。たとえば、以下のような
場合に出力されます。
• 「mails」の「enable」パラメーターに「true」が指定された場合で、
「users」、「groups」、「directs」の「id」が 1 つも指定されていない場合
• 「programs」の「enable」パラメーターに「true」が指定された場合で、
「path」が指定されていない場合
• メールアドレスに使えない文字が使用されている場合
• メールアドレスに 51 バイト以上の文字列が指定された場合
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 1 章 SPA Web API リファレンス
667
Pages Rotate 指定したページの回転について設定します。
URI
http://<hostname>:44230/spa/service/pages/rotate/<id>
• キー
キー 必須 値 備考
id 処理対象文書の ID
HTTP メソッド
PUT
Content-Type ヘッダー
application/json
▌オブジェクト
オブジェクトの例(JSON 形式)
{
"rotateTypes": {
"1": 0,
"2": 1,
"3": 2,
"4": 3
},
"condition": {
"useDocumentEntityVersion": true,
"documentEntityVersion": 1
}
}
第 1 章 SPA Web API リファレンス
668
■ データ内容
キー 必須 値 備考
rotateTypes 属性名をページ番号、値を回転についての情報のペアで指定しま
す。
ページ番号には、1 から文書の最終ページのページ番号までが指
定できます。ページ番号に"all"を指定した場合は、文書の全ペー
ジを対象に一括してページの回転を指定できます。なお、"all"を
指定した場合は、個別に指定したページ番号は無効になります。
回転についての情報の値には、0~3 が指定できます。アーカイブ
した文書のページを基準とした角度の絶対値です。
• 0
基準変更なし、または基準に戻す
• 1
時計回りで 90 度を加算した角度(右へ 90 度回転)
• 2
時計回りで 180 度を加算した角度(180 度回転)
• 3
時計回りで 270 度を加算した角度(左へ 90 度回転)
"rotateTypes": {"all": 0} が指定された場合は、全ページの回転を
一括してクリアにして、基準の状態に戻します。
保存した回転についての情報は、Preview Get でプレビュー画像
を取得する際に、レスポンスヘッダーの X-Spa-Page-RotateType
というキーで取得できます。
condition 文字列 ページの回転についての情報を保存する際に確認する条件
useDocumentEntityVersion true ページの回転について保存する際に、文書のエンティティバージ
ョンを確認します。
指定されていない場合は、true が指定されたものとします。
false ページの回転について保存する際に、文書のエンティティバージ
ョンを確認しません。
documentEntityVersion (*1) 数値 文書のエンティティバージョンです。
*1 「useDocumentEntityVersion」が「true」の場合に必須です。
第 1 章 SPA Web API リファレンス
669
▌その他の注意事項
• HTTP リクエストの Accept ヘッダーを「application/json」とします。ただし、指定がなくても JSON
形式で出力します。
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -300 対象のフォルダーにアクセス権がない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -409 アーカイブされた文書を更新する際、対象の文書を開いたときのバージョンとサ
ーバーに保管されている文書のバージョンが一致しなかった場合に出力されま
す。
500 -2100 処理対象外のファイルが指定された場合に出力されます。
500 -2101 Document Converter による PDF ファイルへの変換が終了していないファイルを
指定した場合に出力されます。
500 -2102 Document Converter による PDF ファイルへの変換が失敗したファイルを指定し
た場合に出力されます。
400 -2200 リンクに対してページの回転を保存しようとした場合に出力されます。
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
第 1 章 SPA Web API リファレンス
670
HTTP ステータ
ス
エラーコー
ド
備考
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。回転角度のオフセット値
に正しくない値が指定された場合に出力されます。
400 -29002 ページ番号の指定に問題がある場合に出力されます。0 以下や文書のページ数以
上のページ番号が指定された場合です。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
▌出力例
出力例(JSON 形式)
{
"id": "1",
"documentEntityVersion": 2
}
■ データ内容
キー 値 備考
id 文字列 文書 ID です。
documentEntityVersion 数値 文書のエンティティバージョンです。
第 1 章 SPA Web API リファレンス
671
39 Bridge サービス設定 Bridge サービス設定に関する Web API は次のとおりです。
• Bridge Service Installer Get(P.672)
第 1 章 SPA Web API リファレンス
672
Bridge Service Installer Get 指定した Bridge サービスのインストーラーを取得します。
URI
http://<hostname>:44230/spa/service/bridgeService/installer
HTTP メソッド
POST
Content-Type ヘッダー
application/x-www-form-urlencoded
▌パラメーター
キー 必
須
値 備考
name Bridge サービス名 • 半角 16 文字まで指定できます。
url SPA への URL • 半角 2,083 文字まで指定できます。
• http://または https://で始まる必要がありま
す。
type インストーラーのファイル形式
• 0
Windows(64bit)自己解凍形式
(EXE)
• 1
Windows(64bit)圧縮形式(ZIP)
• 2
Linux(64bit)圧縮形式(ZIP)
第 1 章 SPA Web API リファレンス
673
▌その他の注意事項
• ログインしている必要があります。
▌レスポンス
■ レスポンスヘッダー
キー 値の内容 備考
Content-Type application/octet-stream
Content-Disposition ダウンロードファイル名 値は RFC-6266 に沿った、次の形式となります。
attachment; filename*=utf-8''<ファイル名の URL エンコード>
X-Spa-Error-Code エラーコード
X-Spa-Error-Message エラーメッセージ URL エンコードされます。
■ HTTP ステータスとエラーコード
HTTP ステータ
ス
エラーコー
ド
備考
200 0 正常に終了しています。
403 -10 対象の操作を行う権限が付与されていない場合に出力されます。
404 -401 指定したファイルが存在しない場合に出力されます。
400 -2300 指定した名前の Bridge サービスが存在しない場合に出力されます。
401 -20013 次のいずれかの場合に発生します。
• ログインしていないのにログアウトしようとした場合
• ログインしていない状態でリクエストが来た場合
400 -29001 パラメーターの指定に誤りがある場合に出力されます。次のいずれかの場合で
す。
• Bridge サービス名が空文字の場合
• Bridge サービス名に半角 16 文字を超える文字列が指定された場合
• URL が空文字の場合
• URL に半角 2,083 文字を超える文字列が指定された場合
第 1 章 SPA Web API リファレンス
674
HTTP ステータ
ス
エラーコー
ド
備考
• URL の書式に誤りがある場合
503 -9996 メンテナンスモード中のため操作できない場合に出力されます。
500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal
Server Error」が返ります。
エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外は-
5000 を返します。
第 2 章 Web アプリケーションの拡張
675
第 2 章 Web アプリケーションの拡張
本章では、Web アプリケーションからパラメーターを指定して URL にアクセスすることで、拡張できる機能
について説明します。
• 1 文書を指定してプレビュー画面を開く(P.676)
• 2 フォルダーを指定してユーザー画面を開く(P.678)
• 3 POST で送信されたログイン情報で自動ログインする(P.680)
第 2 章 Web アプリケーションの拡張
676
1 文書を指定してプレビュー画面を開く SPA にログインした状態で以下の URL にアクセスすると、指定した文書のプレビュー画面を直接開くことが
できます(HTTP メソッド GET、POST に対応しています)。ログインしていない場合はログイン画面が表示
されます。
▌URL
http://<hostname>:44230/spa/preview.jsp
■ パラメーター
キー 必須 値
docId (*1) プレビュー表示する文書の ID
path (*1) プレビューを表示する文書の文書名(「/」(ルート)フォルダーからのフルパス)(*2)
*1 「docId」または「path」のどちらかを指定する必要があります。両方指定された場合は「docId」の指
定が優先されます。
*2 「path」は URI エンコードされている必要があります。
■ エラー
指定した文書が存在しない場合は、「404」の HTTP ステータスが返ります。
▌HTTP メソッド GET の使用例
以下の情報を持つ文書プレビュー画面を開きます。
文書 ID 文書名
15 /PO01/PO_0001.pdf
■ URL 指定例
• 文書 ID を指定する場合
http://<hostname>:44230/spa/preview.jsp?docId=15
第 2 章 Web アプリケーションの拡張
677
• 文書名を指定する場合
http://<hostname>:44230/spa/preview.jsp?path=/PO01/PO_0001.pdf
■ 結果
第 2 章 Web アプリケーションの拡張
678
2 フォルダーを指定してユーザー画面を開く SPA にログインした状態で以下の URL にアクセスすると、SPA のユーザー画面を、指定したフォルダーを選
択した状態で直接開くことができます(HTTP メソッド GET、POST に対応しています)。ログインしていな
い場合はログイン画面が表示されます。
フォルダーを指定してユーザー画面を開いた場合は、右上のメニューは表示されません。
▌URL
http://<hostname>:44230/spa/index.jsp
■ パラメーター
キー 必須 値
folderId (*1) 選択するフォルダーの ID
path (*1) 選択するフォルダーの、「/」(ルート)フォルダーからのフルパス(*2)
*1 「folderId」または「path」のどちらかを指定する必要があります。両方指定された場合は「folderId」
の指定が優先されます。
*2 「path」は URI エンコードされている必要があります。
▌HTTP メソッド GET の使用例
以下の情報を持つフォルダーを選択した状態で、SPA のユーザー画面を開きます。
フォルダーID フォルダーのパス
103 /201704_02
■ URL 指定例
• フォルダーID を指定する場合
http://<hostname>:44230/spa/index.jsp?folderId=103
• フォルダーのパスを指定する場合
http://<hostname>:44230/spa/index.jsp?path=/201704_02
第 2 章 Web アプリケーションの拡張
680
3 POST で送信されたログイン情報で自動ロ
グインする POST でログイン情報を指定して以下の URL にアクセスすると、SPA に自動ログインできます。指定したロ
グイン情報でログインできない場合は、ログイン画面が表示されます。
注意
自動ログイン機能は、HTTPS でのアクセスを想定して設計されています。
▌URL
https://<hostname>:44230/spa/index.jsp
■ パラメーター
キー 必須 値 備考
mode ログインモード 自動ログインする場合は、「autologin」を指定します。
domain ログインするユーザーが所属するド
メイン名
未指定の場合は「local」が指定されたものとします。
user ログインするユーザー名
password ログインするユーザーのパスワード
改訂履歴
681
改訂履歴
日付 変更箇所 内容
2019/3/29 DocType Update(Ver. 4)(P.499) ページを追加しました。
2019/3/29 DocType Create (Ver. 3)(P.484) ページを追加しました。
2019/3/29 DocType Get(Ver. 3)(P.471) ページを追加しました。
2019/2/28 - SPA にアクセスするための URI および URL を変更しました。
2019/2/28 第 1 章 SPA Web API リファレンス
(P.10)
クラスパスに指定する JAR ファイル名を変更しました。
2019/2/28 Search Documents(Ver. 5)
(P.30)
エラーコード「-20709」が出力される例を追加しました。
2019/2/28 Search In-document(P.50) エラーコード「-701」の説明を削除しました。
2019/2/28 Documents List(Ver. 5)(P.92) 「指定可能なプロパティ情報の項目名」の「stamp」および
「stamped_image_info」に、リンクおよびページリンクの場合の
説明を追加しました。
2019/2/28 Documents Get(Ver. 5)(P.104) 「指定可能なプロパティ情報の項目名」の「stamp」および
「stamped_image_info」に、リンクおよびページリンクの場合の
説明を追加しました。
2019/2/28 Links Create(P.140) エラーコード「-29001」の説明を追加しました。
2019/2/28 Users Create(Ver. 2)(P.253) エラーコード「-9997」の説明を追加しました。
2019/2/28 Domains Update(Ver. 2)(P.335) エラーコード「-651」の HTTP ステータスを 404 に修正しまし
た。
2019/2/28 Domains Default Update(P.340) エラーコード「-651」の HTTP ステータスを 404 に修正しまし
た。
2019/2/28 Domains Delete(P.342) エラーコード「-651」の HTTP ステータスを 404 に修正しまし
た。
2019/2/28 Watermark Update(P.366) エラーコード「-29001」の説明をを追加しました。
2019/2/28 Custom Properties Create(Ver.
2)(P.405)
エラーコード「-455」の説明を変更しました。
2019/2/28 Custom Property Documents
Set(P.413)
エラーコード「-29001」の説明をを追加しました。
改訂履歴
682
日付 変更箇所 内容
2019/2/28 Custom Properties Update(Ver.
2)(P.417)
エラーコード「-455」の説明を変更しました。
2019/2/28 Timestamp Verify(P.510) リンクおよびページリンクの場合は、リンク元文書のタイムスタン
プのベリファイを実行するという説明を追加しました。
2019/2/28 Request Search Data Csv From
Documents(Ver. 4)(P.548)
「全般の name キーの値」の「stamp」および
「stamped_image_info」に、リンクおよびページリンクの場合の
説明を追加しました。
2019/2/28 Request Search Data Csv From
Documents(Ver. 5)(P.555)
ページを追加しました。
2019/2/28 Request Search Data Csv From
Search Results(Ver. 5)(P.581)
ページを追加しました。
2019/2/28 Config Activation(P.643) • 「出力例」を変更しました。
• 「データ内容」に、「ocr:tegaki」キーの説明を追加しまし
た。
2018/8/10 - タイトルバーが製品カラーに変更された画面に変更しました。