旧バージョンの Web Services API からの移行 - ABBYY Documentation

新しいバージョンの Web Services API は、以前のバージョンの WSDL とは互換性がありません。以下の変更点が新しいバージョンに実装されています。

API メソッドの変更

メソッド	変更
AddNewDocument	セット内で新しいドキュメントの位置を指定するための `previousItemId` パラメーターを追加しました。
AddNewPage	セット内でページドキュメントの位置を指定するための `previousItemId` パラメーターを追加しました。
CreateTask	ドキュメントが属するバッチの識別子を渡すための `batchId` パラメーターを追加しました。
GetBatchIdsRange	この新しいメソッドは、バッチ内の識別子の範囲を予約します。
GetDocument	Application Server への接続セッションの識別子を渡すための `sessionId` パラメーターを追加しました。
GetDocumentResultsList	Application Server への接続セッションの識別子を渡すための `sessionId` パラメーターと、ドキュメントが属するバッチの識別子を渡すための `batchId` パラメーターを追加しました。
GetDocuments	このメソッドは、バッチ内のすべての最上位ドキュメントの親ドキュメントとなる空のドキュメントを含む、すべてのドキュメントのリストを返すようになりました。また、Application Server への接続セッションの識別子を渡すための `sessionId` パラメーターも追加しました。
LoadDocumentResult	Application Server への接続セッションの識別子を渡すための `sessionId` パラメーターと、ドキュメントが属するバッチの識別子を渡すための `batchId` パラメーターを追加しました。
ReplacePageImage	ドキュメントが属するバッチの識別子を渡すための `batchId` パラメーターを追加しました。
SetDocumentPriority	ドキュメントが属するバッチの識別子を渡すための `batchId` パラメーターを追加しました。

データ型の変更

データ型	変更
ChildrenOrder	この新しい構造には、セット内の子ドキュメントに関する情報が含まれます。
Document	セットの親ドキュメントの識別子を含む `ParentId` field を追加しました。また、子ドキュメントのセットを渡すための `ChildrenOrder` field も追加しました。これにより、セット内のドキュメントを並べ替えられます。
Page	AddNewPage メソッドでページを作成する際に値を明示的に指定するようになったため、`PreviousId` field を削除しました。

サーバーに保存されている files に対する POST リクエストには、parentId パラメーターを含める必要があります。

新しいバージョンのエンドポイント

新しいバージョンの Web Services API には、以下の URL からアクセスできます。 https://<ApplicationServer>/FlexiCapture12/Server/API/v1/Soap 正式な仕様は、以下の URL で確認できます。 https://<ApplicationServer>/FlexiCapture12/Server/API/v1/WSDL 以前のバージョンはサポートされていません。