SPA Ver. 9.3 Web APIリファレンス...第1章 SPA Web API リファレンス 11 第 1 章 SPA Web...

SPA Ver. 9.3 Web API リファレンス

目次

2

目次目次 ..................................................................................................................................................... 2 本マニュアルについて .......................................................................................................................... 9 第 1 章 SPA Web API リファレンス ................................................................................................... 11

1 認証 ..................................................................................................................................................... 27 Auth Login .......................................................................................................................................... 28 Auth Logout ........................................................................................................................................ 30 Auth Password.................................................................................................................................... 31 Auth Password Change ...................................................................................................................... 33

2 検索 ..................................................................................................................................................... 35 Search Documents ............................................................................................................................. 36 Search Documents（Ver. 2） ............................................................................................................. 53 Search Documents（Ver. 3） ............................................................................................................. 72 Search Documents（Ver. 4） ............................................................................................................. 91 Search Documents（Ver. 5） ........................................................................................................... 110 Search In-document ........................................................................................................................ 130 Search Cancel ................................................................................................................................... 133

3 プレビュー ........................................................................................................................................ 134 Preview Get ...................................................................................................................................... 135 Preview Get（Ver. 2） ...................................................................................................................... 137 Preview Get（Ver. 3） ...................................................................................................................... 140 Highlight Get .................................................................................................................................... 144 Highlight Get（Ver. 2） .................................................................................................................... 152

4 ダウンロード ..................................................................................................................................... 160 Download Document ....................................................................................................................... 161 Download Raw Document ............................................................................................................... 165 Download Print Document .............................................................................................................. 167 Download Packed Documents ........................................................................................................ 170 Download Packed Raw Documents ................................................................................................ 174 Download Packed Print Documents ............................................................................................... 177

5 ファイル操作 ..................................................................................................................................... 181 Documents Lookup .......................................................................................................................... 182 Documents List ................................................................................................................................ 185 Documents List（Ver. 2） ................................................................................................................ 192 Documents List（Ver. 3） ................................................................................................................ 199 Documents List（Ver. 4） ................................................................................................................ 206

目次

3

Documents List（Ver. 5） ................................................................................................................ 214 Documents Get ................................................................................................................................. 225 Documents Get（Ver. 2） ................................................................................................................ 231 Documents Get（Ver. 3） ................................................................................................................ 237 Documents Get（Ver. 4） ................................................................................................................ 244 Documents Get（Ver. 5） ................................................................................................................ 251 Documents Rename ........................................................................................................................ 262 Documents Move List ....................................................................................................................... 265 Documents Move List（Ver. 2） ...................................................................................................... 268 Documents Delete List ..................................................................................................................... 272 Documents History List ................................................................................................................... 276 Documents Restore .......................................................................................................................... 281

6 リンク操作 ........................................................................................................................................ 284 Links List Get .................................................................................................................................... 285 Links Create ...................................................................................................................................... 288 Links Set ........................................................................................................................................... 293

7 マルチリンク ..................................................................................................................................... 300 Multi Links Page Get ......................................................................................................................... 301 Multi Links Set .................................................................................................................................. 304 Multi Links Update ........................................................................................................................... 308

8 文書のコメント ................................................................................................................................. 313 Documents Comments Get ............................................................................................................. 314 Documents Comments Add ............................................................................................................ 317

9 ページメモ ........................................................................................................................................ 319 PageMemo Get ................................................................................................................................. 320 PageMemo Get（Ver. 2） ................................................................................................................. 322 PageMemo Update ........................................................................................................................... 325

10 フォルダー操作 ............................................................................................................................... 329 Folders Lookup ................................................................................................................................ 330 Folders All ......................................................................................................................................... 333 Folders All（Ver. 2） ......................................................................................................................... 337 Folders List ....................................................................................................................................... 341 Folders List（Ver. 2） ....................................................................................................................... 345 Folders Open List ............................................................................................................................. 349 Folders Open List（Ver. 2） ............................................................................................................. 355 Folders Get ....................................................................................................................................... 362 Folders Get（Ver. 2） ....................................................................................................................... 365 Folders Info Get ................................................................................................................................ 368

目次

4

Folders Create .................................................................................................................................. 371 Folders Create（Ver. 2） .................................................................................................................. 374 Folders Rename ............................................................................................................................... 377 Folders Rename（Ver. 2） ............................................................................................................... 381

11 フォルダーショートカット ............................................................................................................. 385 Shortcuts List ................................................................................................................................... 386 Shortcuts List（Ver. 2） ................................................................................................................... 389 Shortcuts Create .............................................................................................................................. 392 Shortcuts Create（Ver. 2） .............................................................................................................. 396 Shortcuts Rename ........................................................................................................................... 400 Shortcuts Delete ............................................................................................................................... 402

12 ごみ箱 ............................................................................................................................................. 404 Trashbox List .................................................................................................................................... 405 Trashbox List（Ver. 2） .................................................................................................................... 409 Trashbox List（Ver. 3） .................................................................................................................... 413 Trashbox Restore .............................................................................................................................. 417 Trashbox Clear .................................................................................................................................. 419 Trashbox Clear（Ver. 2） ................................................................................................................. 421

13 ユーザー情報操作 ........................................................................................................................... 423 Users Lookup .................................................................................................................................... 424 Users List .......................................................................................................................................... 427 Users List（Ver. 2） .......................................................................................................................... 431 Users Group List ............................................................................................................................... 436 Users Group List（Ver. 2） ............................................................................................................... 440 Users Get .......................................................................................................................................... 444 Users Get（Ver. 2） .......................................................................................................................... 447 Users Authorities .............................................................................................................................. 450 Users Authorities（Ver. 2） ............................................................................................................. 454 Users Authorities（Ver. 3） ............................................................................................................. 458 Users Authorities（Ver. 4） ............................................................................................................. 463 Users Create ..................................................................................................................................... 468 Users Create（Ver. 2） ..................................................................................................................... 473 Users Update .................................................................................................................................... 478 Users Update（Ver. 2） .................................................................................................................... 482 Users Delete...................................................................................................................................... 486

14 グループ情報操作 ........................................................................................................................... 488 Groups Lookup ................................................................................................................................. 489 Groups List ........................................................................................................................................ 492

目次

5

Groups List（Ver. 2） ....................................................................................................................... 496 Groups Role List ............................................................................................................................... 500 Groups Role List（Ver. 2） ............................................................................................................... 503 Groups Get ........................................................................................................................................ 506 Groups Get（Ver. 2） ....................................................................................................................... 509 Groups Create ................................................................................................................................... 512 Groups Create（Ver. 2） .................................................................................................................. 516 Groups Update ................................................................................................................................. 521 Groups Update（Ver. 2） ................................................................................................................. 526 Groups Delete ................................................................................................................................... 531

15 ロール情報操作 ............................................................................................................................... 533 Roles Lookup .................................................................................................................................... 534 Roles List ........................................................................................................................................... 537 Roles List（Ver. 2） .......................................................................................................................... 543 Roles List（Ver. 3） .......................................................................................................................... 549 Roles List（Ver. 4） .......................................................................................................................... 555 Roles Get ........................................................................................................................................... 561 Roles Get（Ver. 2） .......................................................................................................................... 566 Roles Get（Ver. 3） .......................................................................................................................... 571 Roles Get（Ver. 4） .......................................................................................................................... 576 Roles Create ...................................................................................................................................... 581 Roles Create（Ver. 2） ..................................................................................................................... 589 Roles Create（Ver. 3） ..................................................................................................................... 597 Roles Create（Ver. 4） ..................................................................................................................... 605 Roles Update .................................................................................................................................... 614 Roles Update（Ver. 2） .................................................................................................................... 621 Roles Update（Ver. 3） .................................................................................................................... 628 Roles Update（Ver. 4） .................................................................................................................... 635 Roles Delete ...................................................................................................................................... 642

16 ドメイン情報操作 ........................................................................................................................... 644 Domains List ..................................................................................................................................... 645 Domains Create ................................................................................................................................ 650 Domains Update .............................................................................................................................. 655 Domains Default Update ................................................................................................................. 660 Domains Delete ................................................................................................................................ 662

17 アクセス権 ...................................................................................................................................... 664 Permission Get ................................................................................................................................. 665 Permission Get（Ver. 2） ................................................................................................................. 669

目次

6

Permission Get（Ver. 3） ................................................................................................................. 675 Permission Update........................................................................................................................... 681 Permission Update（Ver. 2） .......................................................................................................... 686 Permission Update（Ver. 3） .......................................................................................................... 693

18 透かし設定 ...................................................................................................................................... 701 Watermark Get ................................................................................................................................. 702 Watermark Image Get ...................................................................................................................... 706 Watermark Update ........................................................................................................................... 708

19 暗号化設定 ...................................................................................................................................... 713 Encryption Get ................................................................................................................................. 714 Encryption Update ........................................................................................................................... 718

20 フォルダーへの文書管理ポリシー設定 ........................................................................................... 723 FolderPolicy Get ............................................................................................................................... 724 FolderPolicy Get（Ver. 2） ............................................................................................................... 729 FolderPolicy Update ........................................................................................................................ 734 FolderPolicy Update（Ver. 2） ........................................................................................................ 739 FolderPolicy Update（Ver. 3） ........................................................................................................ 745

21 データの保存先情報取得 ................................................................................................................ 751 Storage Settings Get ........................................................................................................................ 752

22 カスタムプロパティ操作 ................................................................................................................ 756 Custom Properties List .................................................................................................................... 757 Custom Properties List（Ver. 2） .................................................................................................... 763 Custom Properties Create ............................................................................................................... 769 Custom Properties Create（Ver. 2） ............................................................................................... 776 Custom Property Documents Set.................................................................................................... 784 Custom Properties Update .............................................................................................................. 788 Custom Properties Update（Ver. 2） .............................................................................................. 794 Custom Properties Delete ................................................................................................................ 800 カスタムプロパティ一括更新用ファイルの書式 .............................................................................. 802

23 マスク情報取得 ............................................................................................................................... 806 Masks List ......................................................................................................................................... 807

24 レビューテンプレート情報取得 ...................................................................................................... 810 Review Templates List ..................................................................................................................... 811 Review Templates List（Ver. 2） ..................................................................................................... 815

25 アーカイブ ...................................................................................................................................... 827 Archives Add ..................................................................................................................................... 828

26 文書定義 .......................................................................................................................................... 835 DocType Lookup .............................................................................................................................. 836

目次

7

DocType List ..................................................................................................................................... 839 DocType List（Ver. 2） ..................................................................................................................... 843 DocType Get ..................................................................................................................................... 847 DocType Get（Ver. 2） ..................................................................................................................... 853 DocType Create ................................................................................................................................ 859 DocType Create（Ver. 2） ................................................................................................................ 866 DocType Update ............................................................................................................................... 873 DocType Update（Ver. 2） .............................................................................................................. 880 DocType Update（Ver. 3） .............................................................................................................. 887 DocType Delete ................................................................................................................................ 895

27 タイムスタンプ操作 ........................................................................................................................ 897 Timestamp Verify ............................................................................................................................. 898

28 マスクの適用 ................................................................................................................................... 902 Mask Apply ....................................................................................................................................... 903 Mask Apply（Ver. 2） ....................................................................................................................... 906 Mask Apply Search Result ................................................................................................................ 911

29 SVF 検索フィールド ........................................................................................................................ 921 SearchFields List .............................................................................................................................. 922 SearchFields Get .............................................................................................................................. 928 SearchFields Parse PDF ................................................................................................................... 932 SearchFields Parse Form ................................................................................................................. 935

30 SVF 検索フィールドデータの CSV ファイル出力 ........................................................................... 938 Request Search Data Csv From Documents ................................................................................... 939 Request Search Data Csv From Documents（Ver. 2） ................................................................... 946 Request Search Data Csv From Documents（Ver. 3） ................................................................... 953 Request Search Data Csv From Documents（Ver. 4） ................................................................... 960 Request Search Data Csv From Documents（Ver. 5） ................................................................... 967 Request Search Data Csv From Search Results .............................................................................. 975 Request Search Data Csv From Search Results（Ver. 2） .............................................................. 993 Request Search Data Csv From Search Results（Ver. 3） ............................................................ 1011 Request Search Data Csv From Search Results（Ver. 4） ............................................................ 1029 Request Search Data Csv From Search Results（Ver. 5） ............................................................ 1047 Output Search Data Csv Status ..................................................................................................... 1066 Output Search Data Csv Get .......................................................................................................... 1069

31 追跡記録 ........................................................................................................................................ 1071 Records List .................................................................................................................................... 1072 Records List（Ver. 2） .................................................................................................................... 1077

32 削除記録 ........................................................................................................................................ 1083

目次

8

DeleteRecords List ......................................................................................................................... 1084 DeleteRecords List（Ver. 2） ......................................................................................................... 1088 DeleteRecords List（Ver. 3） ......................................................................................................... 1092

33 証跡確認 ........................................................................................................................................ 1096 Upload File Trail Get....................................................................................................................... 1097 Trail Get........................................................................................................................................... 1101 Trail Update .................................................................................................................................... 1104

34 セッション管理 ............................................................................................................................. 1107 Session Current Get ....................................................................................................................... 1108 Session Current Get（Ver. 2） ....................................................................................................... 1110

35 メンテナンスモード設定 .............................................................................................................. 1112 Maintenance Mode Status Get....................................................................................................... 1113 Maintenance Mode Status Update ................................................................................................ 1115

36 サーバー情報の取得 ...................................................................................................................... 1117 Config Version ................................................................................................................................ 1118 Config Activation ............................................................................................................................ 1123

37 フォルダーへの通知の設定 ........................................................................................................... 1126 Event Notification Get .................................................................................................................... 1127 Event Notification Update ............................................................................................................. 1139

38 ページ操作 .................................................................................................................................... 1145 Pages Rotate ................................................................................................................................... 1146

第 2 章 Web アプリケーションの拡張 ........................................................................................... 1150 1 文書を指定してプレビュー画面を開く ........................................................................................... 1151 2 フォルダーを指定してユーザー画面を開く ................................................................................... 1153 3 POST で送信されたログイン情報で自動ログインする .................................................................. 1155

改訂履歴 ......................................................................................................................................... 1156 他バージョンのマニュアル ............................................................................................................. 1167

本マニュアルについて

9

本マニュアルについて SPA が提供する Web API を使用すると、アプリケーションから SPA のさまざまな機能を利用することができ

ます。

本マニュアルは、SPA が提供する Web API のリファレンスです。

▌マニュアルの体系

SPA には以下のマニュアルがあります。

マニュアル名概要対象読者

管理者ガイド SPA を理解する上で必要な概念や、設定、運用に関する手順につ

いて説明します。

開発者、管理者

セットアップガイド SPA、Loader サービスおよび Document Converter のセットアッ

プ手順について説明します。

開発者

Web API リファレンス SPA が提供する Web API のリファレンスです。開発者

利用者ガイド（Web ブラウ

ザー編）

SPA に保存されている文書を、Web ブラウザーから利用する手順

について説明します。

パワーユーザー

利用者ガイド（タブレット

編）

SPA に保存されている文書を、タブレットから利用する手順につ

いて説明します。

一般利用者

データマイグレーションガ

イド

SVF PDF Archiver Ver. 9.2 および SVF PDF Loader Ver. 9.2 のデー

タを、SPA Ver. 9.3 で利用するために必要な作業や、データマイ

グレーションの仕様について説明します。

開発者、管理者

▌マニュアル内で使用する表記

マニュアル内で使用する表記について説明します。

■ 注意、参考、制限

マニュアル内では、注意、参考、制限を次のように区別して記載しています。

注意操作によって元の状態に戻れなくなる場合や、元の状態に戻るのが難しい場合に、このパーツで示します。

参考製品を使用する上での補足情報をこのパーツで示します。

本マニュアルについて

10

制限事項製品の制限をこのパーツで示します。

■ 記号

マニュアル内で使用する記号の意味は、次のとおりです。

記号表記例意味

［］［ファイル］メニュー製品画面に表示されている項目名やメニュー名を表します。OS

や他社製品の項目名やメニュー名も同様に表します。

http:// URL やファイル名の一部など、環境によって変わる文字列を表

します。

▌商標

本製品では、ABBYY 社の OCR エンジンを使用しています。

本マニュアルに記載されている社名および商品名等の名称は、各社の商標または登録商標です。

▌著作権

(C) 2013 WingArc1st Inc. All rights reserved.

▌その他

本マニュアルの内容は予告なく変更することがあります。

▌発行

2016 年 5 月 30 日初版

2019 年 6 月 28 日第 8 版（Service Pack 7 対応）

▌改訂履歴

マニュアル修正（誤記や誤解を招く表記の修正）の履歴については、下記のページを参照してください。

改訂履歴(P.1156)

第 1 章 SPA Web API リファレンス

11

第 1 章 SPA Web API リファレンス SPAWeb API は、SPA の機能をユーザーアプリケーションで利用できる Web API として提供するものです。

本章では、提供する各 Web API の詳細を説明します。

▌使用例について

Web API の使用例については、製品添付のサンプルを参照してください。

なお、サンプルプログラムをコンパイルするには以下の指定が必要です。

• コンパイルオプションとして「-encoding UTF-8」を指定 • ¥archiver¥sample フォルダー内の以下の JAR ファイルをクラスパスに指定

（は、SPA のインストール先のフォルダーです）

￮ jackson-annotations-2.3.2.jar

￮ jackson-core-2.3.2.jar

￮ jackson-databind-2.3.2.jar

▌提供する Web API 一覧

提供する Web API は以下のとおりです。

Web API は、Service Pack による機能の追加に応じて新たに追加されたり、バージョンがあがったりしま

す。

すべての Web API が SPA 本体のバージョンアップに従ってバージョンアップするわけではありません。その

ため、ユーザープログラムを作成、更新する場合は、下記の Web API 一覧を参考にして使用する SPA の

Service Pack に対応した Web API を使用してください。なお、ユーザーアプリケーションには、使用する

Service Pack 以前に対応した Web API も使用できますが、新機能（追加された機能）には対応しません。

参考アクセスログには、Web API のバージョンは出力されません。アクセスログについては、『管理者ガイド』の「運用

設定編」の「8-6-3 アクセスログ」を参照してください。

■ 認証

Web API 対応した Service Pack 概要

Auth Login(P.28) - SPA にログインします。

Auth Logout(P.30) - SPA からログアウトします。

Auth Password(P.31) - SPA へのログインパスワードを設定します。


12


Auth Password Change(P.33) - ログイン中のユーザーのパスワードを変更します。

■ 検索


Search Documents(P.36) - 検索項目を指定して、文書を検索します。

Search Documents（Ver. 2）(P.53) 1 検索項目を指定して、文書を検索します。




Search In-document(P.130) - 文書内を全文検索します。

Search Cancel(P.133) - 現在のセッションで実行中の検索処理を中止

（キャンセル）します。

■ プレビュー


Preview Get(P.135) - プレビュー用の画像を取得します。

Preview Get（Ver. 2）(P.137) 2 プレビュー用の画像を取得します。

Preview Get（Ver. 3）(P.140) 5 プレビュー用の画像を取得します。

Highlight Get(P.144) - 指定したページに対するハイライト用の注釈を取得し

ます。

Highlight Get（Ver. 2）(P.152) 1 指定したページに対するハイライト用の注釈を取得し

ます。

■ ダウンロード


Download Document(P.161) - 指定した単一のファイルをダウンロード

します。

Download Raw Document(P.165) - 指定した単一のファイルを無加工ダウン

ロードします。

Download Print Document(P.167) - 指定した単一の印刷用ファイルをダウン



13


Download Packed Documents(P.170) - 指定した複数のファイルをダウンロード

します。

Download Packed Raw Documents(P.174) - 指定した複数のファイルを無加工ダウン


Download Packed Print Documents(P.177) 4 指定した複数の印刷用ファイルをダウン


■ ファイル操作


Documents Lookup(P.182) - ファイル名から ID を取得します。

Documents List(P.185) - 指定したフォルダー直下のファイル、リン

ク、フォルダーの一覧を取得します。取得す

る情報は、パラメーターで選択できます。

Documents List（Ver. 2）(P.192) 1 指定したフォルダー直下のファイル、リン












Documents Get(P.225) - 指定した文書の詳細情報（メタ情報）とカス

タムプロパティの情報を取得します。

Documents Get（Ver. 2）(P.231) 1 指定した文書の詳細情報（メタ情報）とカス







14




Documents Rename(P.262) - ファイル名を変更します。

Documents Move List(P.265) - 指定したファイルとフォルダーをまとめて別

のフォルダーに移動します。

Documents Move List（Ver. 2）(P.268) 1 指定したファイルとフォルダーをまとめて別

のフォルダーに移動します。

Documents Delete List(P.272) - 指定したファイルとフォルダーをまとめて削

除します。

Documents History List(P.276) 2 指定した文書のバージョン管理の履歴一覧を

取得します。

Documents Restore(P.281) 2 指定したバージョンの文書に復元します。

■ リンク操作


Links List Get(P.285) - 指定された文書を参照しているリンクの一覧を取得します。

Links Create(P.288) - リンクの作成とカスタムプロパティ値の更新を行います。

Links Set(P.293) - 1 つの文書から複数のリンクを作成します。

■ マルチリンク


Multi Links Page Get(P.301) - マルチリンクのページ情報を取得します。

Multi Links Set(P.304) - マルチリンクを作成します。

Multi Links Update(P.308) - マルチリンクの構成を変更します。

■ 文書のコメント


Documents Comments Get(P.314) - 指定した文書のコメントを取得します。

Documents Comments Add(P.317) - 指定した文書にコメントを追加します。


15

■ ページメモ


PageMemo Get(P.320) - 指定したページのページメモの情報を取得します。

PageMemo Get（Ver. 2）(P.322) 2 指定したページのページメモの情報を取得します。

PageMemo Update(P.325) - 指定したページのページメモの情報を更新します。

■ フォルダー操作


Folders Lookup(P.330) - フォルダー名からフォルダーID を取得します。

Folders All(P.333) - すべてのフォルダー情報のリストを取得します。

Folders All（Ver. 2）(P.337) 1 すべてのフォルダー情報のリストを取得します。

Folders List(P.341) - 指定したフォルダー直下にあるフォルダーのリストを

取得します。

Folders List（Ver. 2）(P.345) 1 指定したフォルダー直下にあるフォルダーのリストを

取得します。

Folders Open List(P.349) - 指定したフォルダーまで展開したフォルダーのリスト

を取得します。

Folders Open List（Ver. 2）

(P.355)

1 指定したフォルダーまで展開したフォルダーのリスト


Folders Get(P.362) - 指定したパスのフォルダー情報を取得します。

Folders Get（Ver. 2）(P.365) 1 指定したパスのフォルダー情報を取得します。

Folders Info Get(P.368) - 指定したフォルダー内に含まれるフォルダーやファイ

ルなどの概要情報を取得します。

Folders Create(P.371) - フォルダーを作成します。

Folders Create（Ver. 2）

(P.374)

1 フォルダーを作成します。

Folders Rename(P.377) - フォルダーの名称を変更します。

Folders Rename（Ver. 2）

(P.381)

1 フォルダーの名称を変更します。


16

■ フォルダーショートカット

Web API 対応した Service

Pack

概要

Shortcuts List(P.386) - ログインしているユーザーのフォルダーショートカットの一

覧を取得します。

Shortcuts List（Ver. 2）

(P.389)

1 ログインしているユーザーのフォルダーショートカットの一

覧を取得します。

Shortcuts Create(P.392) - ログインしているユーザーのフォルダーショートカットを作

成します。

Shortcuts Create（Ver. 2）

(P.396)

1 ログインしているユーザーのフォルダーショートカットを作

成します。

Shortcuts Rename(P.400) - ログインしているユーザーの、指定されたフォルダーショー

トカットの名前を変更します。

Shortcuts Delete(P.402) - ログインしているユーザーの、指定されたフォルダーショー

トカットを削除します。

■ ごみ箱


Pack

概要

Trashbox List(P.405) - ログインしているユーザーのごみ箱にあるフォルダーおよびファ

イルの一覧を取得します。

Trashbox List（Ver. 2）

(P.409)

1 ログインしているユーザーのごみ箱にあるフォルダーおよびファ


Trashbox List（Ver. 3）

(P.413)

4 ログインしているユーザーのごみ箱にあるフォルダーおよびファ


Trashbox

Restore(P.417)

- ログインしているユーザーのごみ箱から、指定したフォルダーま

たはファイルを戻します。

Trashbox Clear(P.419) - ログインしているユーザーのごみ箱を空にします。ごみ箱管理者

の場合は、すべてのユーザーのごみ箱を空にします。

Trashbox Clear（Ver.

2）(P.421)

1 ログインしているユーザーのごみ箱を空にします。


17

■ ユーザー情報操作


Pack

概要

Users Lookup(P.424) - ドメイン名とユーザー名からユーザーID を取得しま

す。

Users List(P.427) - ユーザー情報のリストを取得して返します。

Users List（Ver. 2）(P.431) 3 ユーザー情報のリストを取得して返します。

Users Group List(P.436) - 指定されたグループに含まれるユーザー情報のリストを

返します。

Users Group List（Ver. 2）

(P.440)

3 指定されたグループに含まれるユーザー情報のリストを

返します。

Users Get(P.444) - 指定された対象ユーザーの内部 ID（ユーザーID）を持

つユーザーの情報を取得します。

Users Get（Ver. 2）(P.447) 3 指定された対象ユーザーの内部 ID（ユーザーID）を持

つユーザーの情報を取得します。

Users Authorities(P.450) - 指定されたユーザーに許可されたすべての操作の権限

ID 番号を取得します。

Users Authorities（Ver. 2）

(P.454)

1 指定されたユーザーに許可されたすべての操作の権限



(P.458)




(P.463)



Users Create(P.468) - 指定されたユーザーを作成し、指定されたグループに登

録します。

Users Create（Ver. 2）(P.473) 3 指定されたユーザーを作成し、指定されたグループに登

録します。

Users Update(P.478) - 指定された内容でユーザー情報を更新します。

Users Update（Ver. 2）(P.482) 3 指定された内容でユーザー情報を更新します。

Users Delete(P.486) - 指定されたユーザーID を持つユーザー情報を削除しま

す。


18

■ グループ情報操作


Pack

概要

Groups Lookup(P.489) - ドメイン名とグループ名からグループの ID を取得しま

す。

Groups List(P.492) - グループ情報のリストを取得して返します。

Groups List（Ver. 2）(P.496) 3 グループ情報のリストを取得して返します。

Groups Role List(P.500) - 指定されたロールが含まれるグループ情報のリストを返

します。

Groups Role List（Ver. 2）

(P.503)

3 指定されたロールが含まれるグループ情報のリストを返

します。

Groups Get(P.506) - 指定された ID を持つグループの情報を取得します。

Groups Get（Ver. 2）(P.509) 3 指定された ID を持つグループの情報を取得します。

Groups Create(P.512) - 指定されたグループを作成します。

Groups Create（Ver. 2）(P.516) 3 指定されたグループを作成します。

Groups Update(P.521) - 指定された内容でグループ情報を更新します。

Groups Update（Ver. 2）(P.526) 3 指定された内容でグループ情報を更新します。

Groups Delete(P.531) - 指定された ID を持つグループの情報を削除します。

■ ロール情報操作


Pack

概要

Roles Lookup(P.534) - ロール名からロールの ID を取得します。

Roles List(P.537) - カスタムロールの詳細情報のリストを取得して返しま

す。

Roles List（Ver. 2）(P.543) 1 カスタムロールの詳細情報のリストを取得して返しま

す。


す。


す。

Roles Get(P.561) - 指定された ID を持つロールの情報を取得します。


19


Pack

概要

Roles Get（Ver. 2）(P.566) 1 指定された ID を持つロールの情報を取得します。



Roles Create(P.581) - 指定されたロールを作成します。

Roles Create（Ver. 2）(P.589) 1 指定されたロールを作成します。



Roles Update(P.614) - 指定された内容でロールの権限に関する情報を更新しま

す。

Roles Update（Ver. 2）(P.621) 1 指定された内容でロールの権限に関する情報を更新しま

す。


す。


す。

Roles Delete(P.642) - 指定された ID を持つロールの情報を削除します。

■ ドメイン情報操作


Domains List(P.645) - ドメイン名のリストを取得します。

Domains Create(P.650) - ドメイン設定を作成します。

Domains Update(P.655) - 指定されたドメイン設定を更新します。

Domains Default Update(P.660) - デフォルトドメインの ID を設定します。

Domains Delete(P.662) - 指定されたドメイン設定を削除します。

■ アクセス権


Pack

概要

Permission Get(P.665) - 指定したフォルダーのアクセス権の情報を取得します。


20


Pack

概要

Permission Get（Ver. 2）

(P.669)

1 指定したフォルダーのアクセス権の情報を取得します。

Permission Get（Ver. 3）

(P.675)

3 指定したフォルダーのアクセス権の情報を取得します。

Permission Update(P.681) - 指定したフォルダーのアクセス権をすべてのグループに一括

して設定します。

Permission Update（Ver.

2）(P.686)

1 指定したフォルダーのアクセス権をすべてのグループおよび

すべてのユーザーに一括して設定します。

Permission Update（Ver.

3）(P.693)

3 指定したフォルダーのアクセス権をすべてのグループおよび

すべてのユーザーに一括して設定します。

■ 透かし設定


Pack

概要

Watermark Get(P.702) - 指定したフォルダーの透かしに関する設定を取得します。

Watermark Image

Get(P.706)

- 指定したフォルダーに透かし画像が設定されていた場合、その

画像を取得します。

Watermark

Update(P.708)

- 指定したフォルダーに透かしを設定します。

■ 暗号化設定


Pack

概要

Encryption

Get(P.714)

- 指定したフォルダーの暗号化設定に関する情報を取得します。

Encryption

Update(P.718)

- フォルダー内の PDF ファイルに適用するセキュリティ情報（パス

ワード、暗号化など）を、フォルダーに設定します。


21

■ フォルダーへの文書管理ポリシー設定


Pack

概要

FolderPolicy Get(P.724) - 指定したフォルダーの文書管理ポリシーの設定情報


FolderPolicy Get（Ver. 2）(P.729) 2 指定したフォルダーの文書管理ポリシーの設定情報


FolderPolicy Update(P.734) - 指定した内容で、フォルダーの文書管理ポリシーの

設定を変更します。

FolderPolicy Update（Ver. 2）

(P.739)

1 指定した内容で、フォルダーの文書管理ポリシーの


FolderPolicy Update（Ver. 3）

(P.745)

2 指定した内容で、フォルダーの文書管理ポリシーの


■ データの保存先情報取得


Storage Settings Get(P.752) - データの保存先の設定情報を取得します。

■ カスタムプロパティ操作


Custom Properties List(P.757) - 存在するすべてのカスタムプロパティの構

成情報のリストを返します。

Custom Properties List（Ver. 2）(P.763) 2 存在するすべてのカスタムプロパティの構

成情報のリストを返します。

Custom Properties Create(P.769) - カスタムプロパティを作成します。

Custom Properties Create（Ver. 2）(P.776) 2 カスタムプロパティを作成します。

Custom Property Documents Set(P.784) - 指定した文書に対して、カスタムプロパ

ティのすべての値を更新します。

Custom Properties Update(P.788) - 指定されたカスタムプロパティの属性を変

更します。

Custom Properties Update（Ver. 2）(P.794) 2 指定されたカスタムプロパティの属性を変

更します。


22


Custom Properties Delete(P.800) - 指定されたカスタムプロパティを削除しま

す。

■ マスク情報取得


Masks List(P.807) - マスク（マスクのパターン）の一覧を取得します。

■ レビューテンプレート情報取得


Review Templates List(P.811) - すべてのレビューテンプレートの情報を取得します。

Review Templates List（Ver.

2）(P.815)

3 すべてのレビューテンプレートの情報を取得します。

■ アーカイブ


Archives Add(P.828) - 文書を指定したフォルダーにアーカイブします。

■ 文書定義


DocType Lookup(P.836) - 文書定義 ID から文書定義管理 ID（文書定義に自動で

割り振られる固有の ID）を取得します。

DocType List(P.839) - 文書定義の一覧を取得します。

DocType List（Ver. 2）(P.843) 2 文書定義の一覧を取得します。

DocType Get(P.847) - 指定した文書定義を取得します。

DocType Get（Ver. 2）(P.853) 2 指定した文書定義を取得します。

DocType Create(P.859) - 指定した文書定義を作成します。

DocType Create（Ver. 2）(P.866) 2 指定した文書定義を作成します。

DocType Update(P.873) - 指定した文書定義の内容を更新します。また、その

文書定義に属するすべての SVF 検索フィールドの情

報も一括で更新します。


23


DocType Update（Ver. 2）(P.880) 1 指定した文書定義の内容を更新します。また、その



DocType Update（Ver. 3）(P.887) 2 指定した文書定義の内容を更新します。また、その



DocType Delete(P.895) - 指定した文書定義を削除します。また、その文書定

義に属する SVF 検索フィールドもすべて削除されま

す。

■ タイムスタンプ操作


Pack

概要

Timestamp

Verify(P.898)

- 指定した文書に対してタイムスタンプのベリファイを実行しま

す。

■ マスクの適用


Pack

概要

Mask Apply(P.903) - マスクを文書に適用します。

Mask Apply（Ver. 2）(P.906) 1 マスク（マスクのパターン）または任意の矩形情報

を指定して、マスクを文書に適用します。

Mask Apply Search Result(P.911) 1 検索条件に合致した部分にマスクを適用します。

■ SVF 検索フィールド


Pack

概要

SearchFields List(P.922) - 指定した条件に合致する SVF 検索フィールドの一覧を取

得します。

SearchFields Get(P.928) - 指定した条件に合致する SVF 検索フィールドを取得しま

す。

SearchFields Parse PDF(P.932) - PDF ファイルを解析して SVF 検索フィールドを取得しま

す。


24


Pack

概要

SearchFields Parse Form(P.935) - 様式ファイルを解析して SVF 検索フィールドを取得しま

す。

■ SVF 検索フィールドデータの CSV ファイル出力


Request Search Data Csv From

Documents(P.939)

1 指定した文書内にある SVF 検索フィールドデータ

を対象として、CSV データの作成を依頼します。


Documents（Ver. 2）(P.946)












Search Results(P.975)

1 検索でヒットした文書内にある SVF 検索フィール

ドデータを対象として、CSV データの作成を依頼し

ます。


Search Results（Ver. 2）(P.993)



ます。





ます。





ます。

Output Search Data Csv

Status(P.1066)

1 ログインしているユーザーの CSV データ作成状況

の一覧を取得します。

Output Search Data Csv

Get(P.1069)

1 指定した受付番号に対応する、SVF 検索フィールド

データの CSV ファイル（ZIP ファイルに圧縮された

もの）を取得します。


25

■ 追跡記録


Records List(P.1072) - 指定された文書の追跡記録を取得します。

Records List（Ver. 2）(P.1077) 1 指定された文書の追跡記録を取得します。

■ 削除記録


DeleteRecords List(P.1084) - 削除履歴の一覧を取得します。

DeleteRecords List（Ver. 2）(P.1088) 1 削除履歴の一覧を取得します。

DeleteRecords List（Ver. 3）(P.1092) 4 削除履歴の一覧を取得します。

■ 証跡確認


Pack

概要

Upload File Trail

Get(P.1097)

- PDF ファイルをアップロードし、埋め込まれている証跡情報を

取得します。

Trail Get(P.1101) - ダウンロード時に埋め込む証跡情報に関する設定値を取得しま

す。

Trail Update(P.1104) - ダウンロード時に埋め込む証跡情報について設定します。

■ セッション管理


Pack

概要

Session Current Get(P.1108) - 現在ログイン中のユーザーに関するセッション情

報を取得します。

Session Current Get（Ver. 2）(P.1110) 1 現在ログイン中のユーザーに関するセッション情

報を取得します。

■ メンテナンスモード設定


Maintenance Mode Status Get(P.1113) - メンテナンスモードの状態を取得します。

Maintenance Mode Status Update(P.1115) - メンテナンスモードの状態を更新します。


26

■ サーバー情報の取得


Pack

概要

Config

Version(P.1118)

- SPA（アーカイブサーバー、Web アプリケーションサーバー、検索

サーバー、Loader サーバー）のバージョンを取得します。

Config

Activation(P.1123)

- SPA のアクティベーション情報を取得します。

■ フォルダーへの通知の設定


Event Notification Get(P.1127) 3 指定したフォルダーの通知の設定を取得します。

Event Notification Update(P.1139) 3 指定したフォルダーの通知の設定を変更します。

■ ページ操作


Pages Rotate(P.1146) 5 指定したページの回転について設定します。


27

1 認証認証に関する API は、次のとおりです。

• Auth Login(P.28) • Auth Logout(P.30) • Auth Password(P.31) • Auth Password Change(P.33)


28

Auth Login SPA にログインします。

URI

http://:44230/pdfarchiver/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 正常に終了しています。

401 -1 ユーザー認証に失敗した場合に出力されます。


29


401 -3 自動ログインでのユーザー認証に失敗した場合に出力されます。自動ログイ

ンのためのユーザー認証情報が不正な場合です。

403 -20012 ログイン済みの状態で別のユーザーID を使ってログインしようとした場合に

出力されます。

403 -9800 ライセンスエラーが発生した場合に出力されます。

403 -9801 ライセンスの有効期限切れの場合に出力されます。

403 -9803 タブレットオプションがないにもかかわらず、タブレットからログインしよ

うとした場合に出力されます。

500 - サーバー側の処理が失敗したときのレスポンスです。「HTTP/1.1 500 Internal

Server Error」が返ります。

エラーコードが取得可能な場合は、そのエラーコードを返します。それ以外

は-5000 を返します。


30

Auth Logout SPA からログアウトします。

URI

http://:44230/pdfarchiver/service/auth/logout

HTTP メソッド

POST

▌その他の注意事項 • ログインしている必要があります。

▌レスポンス





X-Spa-User ログアウトしたユーザーID 値は URL エンコードされます。




401 -20013 次のいずれかの場合に発生します。

• ログインしていないのにログアウトしようとした場合 • ログインしていない状態でリクエストが来た場合






31

Auth Password SPA へのログインパスワードを設定します。

URI

http://:44230/pdfarchiver/service/auth/password/

• キーキー必須値備考

id 変更対象のユーザーの内部 ID

HTTP メソッド

PUT





password 新しいログインパスワード


▌レスポンス






32




403 -10 対象の操作を行う権限が付与されていない場合に出力されます。

400 -11 ログイン済みのユーザーがログイン状態のまま削除された場合に出力されま

す。

503 -9996 メンテナンスモード中のため操作できない場合に出力されます。




• パスワードの指定がない場合 • パスワードに使用できない文字を指定した場合 • パスワードに使用可能な長さを超えた場合

400 -20505 ユーザーID が指定されていない場合に出力されます。ユーザーID に負の値が

指定された場合です。






33

Auth Password Change ログイン中のユーザーのパスワードを変更します。

URI

http://:44230/pdfarchiver/service/auth/password

HTTP メソッド

PUT





password 現在のログインパスワード

newPassword 新しいログインパスワード


▌レスポンス









34


400 -1 ユーザー認証に失敗した場合に出力されます。現在のログインパスワードの

指定が間違っている場合です。

403 -10 対象の操作を行う権限が付与されていない場合に出力されます。本 API で

は、ログイン中のユーザーが「ユーザープロファイル」の操作権限がない場

合に出力されます。

400 -11 ログイン済みのユーザーがログイン状態のまま削除された場合に出力されま

す。本 API では、ログイン中のユーザーが削除された場合に出力されます。

503 -9996 メンテナンスモード中のため操作できない場合に出力されます。




• パスワードの指定がない場合 • パスワードに使用できない文字を指定した場合 • パスワードに使用可能な長さを超えた場合






35

2 検索検索に関する API は、次のとおりです。

• Search Documents(P.36) • Search Documents（Ver. 2）(P.53) • Search Documents（Ver. 3）(P.72) • Search Documents（Ver. 4）(P.91) • Search Documents（Ver. 5）(P.110) • Search In-document(P.130) • Search Cancel(P.133)


36

Search Documents 検索項目を指定して、文書を検索します。

URI

http://:44230/pdfarchiver/service/search/

• キーキー必須値備考

id 検索対象フォルダーの ID

HTTP メソッド

POST


application/json

▌オブジェクト

オブジェクトの例（JSON 形式）

{

"searchWord": "type == 1",

"operator": "AND",

"recursive": true,

"conditions": [

{

"conditionType": "system",

"name": "name",

"value": "document.pdf",

"type": "equals"

},

{

"conditionType": "system",

"name": "filetype",


37


"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": "field1",

"docTypeId": "1",


"dataType": "numeric",


38


"min": "1",

"max": "10"

},

...

{

"conditionType": "details",

"name": "field1",

"docTypeId": "1",


"dataType": "date",

"dateFormat": 1,

"offset": "9",

"detailsConditions": [

{

"from": "19700101090000",

"to": "19700101180000"

},

{

"from": "19710101090000",

"to": "19710101180000"

},

...

]

},

{

"conditionType": "details",

"name": "field1",

"docTypeId": "1",


"dataType": "numeric",

"detailsConditions": [

{


39


"min": "1",

"max": "10",

},

{

"min": "100",

"max": "110",

},

...

]

},

...

],

"properties": [

"name",

"docpath",

"hitpages",

...

],

"customProperties": [

"1",

"2",

...

]

}

■ データ内容

• 指定する要素の種類


searchWord （*1）文字列全文検索の対象となる文字列を指定します。

operator AND conditions 要素の各検索条件の連結方法を「すべてに一致」と

します。

指定されていない場合は、AND が指定されたものとします。


40


OR conditions 要素の各検索条件の連結方法を「いずれかに一致」

とします。

recursive true サブフォルダーも検索します。

指定されていない場合は、true が指定されたものとします。

false サブフォルダーは検索しません。

conditions （*1）各検索条件のリスト

検索条件の種類は、conditionType の値で指定します。

• system 文書プロパティ

• custom カスタムプロパティ

• svfField SVF 検索フィールド

• details 明細検索

properties 検索結果で取得するシステムプロパティの項目のリスト

指定されていない場合は、すべてのシステムプロパティを取得し

ます。

customProperties 検索結果で取得するカスタムプロパティの ID のリスト

指定がない場合は取得しません。

*1 どちらか 1 つの指定が必須です。

• 文書プロパティの検索条件の指定方法について文書プロパティの検索条件で指定する name キーの値は、次のとおりです。

name キーの値詳細条件の種類備考

name ファイル名 value キーに検索の対象となる文字列を指定します。

filetype 種類 value キーを指定します。指定できるキーは次のとおりで

す。指定されていない場合は、file が指定されたものとし

ます。

• file 通常のファイル

• link リンク


41

name キーの値詳細条件の種類備考

• pagelink ページリンク

• multilink マルチリンク

archivedate 初回アーカイブの日時日時の開始と終了、または、いずれか一方を指定できま

す。

archiveuser 初回アーカイブしたユーザーの

ID

value キーに検索の対象となる文字列を指定します。

updatedate アーカイブ（上書きアーカイブ

含む）された日時

日時の開始と終了、または、いずれか一方を指定できま

す。

updateuser アーカイブ（上書きアーカイブ

含む）したユーザーの ID

value キーに検索の対象となる文字列を指定します。

pagecount ページ数数値の最小値と最大値、または、いずれか一方を指定で

きます。

size ファイルサイズ（KB）数値の最小値と最大値、または、いずれか一方を指定で

きます。

title タイトル value キーに検索の対象となる文字列を指

SPA Ver. 9.3 Web APIリファレンス...第1章 SPA Web API リファレンス 11 第 1 章 SPA Web...

Documents

Transcript of SPA Ver. 9.3 Web APIリファレンス...第1章 SPA Web API リファレンス 11 第 1 章 SPA Web...