AddNewDocument - ABBYY Documentation

Adds a new document from an image file into a batch. To create a document without an image, leave the file parameter empty (file.Name = "", file.Bytes = new bytes [0]). A new document is created with the excludeFromAutomaticAssembling flag set to True. This flag indicates that the document has already been assembled, so the assembly settings specified for the batch type are not applied to it. The added documents become accessible only after their images are pre-processed. Use the ProcessBatch method to start batch processing after you add the documents. When a new document is added into the batch, the Id field of the corresponding object must not be empty. If you are adding PDF documents and want the program to use the text stored in their text layer, make sure that the Use PDF text layer instead of OCR option is selected for the project in which the documents will be processed. This option is on the Processing tab of the Page Properties dialog box.

Definition

int AddNewDocument(int sessionId, Document document, File file, bool excludeFromAutomaticAssembling, int previousItemId);

Parameters

Name	Type	Description
`sessionId`	`int`	The ID of the connection to the Application Server.
`document`	Document	A description of the document that is being created.
`file`	File	The file that contains the document image.
`excludeFromAutomaticAssembling`	`bool`	A flag that shows whether the document is excluded from document assembly. Possible values: `True` (the document has already been assembled and is not included in document assembly), `False` (the document is assembled according to the settings specified for the batch type).
`previousItemId`	`int`	The ID that explicitly sets the position of the new document in the set. `-1` adds the document at the end of the set. `0` adds it at the start. A document ID adds it after the document with that ID, which must exist.

Add a document image with a POST request

You can also use a POST request to add a document image. First, create a document with an empty file (file.Name = "FileName", file.Bytes = new bytes [0]). Then execute a POST request with the following parameters.

Parameter	Value
`Action`	`Save`
`objectType`	`0`
`objectId`	`documentId`, the document ID returned by `AddNewDocument`
`version`	`0`
`streamName`	`C:\Temp\image.pdf`, where `image.pdf` is the name of the file specified when calling `AddNewDocument`

Returned value

Type	Description
`int`	The ID of the created document.

​Definition

​Parameters

​Add a document image with a POST request

​Returned value

Definition

Parameters

Add a document image with a POST request

Returned value