AddNewDocumentEx - ABBYY Documentation

機能

画像ファイルから新しいDocumentをバッチに追加します。このメソッドは、旧バージョンの Web Services API の AddNewDocument メソッドに代わるものです。追加したDocumentにアクセスできるようになるのは、画像の前処理が完了してからです。Documentの追加後に画像の前処理を開始するには、ProcessBatch メソッドを使用します。

定義

int AddNewDocumentEx(int sessionId, int batchId, DocumentEx document, File file, bool excludeFromAutomaticAssembling);

パラメーター

名前	型	説明
`sessionId`	`int`	Application Server への接続 ID
`batchId`	`int`	Documentを追加するバッチの ID
`document`	DocumentEx	作成するDocumentの説明
`file`	File	Document画像を含むファイル。空のDocumentを作成するには、`file` パラメーターを空のままにします (`file.Name = ""`、`file.Bytes = new bytes [0]`) 。
`excludeFromAutomaticAssembling`	`bool`	DocumentがDocumentアセンブリの対象外かどうかを示すフラグ。指定可能な値: `True` (Documentはすでに組み立てられており、Documentアセンブリの対象外です) 、`False` (Documentはバッチタイプで指定された設定に従って組み立てられます) 。

POST リクエストを使用してDocument画像を追加する

POST リクエストを使用してDocument画像を追加することもできます。このメソッドでは、空のファイルを含むDocumentを作成します (file.Name = "FileName"、file.Bytes = new bytes [0]) 。次に、以下のパラメーターを指定して POST リクエストを実行します。

Action = Save
objectType = 0
objectId = documentId (documentId は AddNewDocumentEx メソッドから返されるDocument ID)
version = 0
streamName = "FileName" (FileName は AddNewDocumentEx メソッドの呼び出し時に指定したファイル名)

戻り値

型	説明
`int`	作成されたDocumentの ID

⌘I