1. SPA Web APIリファレンス

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

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

使用例について

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

SPA Cloudのサンプルについては、「SPA Cloudでの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

URLとURIの記載について

SPA Ver. 10.0とSPA Ver. 10.1以降では、使用するURLが異なります。

製品バージョン

URL

SPA Ver. 10.0

http://<hostname>:44230/pdfarchiver/~

SPA Ver. 10.1以降

http://<hostname>:44230/spa/~

SPA Cloud

<SPA Cloudログイン時のURL>~

本マニュアルではSPA Ver. 10.1以降のURLを記載しています。製品バージョンがSPA Ver. 10.0の場合はURLやURIの記載を読み替えてください。

参考

SPA Ver. 10.1以降では、Ver. 10.0用のURLも使用できます。

SPA CloudでのWeb API利用について

サンプルプログラムについて

SPA Cloudのサンプルプログラムは、こちらからダウンロードしてください。

なお、サンプルプログラム内の環境によって異なる値(SPA CloudのURL、ユーザー名、パスワード、ファイル名など)は、お使いの環境に合わせて編集する必要があります。

CSRFトークンのリクエストについて

Web APIを実行するためには、次のように「CSRFトークン」を取得してリクエストする必要があります。

ただし、GETリクエストの場合は、CSRFトークンは不要です。

  • SPA Cloudへのログイン時にCookieに払い出される、CSRFトークンを取得します。

  • 実行時に、X-Requested-WithヘッダーとX-XSRF-TOKENヘッダー(CSRFトークンを指定)を付けてリクエストします。

    参考

    誤ったCSRFトークンを指定するとトークンが無効になるため、ログインからやり直す必要があります。

CSRFトークンを取得してリクエストする例については、サンプルファイルを参照してください。

使用に制限があるWeb APIについて

次のWeb APIでは、「previewImageResolution(プレビュー画像の解像度(dpi))」の指定内容は無視され、初期値の150dpiが自動指定されます。

  • DocType Create

  • DocType Update

  • FolderPolicy Update

使用できないWeb APIについて

次のWeb APIは、SPA Cloudでは使用できません。Web APIに複数のバージョンがある場合は、すべてのバージョンが対象です。

  • Domains Create

  • Domains Update

  • Document Permission Get

  • Document Permission Update

  • Maintenance Mode Status Update

提供する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 アクセスログ」を参照してください。

認証

Web API

対応バージョン

概要

Auth Login 

-

SPAにログインします。

Auth Logout 

-

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

Auth Password 

-

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

Auth Password Change 

-

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

Password State Check

Ver. 10.3

ログイン中のユーザーのパスワードが有効期限内か、および、次回ログイン時にパスワード変更の必要があるかどうかをチェックします。

検索

Web API

対応バージョン

概要

Search Documents(Ver. 5)

-

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

Search Documents(Ver. 6)

Ver. 10.2

検索項目を指定して、文書またはフォルダーを検索します。

Search Documents(Ver. 7)

Ver. 10.2.3.0

検索項目を指定して、文書またはフォルダーを検索します。

Search Documents(Ver. 8)

Ver. 10.3

検索項目を指定して、文書またはフォルダーを検索します。

Search Documents(Ver. 9)

Ver. 10.3.2

検索項目を指定して、文書またはフォルダーを検索します。

Search Documents(Ver. 10)

Ver. 10.4

検索項目を指定して、文書またはフォルダーを検索します。

Search In-document 

-

文書内を全文検索します。

Search Cancel 

-

現在のセッションで実行中の検索処理を中止(キャンセル)します。

プレビュー

Web API

対応バージョン

概要

Preview Get(Ver. 3)

-

プレビュー用の画像を取得します。

Preview Get(Ver. 4)

Ver. 10.3

プレビュー用の画像を取得します。

Highlight Get(Ver. 2)

-

指定したページに対するハイライト用の注釈を取得します。

Highlight Get(Ver. 3)

Ver. 10.3

指定したページに対するハイライト用の注釈を取得します。

Highlight Get(Ver. 4)

Ver. 10.3.2

指定したページに対するハイライト用の注釈を取得します。

ダウンロード

Web API

対応バージョン

概要

Download Document 

-

指定した単一のファイルをダウンロードします。

Download Document(Ver. 2)

-

指定した単一のファイルをダウンロードします。

Download Raw Document 

-

指定した単一のファイルを無加工ダウンロードします。

Download Raw Document(Ver. 2)

-

指定した単一のファイルを無加工ダウンロードします。

Download Print Document 

-

指定した単一の印刷用ファイルをダウンロードします。

Download Print Document(Ver. 2)

-

指定した単一の印刷用ファイルをダウンロードします。

Download Packed Documents 

-

指定した複数のファイルをダウンロードします。

Download Packed Documents(Ver. 2)

-

指定した複数のファイルをダウンロードします。

Download Packed Raw Documents 

-

指定した複数のファイルを無加工ダウンロードします。

Download Packed Raw Documents(Ver. 2)

-

指定した複数のファイルを無加工ダウンロードします。

Download Packed Print Documents 

-

指定した複数の印刷用ファイルをダウンロードします。

Download Packed Print Documents(Ver. 2)

-

指定した複数の印刷用ファイルをダウンロードします。

ファイル操作

Web API

対応バージョン

概要

Documents Lookup 

-

ファイル名からIDを取得します。

Documents List(Ver. 5)

-

指定したフォルダー直下のファイル、リンク、フォルダーの一覧を取得します。取得する情報は、パラメーターで選択できます。

Documents List(Ver. 6)

Ver. 10.2.3.0

指定したフォルダー直下のファイル、リンク、フォルダーの一覧を取得します。取得する情報は、パラメーターで選択できます。

Documents List(Ver. 7)

Ver. 10.3

指定したフォルダー直下のファイル、リンク、フォルダーの一覧を取得します。取得する情報は、パラメーターで選択できます。

Documents List(Ver. 8)

Ver. 10.4

指定したフォルダー直下のファイル、リンク、フォルダーの一覧を取得します。取得する情報は、パラメーターで選択できます。

Documents Get(Ver. 5)

-

指定した文書の詳細情報(メタ情報)とカスタムプロパティの情報を取得します。

Documents Get(Ver. 6)

Ver. 10.2.3.0

指定した文書の詳細情報(メタ情報)とカスタムプロパティの情報を取得します。

Documents Get(Ver. 7)

Ver. 10.3

指定した文書の詳細情報(メタ情報)とカスタムプロパティの情報を取得します。

Documents Get(Ver. 8)

Ver. 10.4

指定した文書の詳細情報(メタ情報)とカスタムプロパティの情報を取得します。

Documents Image Verify 

-

PDFファイルに埋め込まれている画像の解像度と色深度を検証します。

Documents Rename 

-

ファイル名を変更します。

Documents Move List(Ver. 2)

-

指定したファイルとフォルダーをまとめて別のフォルダーに移動します。

Documents Delete List 

-

指定したファイルとフォルダーをまとめて削除します。

Documents History List

-

指定した文書のバージョン管理の履歴一覧を取得します。

Documents Restore 

-

指定したバージョンの文書に復元します。

Documents Check-out 

Ver. 10.3

指定した文書をチェックアウトします。

Documents Check-in 

Ver. 10.3

指定した文書をチェックインします。

リンク操作

Web API

対応バージョン

概要

Links List Get 

-

指定された文書を参照しているリンクの一覧を取得します。

Links Create 

-

リンクの作成とカスタムプロパティ値の更新を行います。

Links Set 

-

1つの文書から複数のリンクを作成します。

マルチリンク

Web API

対応バージョン

概要

Multi Links Page Get 

-

マルチリンクのページ情報を取得します。

Multi Links Set 

-

マルチリンクを作成します。

Multi Links Update

-

マルチリンクの構成を変更します。

文書のコメント

Web API

対応バージョン

概要

Documents Comments Get 

-

指定した文書のコメントを取得します。

Documents Comments Add 

-

指定した文書にコメントを追加します。

ページメモ

Web API

対応バージョン

概要

PageMemo Get(Ver. 2)

-

指定したページのページメモの情報を取得します。

PageMemo Update 

-

指定したページのページメモの情報を更新します。

フォルダー操作

Web API

対応バージョン

概要

Folders Lookup 

-

フォルダー名からフォルダーIDを取得します。

Folders All(Ver. 2)

-

すべてのフォルダー情報のリストを取得します。

Folders All(Ver. 3)

Ver. 10.4

すべてのフォルダー情報のリストを取得します。

Folders List(Ver. 2)

-

指定したフォルダー直下にあるフォルダーのリストを取得します。

Folders List(Ver. 3)

Ver. 10.4

指定したフォルダー直下にあるフォルダーのリストを取得します。

Folders Open List(Ver. 2)

-

指定したフォルダーまで展開したフォルダーのリストを取得します。

Folders Open List(Ver. 3)

Ver. 10.4

指定したフォルダーまで展開したフォルダーのリストを取得します。

Folders Get(Ver. 2)

-

指定したパスのフォルダー情報を取得します。

Folders Get(Ver. 3)

Ver. 10.4

指定したパスのフォルダー情報を取得します。

Folders Info Get 

-

指定したフォルダー内に含まれるフォルダーやファイルなどの概要情報を取得します。

Folders Create(Ver. 2)

-

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

Folders Rename(Ver. 2)

-

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

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

Web API

対応バージョン

概要

Shortcuts List(Ver. 2)

-

ログインしているユーザーのフォルダーショートカットの一覧を取得します。

Shortcuts Create(Ver. 2)

-

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

Shortcuts Rename 

-

ログインしているユーザーの、指定されたフォルダーショートカットの名前を変更します。

Shortcuts Delete 

-

ログインしているユーザーの、指定されたフォルダーショートカットを削除します。

ごみ箱

Web API

対応バージョン

概要

Trashbox List(Ver. 3)

-

ログインしているユーザーのごみ箱にあるフォルダーおよびファイルの一覧を取得します。

Trashbox List(Ver. 4)

Ver. 10.2.3.0

ログインしているユーザーのごみ箱にあるフォルダーおよびファイルの一覧を取得します。

Trashbox Restore 

-

ログインしているユーザーのごみ箱から、指定したフォルダーまたはファイルを戻します。

Trashbox Clear(Ver. 2)

-

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

ユーザー情報操作

Web API

対応バージョン

概要

Users Lookup 

-

ドメイン名とユーザー名からユーザーIDを取得します。

Users List(Ver. 2)

-

ユーザー情報のリストを取得して返します。

Users List(Ver. 3)

Ver. 10.2

ユーザー情報のリストを取得して返します。

Users List(Ver. 4)

Ver. 10.3

ユーザー情報のリストを取得して返します。

Users Group List(Ver. 2)

-

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

Users Group List(Ver. 3)

Ver. 10.2

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

Users Group List(Ver. 4)

Ver. 10.3

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

Users Get(Ver. 2)

-

指定された対象ユーザーの内部ID(ユーザーID)を持つユーザーの情報を取得します。

Users Get(Ver. 3)

Ver. 10.2

指定された対象ユーザーの内部ID(ユーザーID)を持つユーザーの情報を取得します。

Users Get(Ver. 4)

Ver. 10.3

指定された対象ユーザーの内部ID(ユーザーID)を持つユーザーの情報を取得します。

Users Authorities(Ver. 4)

-

指定されたユーザーに許可されたすべての操作の権限ID番号を取得します。

Users Authorities(Ver. 5)

Ver. 10.2.3

指定されたユーザーに許可されたすべての操作の権限ID番号を取得します。

Users Authorities(Ver. 6)

Ver. 10.3

指定されたユーザーに許可されたすべての操作の権限ID番号を取得します。

Users Authorities(Ver. 7)

Ver.10.3.2

指定されたユーザーに許可されたすべての操作の権限ID番号を取得します。

Users Create(Ver. 2)

-

指定されたユーザーを作成し、指定されたグループに登録します。

Users Create(Ver. 3)

Ver. 10.2

指定されたユーザーを作成し、指定されたグループに登録します。

Users Create(Ver. 4)

Ver. 10.2

指定されたユーザーを作成し、指定されたグループに登録します。

Users Create(Ver. 5)

Ver. 10.3

指定されたユーザーを作成し、指定されたグループに登録します。

Users Update(Ver. 2)

-

指定された内容でユーザー情報を更新します。

Users Update(Ver. 3)

Ver. 10.2

指定された内容でユーザー情報を更新します。

Users Update(Ver. 4)

Ver. 10.3

指定された内容でユーザー情報を更新します。

Users Delete 

-

指定されたユーザーIDを持つユーザー情報を削除します。

グループ情報操作

Web API

対応バージョン

概要

Groups Lookup 

-

ドメイン名とグループ名からグループのIDを取得します。

Groups List(Ver. 2)

-

グループ情報のリストを取得して返します。

Groups List(Ver. 3)

Ver. 10.4

グループ情報のリストを取得して返します。

Groups Role List(Ver. 2)

-

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

Groups Get(Ver. 2)

-

指定されたIDを持つグループの情報を取得します。

Groups Get(Ver. 3)

Ver. 10.4

指定されたIDを持つグループの情報を取得します。

Groups Create(Ver. 2)

-

指定されたグループを作成します。

Groups Create(Ver. 3)

Ver. 10.4

指定されたグループを作成します。

Groups Update(Ver. 2)

-

指定された内容でグループ情報を更新します。

Groups Update(Ver. 3)

Ver. 10.4

指定された内容でグループ情報を更新します。

Groups Delete 

-

指定されたIDを持つグループの情報を削除します。

ロール情報操作

Web API

対応バージョン

概要

Roles Lookup 

-

ロール名からロールのIDを取得します。

Roles List(Ver. 4)

-

カスタムロールの詳細情報のリストを取得して返します。

Roles List(Ver. 5)

Ver. 10.2.3

カスタムロールの詳細情報のリストを取得して返します。

Roles List(Ver. 6)

Ver. 10.3

カスタムロールの詳細情報のリストを取得して返します。

Roles List(Ver. 7)

Ver.10.3.2

カスタムロールの詳細情報のリストを取得して返します。

Roles Get(Ver. 4)

-

指定されたIDを持つロールの情報を取得します。

Roles Get(Ver. 5)

Ver. 10.2.3

指定されたIDを持つロールの情報を取得します。

Roles Get(Ver. 6)

Ver. 10.3

指定されたIDを持つロールの情報を取得します。

Roles Get(Ver. 7)

Ver.10.3.2

指定されたIDを持つロールの情報を取得します。

Roles Create(Ver. 4)

-

指定されたロールを作成します。

Roles Create(Ver. 5)

Ver. 10.2.3

指定されたロールを作成します。

Roles Create(Ver. 6)

Ver. 10.3

指定されたロールを作成します。

Roles Create(Ver. 7)

Ver.10.3.2

指定されたロールを作成します。

Roles Update(Ver. 4)

-

指定された内容でロールの権限に関する情報を更新します。

Roles Update(Ver. 5)

Ver. 10.2.3

指定された内容でロールの権限に関する情報を更新します。

Roles Update(Ver. 6)

Ver. 10.3

指定された内容でロールの権限に関する情報を更新します。

Roles Update(Ver. 7)

Ver.10.3.2

指定された内容でロールの権限に関する情報を更新します。

Roles Delete 

-

指定されたIDを持つロールの情報を削除します。

ドメイン情報操作

Web API

対応バージョン

概要

Domains List(Ver. 2)

-

ドメイン名のリストを取得します。

Domains List(Ver. 3)

Ver. 10.2

ドメイン名のリストを取得します。

Domains List(Ver. 4)

Ver. 10.2.3.0

ドメイン名のリストを取得します。

Domains List(Ver. 5)

Ver. 10.3.1.0

ドメイン名のリストを取得します。

Domains Create(Ver. 2)

-

ドメイン設定を作成します。

Domains Create(Ver. 3)

Ver. 10.2

ドメイン設定を作成します。

Domains Create(Ver. 4)

Ver. 10.2.3.0

ドメイン設定を作成します。

Domains Create(Ver. 5)

Ver. 10.3.1.0

ドメイン設定を作成します。

Domains Update(Ver. 2)

-

指定されたドメイン設定を更新します。

Domains Update(Ver. 3)

Ver. 10.2

指定されたドメイン設定を更新します。

Domains Update(Ver. 4)

Ver. 10.2.3.0

指定されたドメイン設定を更新します。

Domains Update(Ver. 5)

Ver. 10.3.1.0

指定されたドメイン設定を更新します。

Domains Default Update 

-

デフォルトドメインのIDを設定します。

Domains Delete 

-

指定されたドメイン設定を削除します。

All Domains List

Ver. 10.2

すべてのドメイン名のリストを取得します。

All Domains List(Ver. 2)

Ver. 10.2.3.0

すべてのドメイン名のリストを取得します。

Saml Domains List

Ver. 10.2

SAML接続設定リストを取得します。

Saml Domains List(Ver. 2)

Ver. 10.2

SAML接続設定リストを取得します。

Saml Domains Create

Ver. 10.2

SAML接続設定を登録します。

Saml Domains Create(Ver. 2)

Ver. 10.2

SAML接続設定を登録します。

Saml Domains Update

Ver. 10.2

SAML接続設定を更新します。

Saml Domains Update(Ver. 2)

Ver. 10.2

SAML接続設定を更新します。

Saml Metadata Download

Ver. 10.2

SAML認証のメタデータを取得します。

アクセス権

Web API

対応バージョン

概要

Permission Get(Ver. 3)

-

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

Permission Update(Ver. 3)

-

指定したフォルダーのアクセス権をすべてのグループおよびすべてのユーザーに一括して設定します。

Document Permission Get 

Ver. 10.2

指定した文書のアクセス権の情報を取得します。

Document Permission Update 

Ver. 10.2

指定した文書のアクセス権を設定します。

透かし設定

Web API

対応バージョン

概要

Watermark Get 

-

指定したフォルダーの透かしに関する設定を取得します。

Watermark Get(Ver. 2)

Ver. 10.3

指定したフォルダーの透かしに関する設定を取得します。

Watermark Get(Ver. 3)

Ver. 10.3.2.0

指定したフォルダーの透かしに関する設定を取得します。

Watermark Image Get 

-

指定したフォルダーに透かし画像が設定されていた場合、その画像を取得します。

Watermark Update 

-

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

Watermark Update(Ver. 2)

Ver. 10.3

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

Watermark Update(Ver. 3)

Ver. 10.3.2.0

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

暗号化設定

Web API

対応バージョン

概要

Encryption Get 

-

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

Encryption Update 

-

フォルダー内のPDFファイルに適用するセキュリティ情報(パスワード、暗号化など)を、フォルダーに設定します。

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

Web API

対応バージョン

概要

FolderPolicy Get(Ver. 2)

-

指定したフォルダーの文書管理ポリシーの設定情報を取得します。

FolderPolicy Get(Ver. 3)

Ver. 10.3.1.0

指定したフォルダーの文書管理ポリシーの設定情報を取得します。

FolderPolicy Get(Ver. 4)

Ver. 10.3.2.0

指定したフォルダーの文書管理ポリシーの設定情報を取得します。

FolderPolicy Get(Ver. 5)

Ver. 10.4

指定したフォルダーの文書管理ポリシーの設定情報を取得します。

FolderPolicy Update(Ver. 3)

-

指定した内容で、フォルダーの文書管理ポリシーの設定を変更します。

FolderPolicy Update(Ver. 4)

Ver. 10.3.1.0

指定した内容で、フォルダーの文書管理ポリシーの設定を変更します。

FolderPolicy Update(Ver. 5)

Ver. 10.3.2.0

指定した内容で、フォルダーの文書管理ポリシーの設定を変更します。

FolderPolicy Update(Ver. 6)

Ver. 10.4

指定した内容で、フォルダーの文書管理ポリシーの設定を変更します。

データの保存先情報取得

Web API

対応バージョン

概要

Storage Settings Get 

-

データの保存先の設定情報を取得します。

Storage Settings Get(Ver. 2)

Ver. 10.3.1.0

データの保存先の設定情報を取得します。

カスタムプロパティ操作

Web API

対応バージョン

概要

Custom Properties List(Ver. 2)

-

存在するすべてのカスタムプロパティの構成情報のリストを返します。

Custom Properties Create(Ver. 2)

-

カスタムプロパティを作成します。

Custom Property Documents Set 

-

指定した文書に対して、カスタムプロパティのすべての値を更新します。

Custom Property Documents Set(Ver. 2)

Ver. 10.4

指定した文書やフォルダーに対して、カスタムプロパティのすべての値を更新します。

Custom Properties Update(Ver. 2)

-

指定されたカスタムプロパティの属性を変更します。

Custom Properties Delete 

-

指定されたカスタムプロパティを削除します。

マスク情報取得

Web API

対応バージョン

概要

Masks List 

-

マスク(マスクのパターン)の一覧を取得します。

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

Web API

対応バージョン

概要

Review Templates List(Ver. 2)

-

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

Review Templates List(Ver. 3)

-

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

Review Templates List(Ver. 4)

Ver. 10.2.3.0

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

Review Templates List(Ver. 5)

Ver. 10.3

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

Review Templates List(Ver. 6)

Ver. 10.3.1.0

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

アーカイブ

Web API

対応バージョン

概要

Archives Add(Ver. 2)

-

文書を指定したフォルダーにアーカイブします。

Archives Add(Ver. 3)

Ver. 10.2

文書を指定したフォルダーにアーカイブします。

文書定義

Web API

対応バージョン

概要

DocType Lookup

-

文書定義IDから文書定義管理ID(文書定義に自動で割り振られる固有のID)を取得します。

DocType List(Ver. 2)

-

文書定義の一覧を取得します。

DocType List(Ver. 3)

Ver. 10.3.1.0

文書定義の一覧を取得します。

DocType List(Ver. 4)

Ver. 10.3.2.0

文書定義の一覧を取得します。

DocType List(Ver. 5)

Ver. 10.4

文書定義の一覧を取得します。

DocType Get(Ver. 2)

-

指定した文書定義を取得します。

DocType Get(Ver. 3)

Ver. 10.1.0.3

指定した文書定義を取得します。

DocType Get(Ver. 4)

Ver. 10.3.1.0

指定した文書定義を取得します。

DocType Get(Ver. 5)

Ver. 10.3.2.0

指定した文書定義を取得します。

DocType Get(Ver. 6)

Ver. 10.4

指定した文書定義を取得します。

DocType Create(Ver. 2)

-

指定した文書定義を作成します。

DocType Create(Ver. 3)

Ver. 10.1.0.3

指定した文書定義を作成します。

DocType Create(Ver. 4)

Ver. 10.3.1.0

指定した文書定義を作成します。

DocType Create(Ver. 5)

Ver. 10.3.2.0

指定した文書定義を作成します。

DocType Create(Ver. 6)

Ver. 10.4

指定した文書定義を作成します。

DocType Update(Ver. 3)

-

指定した文書定義の内容を更新します。また、その文書定義に属するすべてのSVF検索フィールドの情報も一括で更新します。

DocType Update(Ver. 4)

Ver. 10.1.0.3

指定した文書定義の内容を更新します。また、その文書定義に属するすべてのSVF検索フィールドの情報も一括で更新します。

DocType Update(Ver. 5)

Ver. 10.3.1.0

指定した文書定義の内容を更新します。また、その文書定義に属するすべてのSVF検索フィールドの情報も一括で更新します。

DocType Update(Ver. 6)

Ver. 10.3.2.0

指定した文書定義の内容を更新します。また、その文書定義に属するすべてのSVF検索フィールドの情報も一括で更新します。

DocType Update(Ver. 7)

Ver. 10.4

指定した文書定義の内容を更新します。また、その文書定義に属するすべてのSVF検索フィールドの情報も一括で更新します。

DocType Delete 

-

指定した文書定義を削除します。また、その文書定義に属するSVF検索フィールドもすべて削除されます。

タイムスタンプ/長期署名操作

Web API

対応バージョン

概要

Timestamp Verify 

-

指定した文書に対してタイムスタンプ/長期署名のベリファイを実行します。

Timestamp Verify(Ver. 2)

Ver. 10.3.1.0

指定した文書に対してタイムスタンプ/長期署名のベリファイを実行します。

Request Folder Timestamp Verify

Ver. 10.2

指定したフォルダーに含まれる文書の、タイムスタンプ/長期署名情報の登録を依頼します。

Request Folder Timestamp Verify(Ver. 2)

Ver. 10.2.3.0

指定したフォルダーに含まれる文書の、タイムスタンプ/長期署名情報の登録を依頼します。

Folder Timestamp Verify List 

Ver. 10.2

指定したフォルダーに含まれる文書の、タイムスタンプ/長期署名情報の一覧を取得します。

Folder Timestamp Verify List(Ver. 2)

Ver. 10.2.3.0

指定したフォルダーに含まれる文書の、タイムスタンプ/長期署名情報の一覧を取得します。

Folder Timestamp Verify Get 

Ver. 10.2

指定したフォルダーに含まれる文書の、詳細なタイムスタンプ/長期署名情報を取得します。

Folder Timestamp Verify Get(Ver. 2)

Ver. 10.3.1.0

指定したフォルダーに含まれる文書の、詳細なタイムスタンプ/長期署名情報を取得します。

Folder Timestamp Verify Delete 

Ver. 10.2

指定したフォルダーに含まれる文書の、タイムスタンプ/長期署名情報を削除します。

マスクの適用

Web API

対応バージョン

概要

Mask Apply(Ver. 2)

-

マスク(マスクのパターン)または任意の矩形情報を指定して、マスクを文書に適用します。

Mask Apply Search Result 

-

検索条件に合致した部分にマスクを適用します。

Mask Apply Search Result(Ver. 2)

Ver. 10.3

検索条件に合致した部分にマスクを適用します。

Mask Apply Search Result(Ver. 3)

Ver. 10.3.2

検索条件に合致した部分にマスクを適用します。

SVF検索フィールド

Web API

対応バージョン

概要

SearchFields List

-

指定した条件に合致するSVF検索フィールドの一覧を取得します。

SearchFields Get

-

指定した条件に合致するSVF検索フィールドを取得します。

SearchFields Parse PDF 

-

PDFファイルを解析してSVF検索フィールドを取得します。

SearchFields Parse Form 

-

様式ファイルを解析してSVF検索フィールドを取得します。

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

Web API

対応バージョン

概要

Request Search Data Csv From Documents(Ver. 4)

-

指定した文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Documents(Ver. 5)

Ver. 10.1

指定した文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Documents(Ver. 6)

Ver. 10.2.3.0

指定した文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Documents(Ver. 7)

Ver. 10.3

指定した文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Documents(Ver. 8)

Ver. 10.4

指定した文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Search Results(Ver. 4)

-

指定した検索条件でヒットした文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Search Results(Ver. 5)

Ver. 10.1

指定した検索条件でヒットした文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Search Results(Ver. 6)

Ver. 10.2

指定した検索条件でヒットした文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Search Results(Ver. 7)

Ver. 10.2.3.0

指定した検索条件でヒットした文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Search Results(Ver. 8)

Ver. 10.3

指定した検索条件でヒットした文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Search Results(Ver. 9)

Ver. 10.3.2

指定した検索条件でヒットした文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

Request Search Data Csv From Search Results(Ver. 10)

Ver. 10.4

指定した検索条件でヒットした文書内にあるSVF検索フィールドデータを対象として、CSVデータの作成を依頼します。

追跡記録

Web API

対応バージョン

概要

Records List(Ver. 2)

-

指定された文書の追跡記録を取得します。

Records List(Ver. 3)

Ver. 10.2.3.0

指定された文書の追跡記録を取得します。

削除記録

Web API

対応バージョン

概要

DeleteRecords List(Ver. 3)

-

削除履歴の一覧を取得します。

DeleteRecords List(Ver. 4)

Ver. 10.2.3.0

削除履歴の一覧を取得します。

証跡確認

Web API

対応バージョン

概要

Upload File Trail Get 

-

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

Trail Get 

-

ダウンロード時に埋め込む証跡情報に関する設定値を取得します。

Trail Update 

-

ダウンロード時に埋め込む証跡情報について設定します。

セッション管理

Web API

対応バージョン

概要

Session Current Get(Ver. 2)

-

現在ログイン中のユーザーに関するセッション情報を取得します。

メンテナンスモード設定

Web API

対応バージョン

概要

Maintenance Mode Status Get

-

メンテナンスモードの状態を取得します。

Maintenance Mode Status Update

-

メンテナンスモードの状態を更新します。

サーバー情報の取得

Web API

対応バージョン

概要

Config Version 

-

SPA(アーカイブサーバー、Webサーバー、検索サーバー、Loaderサーバー)のバージョンを取得します。

Config Activation

-

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

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

Web API

対応バージョン

概要

Event Notification Get

-

指定したフォルダーの通知の設定を取得します。

Event Notification Get(Ver. 2)

Ver. 10.2

指定したフォルダーの通知の設定を取得します。

Event Notification Get(Ver. 3)

Ver. 10.2.3.0

指定したフォルダーの通知の設定を取得します。

Event Notification Get(Ver. 4)

Ver. 10.3.1.0

指定したフォルダーの通知の設定を取得します。

Event Notification Update

-

指定したフォルダーの通知の設定を変更します。

Event Notification Update(Ver. 2)

Ver. 10.2

指定したフォルダーの通知の設定を変更します。

Event Notification Update(Ver. 3)

Ver. 10.2.3.0

指定したフォルダーの通知の設定を変更します。

Event Notification Update(Ver. 4)

Ver. 10.3.1.0

指定したフォルダーの通知の設定を取得します。

ページ操作

Web API

対応バージョン

概要

Pages Rotate

-

指定したページの回転について設定します。

Bridgeサービス設定

Web API

対応バージョン

概要

Bridge Service Installer Get

-

指定したBridgeサービスのインストーラーを取得します。

署名鍵

Web API

対応バージョン

概要

SignKey List

Ver. 10.3.2.0

SPAに登録されているすべての署名鍵のリストを返します。

SignKey Add

Ver. 10.3.2.0

SPAへ署名鍵をアップロードします。

SignKey Get

Ver. 10.3.2.0

SPAに登録されている署名鍵を指定して情報を取得します。

SignKey Update

Ver. 10.3.2.0

SPAに登録されている署名鍵を指定して属性を変更します。

SignKey Delete

Ver. 10.3.2.0

SPAに登録されている署名鍵を指定して削除します。

統計元データのCSVファイル出力

Web API

対応バージョン

概要

Request Statistical Source Csv From Documents

Ver. 10.3.2.0

指定した1つ以上の文書の統計元データで、CSVデータの作成を依頼します。

Request Statistical Source Csv From Search Results

Ver. 10.3.2.0

指定した検索条件でヒットした1つ以上の文書の統計元データで、CSVデータの作成を依頼します。

Request Statistical Source Csv From Search Results(Ver. 2)

Ver. 10.4

指定した検索条件でヒットした1つ以上の文書の統計元データで、CSVデータの作成を依頼します。

CSVファイル出力

Web API

対応バージョン

概要

Output Search Data Csv Status

-

ログインしているユーザーのCSVデータ作成状況の一覧を取得します。

Output Search Data Csv Status(Ver. 2)

Ver. 10.3.2.0

ログインしているユーザーのCSVデータ作成状況の一覧を取得します。

Output Search Data Csv Status(Ver. 3)

Ver. 10.4

ログインしているユーザーのCSVデータ作成状況の一覧を取得します。

Output Search Data Csv Status Get

Ver. 10.3

指定した受付番号に対応する、CSVデータ作成状況を取得します。

Output Search Data Csv Status Get(Ver. 2)

Ver. 10.3.2.0

指定した受付番号に対応する、CSVデータ作成状況を取得します。

Output Search Data Csv Status Get(Ver. 3)

Ver. 10.4

指定した受付番号に対応する、CSVデータ作成状況を取得します。

Output Search Data Csv Get

-

指定した受付番号に対応するデータのCSVファイル(ZIPファイルに圧縮されたもの)を取得します。

Output Search Data Csv Get(Ver. 2)

Ver. 10.3.2.0

指定した受付番号に対応するデータのCSVファイルまたは、ZIPファイルに圧縮されたファイルを取得します。