Provides methods for validating documents, configuring documents, pages and fields etc. More...
Public Member Functions | |
bool | AddPageMaskForField (string sessionId, string documentId, int pageIndex, string fieldName, int color) |
Adds a mask to a page for rectangular area associated to specified field. More... | |
bool | AddPageMaskForRegion (string sessionId, string documentId, int pageIndex, int left, int top, int right, int bottom, int color) |
Adds a mask to a page to specified rectangular area. More... | |
string | CopyDocument (string sessionId, string sourceDocumentId, string targetDocumentId, StringCollection fieldNames, short copyDocumentOptions) |
Copies properties of the source document to the target document. If the target document is not specified (either null or empty), a new document will be created under the same parent folder where the source document is located. Note that this method does not copy pages. If you need to copy pages, then use the CopyDocumentWithPages() method instead. More... | |
void | CopyDocumentFieldValues (string sessionId, string sourceDocumentId, string targetDocumentId) |
Copies the field values from a source document to a target document and overwrites the existing values in the target document. More... | |
string | CopyDocumentWithPages (string sessionId, string documentId, int insertIndex) |
Copies properties of the source document including pages and returns a new document. More... | |
DocumentIdentity | CreateDocument (string sessionId, ReportingData reportingData, string parentId, RuntimeFieldCollection runtimeFields, string filePath, int insertIndex, string documentTypeId, string folderTypeId) |
Please note that this function is deprecated. Please use CreateDocument3 instead. Creates a document of the specified document type. If the parent folder of the document is not specified, then a new folder will be created as its parent. More... | |
DocumentIdentity | CreateDocument2 (string sessionId, ReportingData reportingData, string parentId, RuntimeFieldCollection runtimeFields, string filePath, int insertIndex, string documentTypeId, string folderTypeId, FieldPropertiesCollection runtimeFieldProperties) |
Please note that this function is deprecated. Please use CreateDocument3 instead. Creates a document of the specified document type. This API is designed for use in custom code, as such it is not expected to be consumed within in .NET process activities, web service activities and .NET form actions as TotalAgility does not support its class structure and thus will not provide access to some of its data elements.This API can be used in C# and VB.NET script activities. More... | |
DocumentIdentity | CreateDocument3 (string sessionId, ReportingData reportingData, string parentId, RuntimeFieldCollection runtimeFolderFields, string folderTypeId, DocumentDataInput2 documentDataInput, int insertIndex) |
Creates a document of the specified document type. This API is designed for use in custom code, as such it is not expected to be consumed within in .NET process activities, web service activities and .NET form actions as TotalAgility does not support its class structure and thus will not provide access to some of its data elements.This API can be used in C# and VB.NET script activities. More... | |
DocumentIdentityCollection | CreateDocuments (string sessionId, ReportingData reportingData, string parentId, RuntimeFieldCollection runtimeFolderFields, string folderTypeId, DocumentDataInputCollection documentData) |
Please note that this function is deprecated. Please use CreateDocuments2 instead. Create documents. More... | |
DocumentIdentityCollection | CreateDocuments2 (string sessionId, ReportingData reportingData, string parentId, RuntimeFieldCollection runtimeFolderFields, string folderTypeId, DocumentDataInput2Collection documentData) |
Create documents. More... | |
DocumentIdentity | CreateDocumentWithPages (string sessionId, ReportingData reportingData, string parentId, RuntimeFieldCollection runtimeFields, string documentTypeId, string folderTypeId, PageDataCollection pages) |
Creates the document with pages. More... | |
string | CreateFolder (string sessionId, ReportingData reportingData, string parentId, RuntimeFieldCollection runtimeFields, int insertIndex, CategoryIdentity folderTypeCategory, FolderTypeIdentity folderTypeIdentity) |
Creates a folder of the specified folder type. More... | |
string | CreateOnlineLearningFolder (string sessionId, int maxSamples) |
Creates an online learning folder (contain document types you have identified previously so this information can be reused when you encounter the same document types rather than trying to identify all fields etc. from scratch) More... | |
void | CreatePage (string sessionId, ReportingData reportingData, string documentId, RuntimeFieldCollection runtimeFields, string filePath, int insertIndex) |
Creates a page to a document with the image read from a file path. More... | |
void | CreatePageUsingStream (string sessionId, ReportingData reportingData, string documentId, RuntimeFieldCollection runtimeFields, byte[] data, int insertIndex, string mimeType) |
Creates a page to a document with the image passed as a stream. More... | |
DeletionResult | DeleteDocument (string sessionId, string documentId, ReportingData reportingData, bool failOnError) |
Deletes the document with specified id. Additionally, if the deletion fails and the failOnError parameter is set to true and the API method is called within a job, then the document's associated job will be suspended. More... | |
DeletionResult | DeleteDocuments (string sessionId, StringCollection documentIds, ReportingData reportingData, bool ignoreError) |
Deletes the specified documents. Additionally, if the delete fails and the failOnError parameter is set to true, then jobs associated with the documents will be suspended. More... | |
void | DeleteExtension (string sessionId, ReportingData reportingData, string documentId, string name) |
Deletes the specified text or binary extension. More... | |
DeletionResult | DeleteFolder (string sessionId, string folderId, ReportingData reportingData, bool failOnError) |
Deletes the folder with specified id. Additionally, if the delete operation fails and the failOnError parameter is set to true and the API method is called within a job, then the folder's associated job will be suspended. More... | |
void | DeleteFolderExtension (string sessionId, ReportingData reportingData, string folderId, string name) |
Deletes the folder extension. More... | |
void | DeletePageExtension (string sessionId, ReportingData reportingData, string documentId, string pageId, string extensionName) |
Deletes the page extension. More... | |
void | DeletePageRendition (string sessionId, string documentId, string pageId, short renditionNumber) |
Deletes the specified page rendition. More... | |
void | DeletePages (string sessionId, ReportingData reportingData, string documentId, PageIndexCollection pageIndexes) |
Deletes the pages of the specified document at the given indices. More... | |
void | DeleteSourceFile (string sessionId, ReportingData reportingData, string documentId) |
Deletes the source file. More... | |
void | DeleteTableFieldRow (string sessionId, ReportingData reportingData, string documentId, string tableFieldId, RowIndexCollection rowIndexes) |
Deletes the list of row indexes from the table. Indices are zero-based i.e. row 1 is index 0, row 2 is index 1. More... | |
void | ForceUnlockItem (string sessionId, ReportingData reportingData, LockedItemIdentity identity) |
Forcefully unlocks the document or folder. This sets the Locked property of the document or folder to a value of false. More... | |
FormattingResult | FormatField (string sessionId, string value, FormatterIdentity formatterIdentity) |
Please note that this function is deprecated. Please use FormatField2 instead. Tests the field value against the specified formatter. More... | |
FormattingResult | FormatField2 (string sessionId, string value, FormatterIdentity formatterIdentity, BusinessRuleInputCollection ruleInputs) |
Tests the field value against the specified formatter. More... | |
WordCollection | GetAllMaskedWords (string sessionId, string documentId, int pageIndex) |
Gets all words that are masked on a page with specified index. More... | |
PageMaskCollection | GetAllPageMasks (string sessionId, string documentId, int pageIndex) |
Gets all explicit masks associated to a page with specified index. More... | |
AnnotationDataCollection | GetAnnotations (string sessionId, string documentId) |
Gets annotations for the specified document. More... | |
BinaryData | GetBinaryExtension (string sessionId, ReportingData reportingData, string documentId, string name) |
Gets the specified binary extension. More... | |
Document | GetDocument (string sessionId, ReportingData reportingData, string documentId) |
Retrieves a document using document id. More... | |
string | GetDocumentAsFile (string sessionId, string documentId, string fileLocation, string fileName) |
Gets the image document as a file (.tiff format) and it will be saved to the specified location with the specified name. More... | |
FieldAlternativeCollection | GetDocumentFieldAlternatives (string sessionId, string documentId, FieldIdentity fieldIdentity, int numberOfRowsToReturn) |
Please note that this function is deprecated. Please use GetDocumentFieldAlternatives2 instead. Get the alternatives for the value of the specified document field, including pre-defined document system fields such as verified, rejected, number of pages etc. See Remarks section below for the document system fields. More... | |
FieldAlternative2Collection | GetDocumentFieldAlternatives2 (string sessionId, string documentId, FieldIdentity fieldIdentity, int numberOfRowsToReturn) |
Get the alternatives for the specified document field. More... | |
FieldPropertiesCollection | GetDocumentFieldPropertyValues (string sessionId, ReportingData reportingData, string documentId, FieldPropertiesIdentityCollection fieldProperties) |
The API Returns the Values of System properties of Document fields.You have to provide the System GUIDs(which are listed below) for the System Properties for the Fields. More... | |
FieldAlternativesCollection | GetDocumentFieldsAlternatives (string sessionId, string documentId, FieldIdentityCollection fields, int numberOfRowsToReturn) |
Please note that this function is deprecated. Please use GetDocumentFieldsAlternatives2 instead. Gets the document fields alternatives for the specified fields. More... | |
FieldAlternatives2Collection | GetDocumentFieldsAlternatives2 (string sessionId, string documentId, FieldIdentityCollection fields, int numberOfRowsToReturn) |
Gets the document fields alternatives for the specified fields. More... | |
RuntimeField2Collection | GetDocumentFieldsProperties (string sessionId, string documentId, RuntimeFieldIdentityCollection fields) |
Gets the document fields properties. More... | |
Agility.Sdk.Model.Capture.DocumentFieldValue | GetDocumentFieldValue (string sessionId, ReportingData reportingData, string documentId, RuntimeFieldIdentity fieldIdentity) |
Retrieves the value for the specified document field, including pre-defined document system fields such as verified, rejected, number of pages etc. See Remarks section below for document system fields. More... | |
Agility.Sdk.Model.Capture.DocumentFieldValueCollection | GetDocumentFieldValues (string sessionId, ReportingData reportingData, string documentId, RuntimeFieldIdentityCollection fieldIdentities) |
Retrieves the value for the specified document fields, including pre-defined document system fields such as verified, rejected, number of pages etc. See Remarks section below for the document system fields. More... | |
Stream | GetDocumentFile (string sessionId, ReportingData reportingData, string documentId, string fileType) |
Gets the document file as a System.IO.Stream object. More... | |
Stream | GetDocumentRenditionsFile (string sessionId, string documentId, string renditionName, string fileType) |
Gets the document page renditions as single Stream. if a page doesnt have a rendition then its original source image will be used More... | |
DocumentSortResult | GetDocumentsInOrder (string sessionId, string folderId, string field1NameForSort, string field2NameForSort, string field3NameForSort, bool ascending) |
Sorts the documents in a folder and returns them sorted on up to 3 fields in ascending or descending order. The sort priority is field1, field2, then field3. More... | |
System.Data.DataSet | GetDocumentTableFieldValue (string sessionId, ReportingData reportingData, string documentId, TableFieldIdentity tableFieldIdentity) |
Returns the values of the specified table field as a Dataset. More... | |
byte[] | GetDocumentTypeImage (string sessionId, DocumentTypeIdentity documentTypeIdentity) |
Gets the document type image. More... | |
Folder | GetFolder (string sessionId, ReportingData reportingData, string folderId) |
Retrieves the details of the specified folder. More... | |
BinaryData | GetFolderBinaryExtension (string sessionId, ReportingData reportingData, string folderId, string name) |
Gets the folder binary extension. More... | |
Agility.Sdk.Model.Capture.FolderFieldValue | GetFolderFieldValue (string sessionId, ReportingData reportingData, string folderId, RuntimeFieldIdentity fieldIdentity) |
Retrieves the value for the specified folder field, including pre-defined folder system fields such as verified, number of documents, review valid etc. See Remarks section below for folder system fields More... | |
Agility.Sdk.Model.Capture.FolderFieldValueCollection | GetFolderFieldValues (string sessionId, ReportingData reportingData, string folderId, RuntimeFieldIdentityCollection fieldIdentities) |
Retrieves the values of the specified folder fields, including pre-defined folder system fields such as Verified, NoOfDocuments, ReviewValid, etc. See the Remarks section for a list of the folder system fields. More... | |
string | GetFolderTextExtension (string sessionId, ReportingData reportingData, string folderId, string name) |
Gets the folder text extension. More... | |
DocumentImage | GetImage (string sessionId, ReportingData reportingData, string imageId, int desiredWidth, int desiredHeight, string desiredFormat) |
Retrieves the image in a particular size and format. More... | |
LockedItemCollection | GetJobVariableLockStatus (string sessionId, ReportingData reportingData, JobIdentity jobIdentity) |
Gets the locked or delete status of the document/folder variables of a job. Statuses for unlocked documents/folders are ignored and therefore not returned. More... | |
NamedEntityCollection | GetNamedEntities (string sessionId, string documentId) |
Gets a list of named entities which are the result of locating and classifying named entity mentions in the unstructured text into pre-defined categories such as persons, organizations, locations, etc. More... | |
BinaryData | GetPageBinaryExtension (string sessionId, ReportingData reportingData, string documentId, string pageId, string name) |
Gets the page binary extension. More... | |
Stream | GetPageImage (string sessionId, string docId, string pageId, int desiredWidth, int desiredHeight, string desiredFormat) |
Retrieves the image in a particular size and format. More... | |
PagePropertiesCollection | GetPagePropertyValues (string sessionId, string documentId, PagePropertiesIdentityCollection pagePropertyIdentityValues) |
The API Returns the Values of System properties of Pages.You have to provide the property names or System GUIDs(which are listed below) for the System Properties for the Pages. More... | |
byte[] | GetPageRendition (string sessionId, string documentId, string pageId, short renditionNumber) |
Gets the page rendition specified by its number. More... | |
ImageSummary | GetPageRenditionImageSummary (string sessionId, string documentId, string pageId, short renditionNumber) |
Gets the page rendition image summary. More... | |
PageSummary | GetPageSummary (string sessionId, string documentId, string pageId) |
Gets the page summary. More... | |
string | GetPageTextExtension (string sessionId, ReportingData reportingData, string documentId, string pageId, string name) |
Gets the page text extension specified by its name. More... | |
StringCollection | GetPageTextExtensions (string sessionId, ReportingData reportingData, string documentId, string pageId, string[] names) |
Gets the list of page text extensions specified by their names. More... | |
RejectedPages | GetRejectedPages (string sessionId, string documentId) |
Check Document has rejected pages. More... | |
DocumentSourceFile | GetSourceFile (string sessionId, ReportingData reportingData, string documentId) |
Retrieves the source file of the specified document. Note: Document source file will have valid value for example when you import PDF file in Scan activity (or in SCNJ form). At the same time when importing valid tiff images document source file will have no value. More... | |
string | GetTextExtension (string sessionId, ReportingData reportingData, string documentId, string name) |
Gets the text extension of a document. More... | |
StringCollection | GetTextExtensions (string sessionId, ReportingData reportingData, string documentId, string[] names) |
Gets the list of text extensions of a document. More... | |
ValidationExecutionContext | GetValidationExecutionContext (string sessionId) |
Returns validation execution context that allows to determine component and place within job/process where validation logic is executing. More... | |
WordCollection | GetWordsInRectangle (string sessionId, WordCollection words, int top, int left, int height, int width) |
Returns a collection of words that are fully contained within the specified rectangle. More... | |
void | InsertTableFieldRow (string sessionId, ReportingData reportingData, string documentId, string tableFieldId, int rowIndex) |
Inserts an empty row to the table field of the supplied document at the specified position. More... | |
void | InterpolateTableField (string sessionId, ReportingData reportingData, string documentId, string tableFieldId, int selectedIndex) |
Populates the table with recognized OCR data on a page using the data from the row at the selected index as a template. Index is zero-based i.e. index 0 is row 1, index 1 is row 2 etc. More... | |
bool | IsPageRenditionDefined (string sessionId, string documentId, string pageId, short renditionNumber) |
Determines whether the specified page rendition is defined. More... | |
void | MergeDocuments (string sessionId, StringCollection documentIds) |
Merges together documents identified by the supplied document ids where the first specified document is set as the merge-to document. All other documents will have their pages moved to the end of the first document in the order they appear in the documentIds collection. More... | |
void | MoveDocument (string sessionId, ReportingData reportingData, string documentId, string folderId, int insertIndex) |
Moves a document either within the parent folder or to the specified folder at the specified position. More... | |
void | MoveFolder (string sessionId, ReportingData reportingData, string folderId, string toFolderId, int insertIndex) |
Moves the folder either within the parent folder or to a different folder at the specified index. More... | |
void | MovePages (string sessionId, ReportingData reportingData, string documentId, string toDocumentId, PageIndexCollection pageIndexes, int insertIndex) |
Moves pages of the source document at the specified indices either within itself or to a different document at a specified insert index. More... | |
void | RejectDocument (string sessionId, string documentId, string reason) |
Rejects the document with the specified reason. More... | |
void | RejectDocuments (string sessionId, StringCollection documentIds, ReportingData reportingData, string reason) |
Rejects the documents identified by the supplied document ids. More... | |
void | RejectPages (string sessionId, string documentId, PageIndexCollection pageIndexes, string reason) |
Rejects the pages with the specified reason. More... | |
bool | RemoveAllPageMasks (string sessionId, string documentId, int pageIndex) |
Removes all masks from the page with specified index. More... | |
int | RemovePageMasks (string sessionId, string documentId, int pageIndex, int left, int top, int right, int bottom) |
Removes all masks from the page with specified index that intersect with or are contained in the specified rectangle. More... | |
void | RotatePages (string sessionId, ReportingData reportingData, string documentId, PageIndexCollection pageIndexes, short rotationAngle, bool preserveTextData) |
Rotates page(s) source image and all its rendition images with optional preserving OCR data. More... | |
void | RotatePagesRendition (string sessionId, ReportingData reportingData, string documentId, PageIndexCollection pageIndexes, short rotationAngle, short renditionNumber) |
Rotates page(s) specific rendition. Source image and other renditions are not affected after rotation. More... | |
FieldValidationResult2Collection | RunDocumentFieldsValidation (string sessionId, string documentId, RuntimeFieldIdentityCollection runtimeFields) |
Run validation for document using given fields and return field validation results. More... | |
FieldValidationResult2Collection | RunFolderFieldsValidation (string sessionId, string folderId, RuntimeFieldIdentityCollection runtimeFields) |
Run validation for folder using given fields and return field validation results. More... | |
void | SaveBinaryExtension (string sessionId, ReportingData reportingData, string documentId, string name, string mimeType, byte[] data) |
Saves the binary extension. More... | |
void | SaveFolderBinaryExtension (string sessionId, ReportingData reportingData, string folderId, string name, string mimeType, byte[] data) |
Saves the folder binary extension. More... | |
void | SaveFolderTextExtension (string sessionId, ReportingData reportingData, string folderId, string name, string text) |
Saves the folder text extension. More... | |
void | SavePageBinaryExtension (string sessionId, ReportingData reportingData, string documentId, string pageId, string name, string mimeType, byte[] data) |
Saves the page binary extension. More... | |
PageImageData | SavePageImage (string sessionId, string batchId, byte[] data, string mimeType) |
Saves the page image to the repository. More... | |
void | SavePageRendition (string sessionId, string documentId, string pageId, short renditionNumber, string mimeType, byte[] imageStream) |
Saves the specified page rendition. More... | |
void | SavePageTextExtension (string sessionId, ReportingData reportingData, string documentId, string pageId, string name, string text) |
Saves the page text extension. More... | |
void | SaveTextExtension (string sessionId, ReportingData reportingData, string documentId, string name, string text) |
Saves the text extension of a document. Giving a text extension a specific prefix makes it available in Transformation Designer script as an XValue. To do this, prefix the name parameter with “XValue.”. For example, if you call the name “XValue.MyName”, then you can use the following code in the Transformation Designer script: pXDoc.Fields(0).Text = pXDoc.XValues.ItemByName("MyName").Value More... | |
SearchResult | SearchFuzzyDatabase (string sessionId, FuzzyDatabaseIdentity databaseIdentity, SearchQuery query, DocumentTypeIdentity documentTypeIdentity) |
Searches the fuzzy database for the provided query. More... | |
void | SetDocumentFieldsStatus (string sessionId, ReportingData reportingData, string documentId, FieldStatusCollection fieldsStatus) |
Sets the multuple document fields status. Pre-defined document system fields are NOT supported. More... | |
void | SetDocumentFieldStatus (string sessionId, ReportingData reportingData, string documentId, RuntimeFieldIdentity fieldIdentity, short documentFieldStatus, string message, object fieldValue) |
Sets the document field status. Pre-defined document system fields are NOT supported. More... | |
void | SetDocumentStatus (string sessionId, ReportingData reportingData, string documentId, short documentStatus, string message) |
Sets the status of the specified document. More... | |
void | SetFolderFieldStatus (string sessionId, ReportingData reportingData, string folderId, RuntimeFieldIdentity fieldIdentity, short folderFieldStatus, string message, object fieldValue) |
Sets the folder field status. Pre-defined folder system fields are NOT supported. More... | |
void | SetFolderStatus (string sessionId, ReportingData reportingData, string folderId, short folderStatus, string message) |
Sets the folder status. More... | |
void | SetPageSourceImageFromRendition (string sessionId, string documentId, string pageId, short renditionNumber) |
Sets the page source image from the rendition with the specified number. More... | |
string | SplitDocument (string sessionId, ReportingData reportingData, string documentId, int pageIndex) |
Splits a document into two by creating a new document and moving the pages starting from the specified index to the new document. More... | |
DocumentIdentityCollection | SplitDocumentAndClassify (string sessionId, ReportingData reportingData, string documentId, SplitDocumentInfoCollection splitDocumentInfoCollection) |
Splits a document into one or more documents using each index set in SplitDocumentInfo by creating new documents and moving the pages starting from each specified index to the new documents. Each of the newly created documents can also have properties set as specified in their respective SplitDocumentInfo data. More... | |
string | SplitFolder (string sessionId, ReportingData reportingData, string folderId, int index) |
Splits a folder into two by creating a new folder and moving the documents starting from the specified index to the new folder. More... | |
FormattingResult | TestFieldFormatter (string sessionId, string value, FieldFormatter fieldFormatter) |
Please note that this function is deprecated. Please use TestFieldFormatter2 instead. Tests the field formatter. More... | |
FormattingResult | TestFieldFormatter2 (string sessionId, string value, FieldFormatter fieldFormatter, BusinessRuleInputCollection ruleInputs) |
Tests the field formatter. More... | |
Agility.Sdk.Model.Capture.Validation.ValidationResult | TestFieldValidator (string sessionId, string value, Validator validator) |
Tests a validator on a document field's value. More... | |
void | UnrejectDocuments (string sessionId, StringCollection documentIds, ReportingData reportingData) |
Unrejects the documents specified by the supplied document identifiers and clears the rejection reasons. More... | |
void | UnrejectPages (string sessionId, string documentId, PageIndexCollection pageIndexes) |
Unrejects the pages. More... | |
void | UpdateDocumentFieldPropertyValues (string sessionId, ReportingData reportingData, string documentId, FieldPropertiesCollection fieldProperties) |
The API sets the Values of System properties of Document fields.You have to provide the System GUIDs(which are listed below) for the System Properties for the Fields.This API cannot be used in a TotalAgility process or form as TotalAgility does not support its class structure. More... | |
void | UpdateDocumentFieldValue (string sessionId, ReportingData reportingData, string documentId, RuntimeField runtimeField) |
Updates the value of the specified document field, including pre-defined document system fields such as verified, rejected, number of pages, etc. See Remarks section below for document system fields. More... | |
void | UpdateDocumentFieldValues (string sessionId, ReportingData reportingData, string documentId, RuntimeFieldCollection runtimeFields) |
Updates the values of the specified document fields, including pre-defined document system fields such as verified, rejected, number of pages, etc. See Remarks section below for document system fields. More... | |
void | UpdateDocumentsProcessingCompleted (string sessionId, StringCollection documentIds) |
Report that processing of the specified documents have completed. More... | |
void | UpdateDocumentType (string sessionId, string documentId, DocumentTypeIdentity documentTypeIdentity) |
Updates the type of the document. More... | |
void | UpdateDocumentType2 (string sessionId, ReportingData reportingData, string documentId, DocumentTypeIdentity documentTypeIdentity) |
Updates the type of the document. More... | |
void | UpdateDocumentTypeWithConfidence (string sessionId, string documentId, DocumentTypeIdentity documentTypeIdentity, double confidenceLevel) |
Please note that this function is deprecated. Please use UpdateDocumentTypeWithConfidence2 instead. Updates the document with the specified document type and confidence for that document type. More... | |
void | UpdateDocumentTypeWithConfidence2 (string sessionId, string documentId, DocumentTypeIdentity documentTypeIdentity, double confidenceLevel, bool classificationConfident) |
Updates the document with the specified document type, the confidence for that document type, and whether the classfication is confident or not. More... | |
void | UpdateDocumentTypeWithConfidence3 (string sessionId, ReportingData reportingData, string documentId, DocumentTypeIdentity documentTypeIdentity, double confidenceLevel, bool classificationConfident) |
Updates the document with the specified document type, the confidence for that document type, and whether the classfication is confident or not. More... | |
void | UpdateDocumentVariant (string sessionId, string documentId, string variantName) |
Updates the document variant for the document with the specified id. More... | |
void | UpdateFolderFieldValue (string sessionId, ReportingData reportingData, string folderId, RuntimeField runtimeField) |
Updates the value of the specified folder field. More... | |
void | UpdateFolderFieldValues (string sessionId, ReportingData reportingData, string folderId, RuntimeFieldCollection runtimeFields) |
Updates the values of the specified folder fields. More... | |
void | UpdatePages (string sessionId, ReportingData reportingData, string docId, PageData2Collection pageData2Collection) |
Updates the pages of a specified document with the supplied page properties. More... | |
void | UpdateSourceFile (string sessionId, ReportingData reportingData, string documentId, DocumentSourceFile sourceFile) |
Updates the source file. More... | |
void | UpdateWords (string sessionId, ReportingData reportingData, string documentId, string pageId, WordUpdateCollection wordUpdates) |
This API method updates the Text property of each of the specified words in the textlines of the specified page. More... | |
FieldValidationResult2Collection | ValidateAllDocumentFields (string sessionId, DocumentTypeIdentity documentTypeIdentity, RuntimeField2Collection documentFields, DocumentSystemProperties documentSystemProperties) |
Validates document fields against the field validators and formatters. More... | |
bool | ValidateDocument (string sessionId, string documentId) |
Validates a document by validating all its document fields. More... | |
ValidationResult | ValidateDocumentField (string sessionId, string documentTypeId, RuntimeFieldValue field) |
Validates the specified document field against the field validators and formatters. More... | |
ValidationResultCollection | ValidateDocumentFields (string sessionId, string documentTypeId, RuntimeFieldValueCollection fields) |
Validates the specified document fields against the fields validators and formatters. More... | |
ReviewValidationResult | ValidateDocumentForReview (string sessionId, string documentId) |
Validates the specified document against the document's validation rules. More... | |
ReviewValidationResult | ValidateDocumentForReviewWithType (string sessionId, string documentId, DocumentTypeIdentity documentTypeIdentity) |
Validates the specified document against the document's validation rules using the supplied document type. More... | |
bool | ValidateDocumentWithType (string sessionId, string documentId, DocumentTypeIdentity documentTypeIdentity) |
Please note that this function is deprecated. Please use ValidateDocument instead. Validates a document by validating all its document fields. More... | |
bool | ValidateFolder (string sessionId, string folderId) |
Validates a folder by validating all its fields. More... | |
ValidationResult | ValidateFolderField (string sessionId, string folderTypeId, RuntimeFieldValue field) |
Validates the specified folder field against the field validators and formatters. More... | |
ValidationResultCollection | ValidateFolderFields (string sessionId, string folderTypeId, RuntimeFieldValueCollection fields) |
Validates the specified folder fields against the fields validators and formatters. More... | |
ReviewValidationResult | ValidateFolderForReview (string sessionId, string folderId) |
Validates the specified folder against the folder's validation rules. More... | |
ReviewValidationResult | ValidateFolderForReviewWithType (string sessionId, string folderId, FolderTypeIdentity folderTypeIdentity) |
Validates the specified folder against the folder validation rules using the specified folder type. More... | |
bool | ValidateFolderWithType (string sessionId, string folderId, FolderTypeIdentity folderTypeIdentity) |
Please note that this function is deprecated. Please use ValidateFolder instead. Validates a folder by validating all its fields. More... | |
Provides methods for validating documents, configuring documents, pages and fields etc.
bool AddPageMaskForField | ( | string | sessionId, |
string | documentId, | ||
int | pageIndex, | ||
string | fieldName, | ||
int | color | ||
) |
Adds a mask to a page for rectangular area associated to specified field.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageIndex | The index of the page where mask has to be added. Cannot be negative. |
fieldName | The name of the field to be masked. |
color | Color of the mask (0 - black, any other value - white). |
bool AddPageMaskForRegion | ( | string | sessionId, |
string | documentId, | ||
int | pageIndex, | ||
int | left, | ||
int | top, | ||
int | right, | ||
int | bottom, | ||
int | color | ||
) |
Adds a mask to a page to specified rectangular area.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageIndex | The index of the page where mask has to be added. Cannot be negative. |
left | X coordinate of the masks's left-top corner. Cannot be negative. |
top | Y coordinate of the masks's left-top corner. Cannot be negative. |
right | X coordinate of the masks's right-bottom corner. Cannot be negative. |
bottom | Y coordinate of the masks's right-bottom corner. Cannot be negative. |
color | Color of the mask (0 - black, any other value - white). |
string CopyDocument | ( | string | sessionId, |
string | sourceDocumentId, | ||
string | targetDocumentId, | ||
StringCollection | fieldNames, | ||
short | copyDocumentOptions | ||
) |
Copies properties of the source document to the target document. If the target document is not specified (either null or empty), a new document will be created under the same parent folder where the source document is located.
Note that this method does not copy pages. If you need to copy pages, then use the CopyDocumentWithPages() method instead.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
sourceDocumentId | The source document id that needs to be copied. Cannot be null or empty. | ||||||||
targetDocumentId | The target document id. Can be null or empty to create a new document. | ||||||||
fieldNames | List of the field names that need to copied. If specified as null, then all of the fields from the source document will be copied (except Pages and MimeType). | ||||||||
copyDocumentOptions | The copy document options:
|
void CopyDocumentFieldValues | ( | string | sessionId, |
string | sourceDocumentId, | ||
string | targetDocumentId | ||
) |
Copies the field values from a source document to a target document and overwrites the existing values in the target document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
sourceDocumentId | The id of the source document. Cannot be null or empty |
targetDocumentId | The id of the target document. Cannot be null or empty |
string CopyDocumentWithPages | ( | string | sessionId, |
string | documentId, | ||
int | insertIndex | ||
) |
Copies properties of the source document including pages and returns a new document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The source document id that needs to be copied. Cannot be null. |
insertIndex | Index at which the document should be created within folder. Index is zero-based i.e. index of 1 means insert after the first child (first child has index of 0), index of -1 means it will add to the end. |
DocumentIdentity CreateDocument | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | parentId, | ||
RuntimeFieldCollection | runtimeFields, | ||
string | filePath, | ||
int | insertIndex, | ||
string | documentTypeId, | ||
string | folderTypeId | ||
) |
Please note that this function is deprecated. Please use CreateDocument3 instead.
Creates a document of the specified document type. If the parent folder of the document is not specified, then a new folder will be created as its parent.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null.
| ||||||||||||||||||||||||
parentId | Instance id of the existing folder under which the document should be created. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||
runtimeFields | A collection of RuntimeField objects containing details of the document type fields and/or document system fields that need to be added. Can be null or empty.
| ||||||||||||||||||||||||
filePath | The path of the document image file on the application server's file system or a network location relative to the server. Can be null or empty. Note that in the case of Azure or distributed environments, only shared paths will work. | ||||||||||||||||||||||||
insertIndex | Index location within the folder where the document should be created. The index is zero-based, that is, the first document has an index of 0, the second document has an index of 1, and so forth. | ||||||||||||||||||||||||
documentTypeId | Id of the document type that needs to be assigned to the created document. If a null or empty string value is used, then a document with the default document type will be created. | ||||||||||||||||||||||||
folderTypeId | Folder type id of the folder under which the document should be created if parentId is not set. See Remarks for conditions on setting this parameter. |
Name | Type | Comment |
---|---|---|
DocumentId | String | document id |
FolderId | String | folder id |
DocumentIdentity CreateDocument2 | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | parentId, | ||
RuntimeFieldCollection | runtimeFields, | ||
string | filePath, | ||
int | insertIndex, | ||
string | documentTypeId, | ||
string | folderTypeId, | ||
FieldPropertiesCollection | runtimeFieldProperties | ||
) |
Please note that this function is deprecated. Please use CreateDocument3 instead.
Creates a document of the specified document type. This API is designed for use in custom code, as such it is not expected to be consumed within in .NET process activities, web service activities and .NET form actions as TotalAgility does not support its class structure and thus will not provide access to some of its data elements.This API can be used in C# and VB.NET script activities.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parentId | Instance id of the existing folder under which the document should be created. See Remarks for conditions on setting this parameter. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
runtimeFields | A collection of RuntimeField objects containing details for the fields that need to be added. Can be null
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filePath | The path of the file that needs to be added. Can be null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insertIndex | Index location within folder where the document should be added. The index is zero-based i.e. the first document is index 0, the 2nd document is index 1 etc. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentTypeId | Id of the document type that we create and instance of. Can be null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
folderTypeId | Folder type id of the folder under which the document should be created if parentId is not set. See Remarks for conditions on setting this parameter. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
runtimeFieldProperties | A collection of FieldProperties class contains RuntimeFieldIdentity and FieldSystemPropertyCollection as members. RuntimeFieldIdentity members.
The value for Confidence must be between 0 and 1 (e.g. 0.88) as a percentage. |
Name | Type | Comment |
---|---|---|
DocumentId | String | document id |
FolderId | String | folder id |
DocumentIdentity CreateDocument3 | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | parentId, | ||
RuntimeFieldCollection | runtimeFolderFields, | ||
string | folderTypeId, | ||
DocumentDataInput2 | documentDataInput, | ||
int | insertIndex | ||
) |
Creates a document of the specified document type. This API is designed for use in custom code, as such it is not expected to be consumed within in .NET process activities, web service activities and .NET form actions as TotalAgility does not support its class structure and thus will not provide access to some of its data elements.This API can be used in C# and VB.NET script activities.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||||||||||
parentId | Instance id of the existing folder under which the document should be created. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||
runtimeFolderFields | A collection of RuntimeField objects containing details for the fields that need to be added. Can be null
| ||||||||||||||||||||||||
folderTypeId | Folder type id of the folder under which the document should be created if parentId is not set. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||
documentDataInput | A Model.Capture.DocumentDataInput2 object containing data required to create a document. Model.Capture.DocumentDataInput2 object has a number of properties but not all of them are used together. Thus, for example the following properties are mutually exclusive: PageImages, PageDataList, FilePath and Data. This means that if one of these properties is initialzed then other properties are not used. Each of these properties specifies the content of a document. In case PageImages or PageDataList property is initialized with data then corresponding pages will be created within the document. If FilePath or Data property is initialized then data will be stored either as a document source file or as an individual pages in case passed data represents a multipage file and MimeType property was correctly set. For more details see Remarks section. | ||||||||||||||||||||||||
insertIndex | Index location within folder where the document should be added. The index is zero-based i.e. the first document is index 0, the 2nd document is index 1 etc. |
Name | Type | Comment |
---|---|---|
DocumentId | String | document id |
FolderId | String | folder id |
DocumentIdentityCollection CreateDocuments | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | parentId, | ||
RuntimeFieldCollection | runtimeFolderFields, | ||
string | folderTypeId, | ||
DocumentDataInputCollection | documentData | ||
) |
Please note that this function is deprecated. Please use CreateDocuments2 instead.
Create documents.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||||||||||||||
parentId | Instance id of the existing folder under which the documents should be created. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||||||||||||||
runtimeFolderFields | A collection of type RuntimeField indicating the folder field values to be set. Can be null. This is ignored if parentId is set. RuntimeField members.
| ||||||||||||||||||||||||||||||||||||
folderTypeId | Folder type id of the folder under which the documents should be created if parentId is not set. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||||||||||||||
documentData | Collection of type DocumentInputData. Cannot be null.
|
Name | Type | Comment |
---|---|---|
DocumentId | string | document id |
FolderId | string | folder id |
Name | Type | Id |
---|---|---|
ImageID | String | D576DDE6FE3649CEB32DFD28845487C3 |
SheetID | String | 9290D05F7D0F4F2786DA3DE0BBCBF891 |
IsFront | Boolean | 01FBA6D5EE40411FA435644376D8C316 |
MimeType | String | EDDA201B9E9C46BD8121F24B2E72A1CE |
HorizontalResolution | Double | 05D0FE805F6A4D53A7538816084C2A9E |
VerticalResolution | Double | D101F18AF1FC4E848E0F08B8384066DC |
RotationType | Enum | D4E9F5534C484840A56CC20F0730AA92 |
Barcodes | BarcodeCollection | C7091EE3F1764D9B830A2DCCDDE3BC66 |
Annotations | CaptureAnnotationCollection | 4F8BF8ABF72844AFB601D79F01FCD172 |
Height | Int32 | 0D5434EA13E643D19E84881202A74271 |
Width | Int32 | 57491C9612194E639DBF85ECD794ECB2 |
ImprintedText | String | C669842EA20A47F0A0F6D48EB0F3FBEE |
VRSProcessed | Boolean | 9F36442A45814F48A5A140D05D7072C4 |
IsRejected | Boolean | CD0F9328210B4DE4B9B8A306B20BF8FC |
RejectionNote | String | 56840E9FF63F47BD83EF726E9B989A0A |
Enumeration | Description |
---|---|
-1 | Unknown |
0 | None |
90 | Left90 |
180 | Rotate180 |
270 | Right90 |
DocumentIdentityCollection CreateDocuments2 | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | parentId, | ||
RuntimeFieldCollection | runtimeFolderFields, | ||
string | folderTypeId, | ||
DocumentDataInput2Collection | documentData | ||
) |
Create documents.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parentId | Instance id of the existing folder under which the document should be created. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
runtimeFolderFields | A collection of type RuntimeField indicating the folder field values to be set. Can be null. This is ignored if parentId is set. RuntimeField members.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
folderTypeId | Folder type id of the folder under which the document should be created if parentId is not set. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentData | A collection of type DocumentDataInput2. Cannot be null.
RuntimeFieldIdentity members. Name | Type | Comment ---------------—|---------—|-------------------------------------—
The value for Confidence must be between 0 and 1 (e.g. 0.88) as a percentage. |
Name | Type | Comment |
---|---|---|
DocumentId | string | document id |
FolderId | string | folder id |
The values for the System Page Fields are:
Name | Type | Id |
---|---|---|
ImageID | String | D576DDE6FE3649CEB32DFD28845487C3 |
SheetId | String | 9290D05F7D0F4F2786DA3DE0BBCBF891 |
IsFront | Boolean | 01FBA6D5EE40411FA435644376D8C316 |
MimeType | String | EDDA201B9E9C46BD8121F24B2E72A1CE |
HorizontalResolution | Double | 05D0FE805F6A4D53A7538816084C2A9E |
VerticalResolution | Double | D101F18AF1FC4E848E0F08B8384066DC |
RotationType | Enum | D4E9F5534C484840A56CC20F0730AA92 |
Barcodes | BarcodeCollection | C7091EE3F1764D9B830A2DCCDDE3BC66 |
Annotations | CaptureAnnotationCollection | 4F8BF8ABF72844AFB601D79F01FCD172 |
Height | Int32 | 0D5434EA13E643D19E84881202A74271 |
Width | Int32 | 57491C9612194E639DBF85ECD794ECB2 |
ImprintedText | String | C669842EA20A47F0A0F6D48EB0F3FBEE |
VRSProcessed | Boolean | 9F36442A45814F48A5A140D05D7072C4 |
IsRejected | Boolean | CD0F9328210B4DE4B9B8A306B20BF8FC |
RejectionNote | String | 56840E9FF63F47BD83EF726E9B989A0A |
The values for RotationType are:
Enumeration | Description |
---|---|
-1 | Unknown |
0 | None |
90 | Left90 |
180 | Rotate180 |
270 | Right90 |
DocumentIdentity CreateDocumentWithPages | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | parentId, | ||
RuntimeFieldCollection | runtimeFields, | ||
string | documentTypeId, | ||
string | folderTypeId, | ||
PageDataCollection | pages | ||
) |
Creates the document with pages.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null.
| ||||||||||||||||||||||||
parentId | Instance id of the existing folder under which the document should be created. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||
runtimeFields | A collection of type RuntimeField containing the document type field information that needs to be added. Can be null.
| ||||||||||||||||||||||||
documentTypeId | Id of the document type for which the document instance needs to be created. Can be null. | ||||||||||||||||||||||||
folderTypeId | Folder type id of the folder under which the document should be created if parentId is not set. See Remarks for conditions on setting this parameter. | ||||||||||||||||||||||||
pages | A collection of type PageData. Cannot be a nonimage mime type, null, or empty.
|
Name | Type | Comment |
---|---|---|
DocumentId | string | document id |
FolderId | string | folder id |
Name | Type | Id |
---|---|---|
ImageID | String | D576DDE6FE3649CEB32DFD28845487C3 |
SheetId | String | 9290D05F7D0F4F2786DA3DE0BBCBF891 |
IsFront | Boolean | 01FBA6D5EE40411FA435644376D8C316 |
MimeType | String | EDDA201B9E9C46BD8121F24B2E72A1CE |
HorizontalResolution | Double | 05D0FE805F6A4D53A7538816084C2A9E |
VerticalResolution | Double | D101F18AF1FC4E848E0F08B8384066DC |
RotationType | Enum | D4E9F5534C484840A56CC20F0730AA92 |
Barcodes | BarcodeCollection | C7091EE3F1764D9B830A2DCCDDE3BC66 |
Annotations | CaptureAnnotationCollection | 4F8BF8ABF72844AFB601D79F01FCD172 |
Height | Int32 | 0D5434EA13E643D19E84881202A74271 |
Width | Int32 | 57491C9612194E639DBF85ECD794ECB2 |
ImprintedText | String | C669842EA20A47F0A0F6D48EB0F3FBEE |
VRSProcessed | Boolean | 9F36442A45814F48A5A140D05D7072C4 |
IsRejected | Boolean | CD0F9328210B4DE4B9B8A306B20BF8FC |
RejectionNote | String | 56840E9FF63F47BD83EF726E9B989A0A |
Enumeration | Description |
---|---|
-1 | Unknown |
0 | None |
90 | Left90 |
180 | Rotate180 |
270 | Right90 |
string CreateFolder | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | parentId, | ||
RuntimeFieldCollection | runtimeFields, | ||
int | insertIndex, | ||
CategoryIdentity | folderTypeCategory, | ||
FolderTypeIdentity | folderTypeIdentity | ||
) |
Creates a folder of the specified folder type.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||||||||||
parentId | Instance id of the existing folder under which the folder should be created. Can be null or empty. If parentId and folderTypeIdentity parameters are not set, then a root folder with the default folder type will be created. If parentId is set, then folder type of the parent folder must allow for creating subfolders. | ||||||||||||||||||||||||
runtimeFields | A collection of RuntimeField objects containing the folder type field information that needs to be added. Can be null or empty. RuntimeField members.
| ||||||||||||||||||||||||
insertIndex | Index at which the folder should be created. The index is zero-based, that is, an index of 0 inserts the folder as the first child folder, 1 inserts the folder as the second child folder, and so forth. An index of less than 0 inserts the folder as the last child folder. | ||||||||||||||||||||||||
folderTypeCategory | A CategoryIdentity object containing the category of the folder type. Can be null.
| ||||||||||||||||||||||||
folderTypeIdentity | A FolderTypeIdentity object containing the id or name of the folder type to be created. Can be null. If folderTypeIdentity and parentId parameters are not set, then a root folder with the default folder type will be created.
|
string CreateOnlineLearningFolder | ( | string | sessionId, |
int | maxSamples | ||
) |
Creates an online learning folder (contain document types you have identified previously so this information can be reused when you encounter the same document types rather than trying to identify all fields etc. from scratch)
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
maxSamples | The maximum number of documents the online learning folder should accept. |
void CreatePage | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
RuntimeFieldCollection | runtimeFields, | ||
string | filePath, | ||
int | insertIndex | ||
) |
Creates a page to a document with the image read from a file path.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||||||||||
documentId | The document instance id of the document type for which the page should be created. Cannot be null. | ||||||||||||||||||||||||
runtimeFields | A collection of RuntimeField objects containing information about system page fields which need to be set. Can be null. See Remarks section below for the page system fields.
| ||||||||||||||||||||||||
filePath | The location of the file on Kofax TotalAgility server file system or network path that needs to be added. Cannot be null. Note that in case of Azure or distributed environment only shared paths will work. | ||||||||||||||||||||||||
insertIndex | Index location within document where the page should be added. The index is zero-based i.e. the first page is index 0, the 2nd page is index 1 etc. |
Name | Type | Id |
---|---|---|
ImageID | String | D576DDE6FE3649CEB32DFD28845487C3 |
SheetId | String | 9290D05F7D0F4F2786DA3DE0BBCBF891 |
IsFront | Boolean | 01FBA6D5EE40411FA435644376D8C316 |
MimeType | String | EDDA201B9E9C46BD8121F24B2E72A1CE |
HorizontalResolution | Double | 05D0FE805F6A4D53A7538816084C2A9E |
VerticalResolution | Double | D101F18AF1FC4E848E0F08B8384066DC |
RotationType | Enum | D4E9F5534C484840A56CC20F0730AA92 |
Barcodes | BarcodeCollection | C7091EE3F1764D9B830A2DCCDDE3BC66 |
Annotations | CaptureAnnotationCollection | 4F8BF8ABF72844AFB601D79F01FCD172 |
Height | Int32 | 0D5434EA13E643D19E84881202A74271 |
Width | Int32 | 57491C9612194E639DBF85ECD794ECB2 |
ImprintedText | String | C669842EA20A47F0A0F6D48EB0F3FBEE |
VRSProcessed | Boolean | 9F36442A45814F48A5A140D05D7072C4 |
IsRejected | Boolean | CD0F9328210B4DE4B9B8A306B20BF8FC |
RejectionNote | String | 56840E9FF63F47BD83EF726E9B989A0A |
Enumeration | Description |
---|---|
-1 | Unknown |
0 | None |
90 | Left90 |
180 | Rotate180 |
270 | Right90 |
void CreatePageUsingStream | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
RuntimeFieldCollection | runtimeFields, | ||
byte[] | data, | ||
int | insertIndex, | ||
string | mimeType | ||
) |
Creates a page to a document with the image passed as a stream.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||||||||||
documentId | The document instance id of the document type for which the page should be created. | ||||||||||||||||||||||||
runtimeFields | A collection of RuntimeField objects containing information about system page fields which need to be set. Can be null. See Remarks section below for the page system fields.
| ||||||||||||||||||||||||
data | Byte data of the file that needs to be added. Cannot be null. | ||||||||||||||||||||||||
insertIndex | Index location within document where the page should be added. The index is zero-based i.e. the first page is index 0, the 2nd page is index 1 etc. | ||||||||||||||||||||||||
mimeType | File that will be created with the specified mime type. Can be null. |
Name | Type | Id |
---|---|---|
ImageID | String | D576DDE6FE3649CEB32DFD28845487C3 |
SheetId | String | 9290D05F7D0F4F2786DA3DE0BBCBF891 |
IsFront | Boolean | 01FBA6D5EE40411FA435644376D8C316 |
MimeType | String | EDDA201B9E9C46BD8121F24B2E72A1CE |
HorizontalResolution | Double | 05D0FE805F6A4D53A7538816084C2A9E |
VerticalResolution | Double | D101F18AF1FC4E848E0F08B8384066DC |
RotationType | Enum | D4E9F5534C484840A56CC20F0730AA92 |
Barcodes | BarcodeCollection | C7091EE3F1764D9B830A2DCCDDE3BC66 |
Annotations | CaptureAnnotationCollection | 4F8BF8ABF72844AFB601D79F01FCD172 |
Height | Int32 | 0D5434EA13E643D19E84881202A74271 |
Width | Int32 | 57491C9612194E639DBF85ECD794ECB2 |
ImprintedText | String | C669842EA20A47F0A0F6D48EB0F3FBEE |
VRSProcessed | Boolean | 9F36442A45814F48A5A140D05D7072C4 |
IsRejected | Boolean | CD0F9328210B4DE4B9B8A306B20BF8FC |
RejectionNote | String | 56840E9FF63F47BD83EF726E9B989A0A |
Enumeration | Description |
---|---|
-1 | Unknown |
0 | None |
90 | Left90 |
180 | Rotate180 |
270 | Right90 |
DeletionResult DeleteDocument | ( | string | sessionId, |
string | documentId, | ||
ReportingData | reportingData, | ||
bool | failOnError | ||
) |
Deletes the document with specified id. Additionally, if the deletion fails and the failOnError parameter is set to true and the API method is called within a job, then the document's associated job will be suspended.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentId | The id of the document to be deleted. Cannot be null or empty. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
failOnError | If set to true and an error occurs during deletion, then the API method causes the job to be suspended. If set to false and the document deletion fails, then it sets the error message on the DeletionResult ErrorInfo property. |
Name | Type | Comment |
---|---|---|
Succeeded | Boolean | Indicates if deletion succeeded |
ErrorInfo | String | Gives details of deletion failure |
DeletionResult DeleteDocuments | ( | string | sessionId, |
StringCollection | documentIds, | ||
ReportingData | reportingData, | ||
bool | ignoreError | ||
) |
Deletes the specified documents. Additionally, if the delete fails and the failOnError parameter is set to true, then jobs associated with the documents will be suspended.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentIds | The id of the documents to be deleted. Cannot be null | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
ignoreError | If set to true and an error occurs during deletion, then the API method causes the job to be suspended. If set to false and the documents deletion fails, then it sets the error message on the DeletionResult ErrorInfo property. |
Name | Type | Comment |
---|---|---|
Succeeded | Boolean | Indicates if deletion succeeded |
ErrorInfo | String | Gives details of deletion failure |
void DeleteExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | name | ||
) |
Deletes the specified text or binary extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty. | ||||||||||||||||
name | The key used to store the text or binary extension. Cannot be null or empty. |
DeletionResult DeleteFolder | ( | string | sessionId, |
string | folderId, | ||
ReportingData | reportingData, | ||
bool | failOnError | ||
) |
Deletes the folder with specified id. Additionally, if the delete operation fails and the failOnError parameter is set to true and the API method is called within a job, then the folder's associated job will be suspended.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
folderId | The id of the folder to be deleted. Cannot be null or empty. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
failOnError | If set to true and an error occurs during deletion, then the API throws an error and causes the job to be suspended. If set to false and the folder delete operation fails, then it sets the error message on the DeletionResult ErrorInfo property. |
Name | Type | Comment |
---|---|---|
Succeeded | Boolean | Indicates if deletion succeeded |
ErrorInfo | String | Gives details of deletion failure |
void DeleteFolderExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
string | name | ||
) |
Deletes the folder extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
folderId | The folder identifier. |
name | Name of the extension. |
void DeletePageExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | pageId, | ||
string | extensionName | ||
) |
Deletes the page extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
documentId | The document identifier. |
pageId | The page identifier. |
extensionName | Name of the extension. |
void DeletePageRendition | ( | string | sessionId, |
string | documentId, | ||
string | pageId, | ||
short | renditionNumber | ||
) |
Deletes the specified page rendition.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. |
renditionNumber | The rendition number. Must be greater than zero. |
void DeletePages | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
PageIndexCollection | pageIndexes | ||
) |
Deletes the pages of the specified document at the given indices.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document from which pages are going to be deleted. Cannot be null or empty. | ||||||||||||||||
pageIndexes | A collection of PageIndex objects identifying the pages that need to be deleted. The indices are zero-based, that is, the first page has index 0, the 2nd page has index 1, and so forth. Cannot be null or empty. PageIndex members.
|
void DeleteSourceFile | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId | ||
) |
Deletes the source file.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
documentId | The document identifier. |
void DeleteTableFieldRow | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | tableFieldId, | ||
RowIndexCollection | rowIndexes | ||
) |
Deletes the list of row indexes from the table. Indices are zero-based i.e. row 1 is index 0, row 2 is index 1.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document whose table field rows need to be deleted. Cannot be null or empty | ||||||||||||||||
tableFieldId | The field id of the table field. Cannot be null or empty | ||||||||||||||||
rowIndexes | A collection of RowIndex objects identifying the indices at which the rows need to be deleted. The indices are zero-based i.e. the first row is index 0, the 2nd row is index 1 etc.Cannot be null RowIndex members.
|
void ForceUnlockItem | ( | string | sessionId, |
ReportingData | reportingData, | ||
LockedItemIdentity | identity | ||
) |
Forcefully unlocks the document or folder. This sets the Locked property of the document or folder to a value of false.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can NOT be null. NOT used by this API
| ||||||||||||||||
identity | A LockedItemIdentity identity object identifying the item to be unlocked. Cannot be null
|
FormattingResult FormatField | ( | string | sessionId, |
string | value, | ||
FormatterIdentity | formatterIdentity | ||
) |
Please note that this function is deprecated. Please use FormatField2 instead.
Tests the field value against the specified formatter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
value | The value that needs to tested against the formatter. Cannot be null | ||||||||||||
formatterIdentity | A FormatterIdentity identity object identifying the formatter. Cannot be null
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
FormattedText | String | The formatted text |
FormattingResult FormatField2 | ( | string | sessionId, |
string | value, | ||
FormatterIdentity | formatterIdentity, | ||
BusinessRuleInputCollection | ruleInputs | ||
) |
Tests the field value against the specified formatter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
value | The value that needs to tested against the formatter. Cannot be null | ||||||||||||
formatterIdentity | A FormatterIdentity identity object identifying the formatter. Cannot be null
| ||||||||||||
ruleInputs | A collection of BusinessRuleInput that specifies the names, types, and values for the input parameters of an associated business rule. |
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
FormattedText | String | The formatted text |
WordCollection GetAllMaskedWords | ( | string | sessionId, |
string | documentId, | ||
int | pageIndex | ||
) |
Gets all words that are masked on a page with specified index.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageIndex | The index of the page. Cannot be negative. |
PageMaskCollection GetAllPageMasks | ( | string | sessionId, |
string | documentId, | ||
int | pageIndex | ||
) |
Gets all explicit masks associated to a page with specified index.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageIndex | The index of the page. Cannot be negative. |
AnnotationDataCollection GetAnnotations | ( | string | sessionId, |
string | documentId | ||
) |
Gets annotations for the specified document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
Name | Type | Comment |
---|---|---|
Location | PointF | Annotation location. (System.Drawing.PointF) |
PageIndex | Int32 | Page index of the annotation. |
Size | SizeF | Annotation size. (System.Drawing.SizeF) |
BinaryData GetBinaryExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | name | ||
) |
Gets the specified binary extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty. | ||||||||||||||||
name | The key used to store the binary extension. Cannot be null or empty. |
Document GetDocument | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId | ||
) |
Retrieves a document using document id.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document to be retrieved. Cannot be null or empty |
string GetDocumentAsFile | ( | string | sessionId, |
string | documentId, | ||
string | fileLocation, | ||
string | fileName | ||
) |
Gets the image document as a file (.tiff format) and it will be saved to the specified location with the specified name.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null |
fileLocation | The location where the file should be saved. Note: This parameter will be ignored in Azure deployments. |
fileName | Use this name for the file |
FieldAlternativeCollection GetDocumentFieldAlternatives | ( | string | sessionId, |
string | documentId, | ||
FieldIdentity | fieldIdentity, | ||
int | numberOfRowsToReturn | ||
) |
Please note that this function is deprecated. Please use GetDocumentFieldAlternatives2 instead.
Get the alternatives for the value of the specified document field, including pre-defined document system fields such as verified, rejected, number of pages etc. See Remarks section below for the document system fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
documentId | The id of the document. Cannot be null or empty | ||||||||||||||||||||
fieldIdentity | A FieldIdentity object that identifies the field. Cannot be null
| ||||||||||||||||||||
numberOfRowsToReturn | The number of rows (values) to return. |
Name | Type | Comment |
---|---|---|
PageIndex | Int32 | Identifies the page index |
Confidence | Double | Indicates the condifence level for the field value |
Text | String | Value as text |
FieldAlternative2Collection GetDocumentFieldAlternatives2 | ( | string | sessionId, |
string | documentId, | ||
FieldIdentity | fieldIdentity, | ||
int | numberOfRowsToReturn | ||
) |
Get the alternatives for the specified document field.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
documentId | The id of the document. Cannot be null or empty | ||||||||||||||||||||
fieldIdentity | A FieldIdentity object that identifies the field. Cannot be null
| ||||||||||||||||||||
numberOfRowsToReturn | The number of field alternatives to return. Defaults to one for any value less than one. |
Name | Type | Comment |
---|---|---|
PageIndex | Int32 | Identifies the page index |
Confidence | Double | Indicates the confidence level for the field value |
Text | String | Value as text |
Height | Int32 | Field height |
Width | Int32 | Field width |
Left | Int32 | The left coordinate of the top left corner of the field |
Top | Int32 | The top coordinate of the top left corner of the field |
FieldPropertiesCollection GetDocumentFieldPropertyValues | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
FieldPropertiesIdentityCollection | fieldProperties | ||
) |
The API Returns the Values of System properties of Document fields.You have to provide the System GUIDs(which are listed below) for the System Properties for the Fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentId | The id of the document whose field value is to be retrieved. Cannot be null or empty | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldProperties | A collection of FieldPropertiesIdentity containing RuntimeFieldIdentity and FieldSystemPropertyIdentityCollection as members. RuntimeFieldIdentity members.
The value for Confidence must be between 0 and 1 (e.g. 0.88) as a percentage. The values for VerificationMode are:
|
Name | Type | Comment | Required |
---|---|---|---|
Id | String | The id of the field | Yes/No. One of Id or Name must be specified |
Name | String | The name of the field | Yes/No. One of Id or Name must be specified |
TableRow | Int32 | Used if the field is a table field, otherwise -1 | Yes |
TableColumn | Int32 | Used if the field is a table field, otherwise -1 | Yes |
Name | Type | Comment |
---|---|---|
Id | String | The id of the System Property of Field |
Name | String | The name of the System Property of Field; it will not be populated if the Id was only populated on the input parameter of the call |
Value | Object | The Value of the System Property of Field |
FieldAlternativesCollection GetDocumentFieldsAlternatives | ( | string | sessionId, |
string | documentId, | ||
FieldIdentityCollection | fields, | ||
int | numberOfRowsToReturn | ||
) |
Please note that this function is deprecated. Please use GetDocumentFieldsAlternatives2 instead.
Gets the document fields alternatives for the specified fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
documentId | The id of the document. Cannot be null or empty | ||||||||||||||||||||
fields | A FieldIdentityCollection collection of FieldIdentity objects identifying the fields we need to get the alternative values for. Cannot be null FieldIdentity members.
| ||||||||||||||||||||
numberOfRowsToReturn | The number of rows (values) to return. |
Name | Type | Comment |
---|---|---|
FieldIdentity | Identity | Identifies the field |
DocumentFieldAlternatives | Collection | A collection of FieldAlternative objects describing the fields alternative values |
FieldAlternatives2Collection GetDocumentFieldsAlternatives2 | ( | string | sessionId, |
string | documentId, | ||
FieldIdentityCollection | fields, | ||
int | numberOfRowsToReturn | ||
) |
Gets the document fields alternatives for the specified fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
documentId | The id of the document. Cannot be null or empty | ||||||||||||||||||||
fields | A FieldIdentityCollection collection of FieldIdentity objects identifying the fields we need to get the alternative values for. Cannot be null FieldIdentity members.
| ||||||||||||||||||||
numberOfRowsToReturn | The number of rows (values) to return. Defaults to one for any value less than one. |
Name | Type | Comment |
---|---|---|
FieldIdentity | Identity | Identifies the field |
DocumentFieldAlternatives | Collection | A collection of FieldAlternative objects describing the fields alternative values |
DocumentFieldAlternatives2 | Collection | A collection of FieldAlternative2 objects describing the fields alternative values |
RuntimeField2Collection GetDocumentFieldsProperties | ( | string | sessionId, |
string | documentId, | ||
RuntimeFieldIdentityCollection | fields | ||
) |
Gets the document fields properties.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
fields | Selected field indentities RuntimeFieldIndentityCollection. this can be null or empty, if this is null or empty then all the document fields's system properties will be returned, data for table cells is not returned in this case |
Name | Type | Comment |
---|---|---|
Id | String | Runtime field id |
Name | String | Runtime field name |
SystemProperties | FieldSystemProperties | Field's system properties |
TableCells | RuntimeTableCell2Collection | Collection of RuntimeTableCell2 objects |
Value | object | Object containing the runtime field value |
Agility.Sdk.Model.Capture.DocumentFieldValue GetDocumentFieldValue | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
RuntimeFieldIdentity | fieldIdentity | ||
) |
Retrieves the value for the specified document field, including pre-defined document system fields such as verified, rejected, number of pages etc. See Remarks section below for document system fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||
documentId | The id of the document whose field value is to be retrieved. Cannot be null or empty | ||||||||||||||||||||||||
fieldIdentity | A RuntimeFieldIdentity object identifying the field whose value is to be retrieved. Cannot be null
|
Name | Type | Comment |
---|---|---|
Value | Object | The value of the field |
The values for the Document System Fields are the following:
Name | Type | Id |
---|---|---|
TypeId | String | 9573A20A21AB4B3CB21137F139966C72 |
Type | String | 0AFBFAD4D6C74C9BBD809DFD6AB799AF |
TypeVersion | Double | 5EDE5526336A438C9B1B521BC603F57D |
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
Name | String | AC1929D2A30444979E0E2205BCC5F533 |
InstanceID | String | F938266C4CC640FC8C289D1FE732CD3E |
OriginalId | String | 43F14EB486E140B299C8679914101812 |
ParentID | String | F54574DE15514CD58572E40F8BEA6FE2 |
Fields | RuntimeFieldDataCollection | EEB1999168994F5FB9FF3B3048B4647D |
Pages | Object[][] | 81B878806BE04AF487871A477513255D |
NoOfPages | Int32 | 2B4DDB6410E44F7DA94139788CDAECB4 |
Rejected | Boolean | A6E9047F80954F12A9F17896705012C3 |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
RejectionReason | String | A852B51DCC6A47E68146B5DA8C56BD6E |
IsReadOnly | Boolean | 9DE528380F6C4B5FBDB0825A2A3BC683 |
OnlineLearningOptions | Enum | DD30500FCB0C467193110FB8631ECAB2 |
OnlineLearningComments | String | 66A8E1BB50B94C829C9016A5D34BB608 |
MimeType | String | 7D7F45CFFD4147298DDE9651686B5E34 |
ClassificationConfident | Boolean | CBF5FD7FF3364B7AB575EC7654E15CD4 |
ClassificationResults | ClassificationResultCollection | EAFC9B1E37CF4868BEAF3E7ADFDB0039 |
CreatedAt | DateTime | 561427B7EF7745C7A0EC27FB357CA52C |
LastAccessedAt | DateTime | 8748EB7C13414D08A777D5C73AA9CDA5 |
IsLocked | Boolean | A33EDBF33B844FD0803866894C6D18A1 |
LockedAt | DateTime | 243290C0A90B41A88558DAEBCBBBF421 |
LockedBy | String | 4089A99F008D4FB2A5B154D9FFD6ACD2 |
SeparationProceeded | Boolean | 0770B991FC034872B087884C21AE80E4 |
SourceFileId | String | B987564B78EB47829D91BFEDEE024BC2 |
SourceFileType | String | 80B73BDC5ED44EE79473E4672782EEA4 |
ValidateAllPerformed | Boolean | B56F93CF5E5A4D4189E17BCA487F4854 |
ReviewForcedValidReason | String | 63C1C23BB51F4D128FD743CA36084A3C |
OriginalTypeId | String | 05C0B57FE10143F7B3B38E39E8CAB567 |
OriginalTypeIdBeforeRedirection | String | 1413471B0BCF4B60960D1D7277AC18ED |
IsReclassified | Boolean | 55052E26435F466B9DC5CD92A33615F3 |
ExtensionNames | StringCollection | 62807D67F4054668BAB1B20B9EDCEF5C |
FileName | String | 1F8220766FAF42278F5CF8081DBF6D87 |
ImageProcessingBlankPagesRemovedCount | Int32 | DAD9CDF9021D4CC8BD2995151B82C41E |
ImageProcessingAllPagesDetectedBlank | Boolean | D685392D874D433AAD4B17FD19E6F786 |
VariantName | String | 8A2B611345804ACCB73EB50C51781558 |
VariantId | String | 274CA95D14694C5DB9F0C2586364A300 |
VariantVersion | Double | 496742CFDA58453A85D318306F3224BE |
The values for OnlineLearningOptions are:
Enumeration | Description |
---|---|
0 | None (no online learning) |
1 | GenericClassification (generic classification) |
2 | GenericExtraction (generic extraction) |
4 | Specific (specific online learning) |
8 | Limloc (DCX file in use for LIMLoc Unassisted Training) |
Agility.Sdk.Model.Capture.DocumentFieldValueCollection GetDocumentFieldValues | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
RuntimeFieldIdentityCollection | fieldIdentities | ||
) |
Retrieves the value for the specified document fields, including pre-defined document system fields such as verified, rejected, number of pages etc. See Remarks section below for the document system fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||
documentId | The id of the document whose field values are to be retrieved. Cannot be null or empty | ||||||||||||||||||||||||
fieldIdentities | A collection of RuntimeFieldIdentity objects identifying the fields whose values need to be retrieved. Cannot be null RuntimeFieldIdentity members.
|
Name | Type | Comment |
---|---|---|
Value | Object | The value of the field |
The values for the Document System Fields are:
Name | Type | Id |
---|---|---|
TypeId | String | 9573A20A21AB4B3CB21137F139966C72 |
Type | String | 0AFBFAD4D6C74C9BBD809DFD6AB799AF |
TypeVersion | Double | 5EDE5526336A438C9B1B521BC603F57D |
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
Name | String | AC1929D2A30444979E0E2205BCC5F533 |
InstanceID | String | F938266C4CC640FC8C289D1FE732CD3E |
OriginalId | String | 43F14EB486E140B299C8679914101812 |
ParentID | String | F54574DE15514CD58572E40F8BEA6FE2 |
Fields | RuntimeFieldDataCollection | EEB1999168994F5FB9FF3B3048B4647D |
Pages | Object[][] | 81B878806BE04AF487871A477513255D |
NoOfPages | Int32 | 2B4DDB6410E44F7DA94139788CDAECB4 |
Rejected | Boolean | A6E9047F80954F12A9F17896705012C3 |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
RejectionReason | String | A852B51DCC6A47E68146B5DA8C56BD6E |
IsReadOnly | Boolean | 9DE528380F6C4B5FBDB0825A2A3BC683 |
OnlineLearningOptions | Enum | DD30500FCB0C467193110FB8631ECAB2 |
OnlineLearningComments | String | 66A8E1BB50B94C829C9016A5D34BB608 |
MimeType | String | 7D7F45CFFD4147298DDE9651686B5E34 |
ClassificationConfident | Boolean | CBF5FD7FF3364B7AB575EC7654E15CD4 |
ClassificationResults | ClassificationResultCollection | EAFC9B1E37CF4868BEAF3E7ADFDB0039 |
CreatedAt | DateTime | 561427B7EF7745C7A0EC27FB357CA52C |
LastAccessedAt | DateTime | 8748EB7C13414D08A777D5C73AA9CDA5 |
IsLocked | Boolean | A33EDBF33B844FD0803866894C6D18A1 |
LockedAt | DateTime | 243290C0A90B41A88558DAEBCBBBF421 |
LockedBy | String | 4089A99F008D4FB2A5B154D9FFD6ACD2 |
SeparationProceeded | Boolean | 0770B991FC034872B087884C21AE80E4 |
SourceFileId | String | B987564B78EB47829D91BFEDEE024BC2 |
SourceFileType | String | 80B73BDC5ED44EE79473E4672782EEA4 |
ValidateAllPerformed | Boolean | B56F93CF5E5A4D4189E17BCA487F4854 |
ReviewForcedValidReason | String | 63C1C23BB51F4D128FD743CA36084A3C |
OriginalTypeId | String | 05C0B57FE10143F7B3B38E39E8CAB567 |
OriginalTypeIdBeforeRedirection | String | 1413471B0BCF4B60960D1D7277AC18ED |
IsReclassified | Boolean | 55052E26435F466B9DC5CD92A33615F3 |
ExtensionNames | StringCollection | 62807D67F4054668BAB1B20B9EDCEF5C |
FileName | String | 1F8220766FAF42278F5CF8081DBF6D87 |
ImageProcessingBlankPagesRemovedCount | Int32 | DAD9CDF9021D4CC8BD2995151B82C41E |
ImageProcessingAllPagesDetectedBlank | Boolean | D685392D874D433AAD4B17FD19E6F786 |
VariantName | String | 8A2B611345804ACCB73EB50C51781558 |
VariantId | String | 274CA95D14694C5DB9F0C2586364A300 |
VariantVersion | Double | 496742CFDA58453A85D318306F3224BE |
The values for OnlineLearningOptions are:
Enumeration | Description |
---|---|
0 | None (no online learning) |
1 | GenericClassification (generic classification) |
2 | GenericExtraction (generic extraction) |
4 | Specific (specific online learning) |
8 | Limloc (DCX file in use for LIMLoc Unassisted Training) |
Stream GetDocumentFile | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | fileType | ||
) |
Gets the document file as a System.IO.Stream object.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document that needs to be retrieved as a Stream object. Cannot be null or empty. | ||||||||||||||||
fileType | Type of the image file e.g. "tiff", ".tiff", "png" etc. Can get file content in various formats. If the document has multiple pages, then this must be a multi-page image file type. |
Supported formats |
---|
bmp |
dicom |
gif |
jb2, jbig2 |
jpg, jpeg |
jp2, jpeg2000, jpg2000 |
pcx |
png |
tif, tiff |
wdp, wmp |
htm, html |
txt |
rtf |
eml, mht, mhtml |
msg |
doc |
docx |
docm |
xls |
xlsx |
xlsm |
csv |
xml |
xps |
ppt |
pptx |
zip |
rar |
7z |
tar |
gz, gzip |
ifm |
Stream GetDocumentRenditionsFile | ( | string | sessionId, |
string | documentId, | ||
string | renditionName, | ||
string | fileType | ||
) |
Gets the document page renditions as single Stream. if a page doesnt have a rendition then its original source image will be used
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document that needs to be retrieved as a Stream object. Cannot be null or empty |
renditionName | The name of the rendition. See Remarks section for details. |
fileType | Type of the file e.g. "tiff", ".tiff", "png" etc. Can get in various formats |
DocumentSortResult GetDocumentsInOrder | ( | string | sessionId, |
string | folderId, | ||
string | field1NameForSort, | ||
string | field2NameForSort, | ||
string | field3NameForSort, | ||
bool | ascending | ||
) |
Sorts the documents in a folder and returns them sorted on up to 3 fields in ascending or descending order. The sort priority is field1, field2, then field3.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
folderId | The instance id of the folder whose documents are to be retrieved. Cannot be null or empty |
field1NameForSort | Name of the field to sort by first. Can be null or empty |
field2NameForSort | Name of the field to sort by second. Can be null or empty |
field3NameForSort | Name of the field to sort by third. Can be null or empty |
ascending | Specifies if the documents needs to be sorted in ascending or descending order. True indicates ascending order |
Name | Type | Comment |
---|---|---|
AllFieldsFound | Boolean | Indicates if all the fields have been found or not |
SortedDocuments | Collection | A collection of DocumentSummary objects identifying the documents in the desired order |
System.Data.DataSet GetDocumentTableFieldValue | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
TableFieldIdentity | tableFieldIdentity | ||
) |
Returns the values of the specified table field as a Dataset.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document whose table field value needs to be retrieved. | ||||||||||||||||
tableFieldIdentity | A TableFieldIdentity object identifying the table field. Cannot be null
|
byte [] GetDocumentTypeImage | ( | string | sessionId, |
DocumentTypeIdentity | documentTypeIdentity | ||
) |
Gets the document type image.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentTypeIdentity | The document type identity. |
Folder GetFolder | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId | ||
) |
Retrieves the details of the specified folder.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
folderId | The folder id whose details are to be retrieved. |
BinaryData GetFolderBinaryExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
string | name | ||
) |
Gets the folder binary extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
folderId | The folder identifier. |
name | The name. |
Agility.Sdk.Model.Capture.FolderFieldValue GetFolderFieldValue | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
RuntimeFieldIdentity | fieldIdentity | ||
) |
Retrieves the value for the specified folder field, including pre-defined folder system fields such as verified, number of documents, review valid etc. See Remarks section below for folder system fields
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||
folderId | The id of the folder whose field value is to be retrieved. Cannot be null or empty | ||||||||||||||||||||
fieldIdentity | A RuntimeFieldIdentity object identifying the field whose value is to be retrieved. Cannot be null
|
Name | Type | Comment |
---|---|---|
Value | Object | The value of the field |
Name | Type | Id |
---|---|---|
TypeId | String | 9573A20A21AB4B3CB21137F139966C72 |
Type | String | 0AFBFAD4D6C74C9BBD809DFD6AB799AF |
Documents | Object[][] | 8A3DFE7947444402A4FB47BD0CA2ADD5 |
Folders | Object[][] | 977FDDF33E114A72BEADA1BA4C3A1628 |
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
Name | String | AC1929D2A30444979E0E2205BCC5F533 |
InstanceID | String | F938266C4CC640FC8C289D1FE732CD3E |
ParentID | String | F54574DE15514CD58572E40F8BEA6FE2 |
NoOfDocuments | Int32 | 4709E8D71A8C43D89E45DD8CA8A1DF77 |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
HasUnclassifiedDocument | Boolean | 36552A20B39F462796EA8696423C6941 |
HasUnconfidentlyClassifiedDocument | Boolean | C023A5C2DB3C43A5BB6114F0BC3677F4 |
NamePatternCustomText | string | 7DD998F6134D469DBA4FD7BD44ADF60D |
Agility.Sdk.Model.Capture.FolderFieldValueCollection GetFolderFieldValues | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
RuntimeFieldIdentityCollection | fieldIdentities | ||
) |
Retrieves the values of the specified folder fields, including pre-defined folder system fields such as Verified, NoOfDocuments, ReviewValid, etc. See the Remarks section for a list of the folder system fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||
folderId | The id of the folder whose field values are to be retrieved. Cannot be null or empty | ||||||||||||||||||||||||
fieldIdentities | A collection of RuntimeFieldIdentity containing the field details whose values need to be retrieved. Cannot be null RuntimeFieldIdentity members.
|
Name | Type | Comment |
---|---|---|
Value | Object | The value of the field |
Name | Type | Id |
---|---|---|
---------------------------------— | ---------— | ------------------------------— |
TypeId | String | 9573A20A21AB4B3CB21137F139966C72 |
Type | String | 0AFBFAD4D6C74C9BBD809DFD6AB799AF |
Documents | Object[][] | 8A3DFE7947444402A4FB47BD0CA2ADD5 |
Folders | Object[][] | 977FDDF33E114A72BEADA1BA4C3A1628 |
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
Name | String | AC1929D2A30444979E0E2205BCC5F533 |
InstanceID | String | F938266C4CC640FC8C289D1FE732CD3E |
ParentID | String | F54574DE15514CD58572E40F8BEA6FE2 |
NoOfDocuments | Int32 | 4709E8D71A8C43D89E45DD8CA8A1DF77 |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
HasUnclassifiedDocument | Boolean | 36552A20B39F462796EA8696423C6941 |
HasUnconfidentlyClassifiedDocument | Boolean | C023A5C2DB3C43A5BB6114F0BC3677F4 |
NamePatternCustomText | string | 7DD998F6134D469DBA4FD7BD44ADF60D |
string GetFolderTextExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
string | name | ||
) |
Gets the folder text extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
folderId | The folder identifier. |
name | The name. |
DocumentImage GetImage | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | imageId, | ||
int | desiredWidth, | ||
int | desiredHeight, | ||
string | desiredFormat | ||
) |
Retrieves the image in a particular size and format.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
imageId | The image id. Cannot be null or empty | ||||||||||||||||
desiredWidth | Desired width of the image. | ||||||||||||||||
desiredHeight | Desired height of the image. | ||||||||||||||||
desiredFormat | File type of the image. Can be null. See the remarks for the supported types. |
Name | Type | Comment |
---|---|---|
Image | byte[] | The image data |
MimeType | String | The Mime type e.g. for an image file with .tiff extension Mime type would be image/tiff |
Supported formats |
---|
bmp |
gif |
jpg, jpeg |
png |
tif, tiff |
jbig2 |
jp2, jpeg2000 |
pcx |
LockedItemCollection GetJobVariableLockStatus | ( | string | sessionId, |
ReportingData | reportingData, | ||
JobIdentity | jobIdentity | ||
) |
Gets the locked or delete status of the document/folder variables of a job. Statuses for unlocked documents/folders are ignored and therefore not returned.
sessionId | A string that uniquely identifies the session for the current logged on user. If the sessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
jobIdentity | A JobIdentity identity object that is used to identify the job for which the locked status of document/folder variables are retrieved. Cannot be nulll
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Identifies the locked item |
ItemTypeName | String | Identifies the type of the locked item |
LockedBy | String | Identifies the resource who locaked the item |
LockedAt | DateTime | Indicates when the item was locked |
Status | Enum | Indicates the status of the item |
TypeId | String | Indicates the type id |
TypeName | String | Indicates the type name |
TypeVersion | Double | Indicates the type version |
Enumeration | Description |
---|---|
1 | NotFound |
2 | Locked |
NamedEntityCollection GetNamedEntities | ( | string | sessionId, |
string | documentId | ||
) |
Gets a list of named entities which are the result of locating and classifying named entity mentions in the unstructured text into pre-defined categories such as persons, organizations, locations, etc.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document that contains named entities. Cannot be null or empty. |
BinaryData GetPageBinaryExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | pageId, | ||
string | name | ||
) |
Gets the page binary extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
documentId | The document identifier. |
pageId | The page identifier. |
name | The name. |
Stream GetPageImage | ( | string | sessionId, |
string | docId, | ||
string | pageId, | ||
int | desiredWidth, | ||
int | desiredHeight, | ||
string | desiredFormat | ||
) |
Retrieves the image in a particular size and format.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
docId | Document id. Cannot be null or empty |
pageId | The page id. Cannot be null or empty |
desiredWidth | Desired width of the image. |
desiredHeight | Desired height of the image. |
desiredFormat | File type of the image. Can be null. See the remarks for the supported types. |
Supported formats |
---|
bmp |
gif |
jpg, jpeg |
png |
tif, tiff |
jbig2 |
jp2, jpeg2000 |
pcx |
PagePropertiesCollection GetPagePropertyValues | ( | string | sessionId, |
string | documentId, | ||
PagePropertiesIdentityCollection | pagePropertyIdentityValues | ||
) |
The API Returns the Values of System properties of Pages.You have to provide the property names or System GUIDs(which are listed below) for the System Properties for the Pages.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentId | The id of the document whose page properties are to be retrieved. Cannot be null or empty | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pagePropertyIdentityValues | PagePropertiesIdentityCollection A collection of PagePropertiesIdentity PagePropertiesIdentity class contains string and FieldSystemPropertyIdentityCollection as members. FieldSystemPropertyIdentityCollection A collection of FieldSystemPropertyIdentitymembers. FieldSystemPropertyIdentity members.
|
Name | Type | Comment |
---|---|---|
Id | String | The id of the System Property of Field |
Name | String | The name of the System Property of Field; it will not be populated if the Id was only populated on the input parameter of the call |
Value | Object | The Value of the System Property of Field |
byte [] GetPageRendition | ( | string | sessionId, |
string | documentId, | ||
string | pageId, | ||
short | renditionNumber | ||
) |
Gets the page rendition specified by its number.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. |
renditionNumber | The rendition number. Must be greater than zero. |
ImageSummary GetPageRenditionImageSummary | ( | string | sessionId, |
string | documentId, | ||
string | pageId, | ||
short | renditionNumber | ||
) |
Gets the page rendition image summary.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. |
renditionNumber | The rendition number. Must be greater than zero. |
Name | Type | Comment |
---|---|---|
Height | Int32 | Height of image. |
HorizontalResolution | Float | Horizontal resolution of image. |
MimeType | String | Mime type of image. |
VerticalResolution | Float | Vertical resolution of image. |
Width | Int32 | Width of image. |
PageSummary GetPageSummary | ( | string | sessionId, |
string | documentId, | ||
string | pageId | ||
) |
Gets the page summary.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. |
Name | Type | Comment |
---|---|---|
Barcodes | BarcodeCollection | Collection of Barcode objects in the image. |
Height | Int32 | Height of image. |
HorizontalResolution | Float | Horizontal resolution of image. |
Index | Int32 | Index of page in the document. |
IsFront | Boolean | Flag indicating whether this is the front page. |
MimeType | String | Mime type of image. |
RotationType | String | Rotation type of image. |
SheetId | String | Sheet identifier. |
VerticalResolution | Float | Vertical resolution of image. |
Width | Int32 | Width of image. |
string GetPageTextExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | pageId, | ||
string | name | ||
) |
Gets the page text extension specified by its name.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty. | ||||||||||||||||
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. | ||||||||||||||||
name | The name of the text extension which needs to be retrieved. Cannot be null or empty. |
StringCollection GetPageTextExtensions | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | pageId, | ||
string[] | names | ||
) |
Gets the list of page text extensions specified by their names.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty. | ||||||||||||||||
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. | ||||||||||||||||
names | The list of the text extensions names that need to be retrieved. Cannot be null or empty. None of the names can be null or empty. |
RejectedPages GetRejectedPages | ( | string | sessionId, |
string | documentId | ||
) |
Check Document has rejected pages.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document whose rejected pages are being retrieved. |
Name | Type | Comment |
---|---|---|
HasRejectedPage | bool | Indicates if there are any rejected pages for this document |
PageIndexes | PageIndexCollection | A collection of PageIndex objects identifying the pages that are rejected. |
DocumentSourceFile GetSourceFile | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId | ||
) |
Retrieves the source file of the specified document. Note: Document source file will have valid value for example when you import PDF file in Scan activity (or in SCNJ form). At the same time when importing valid tiff images document source file will have no value.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document whose source file needs to be retrieved. Cannot be null or empty. |
Name | Type | Comment |
---|---|---|
MimeType | String | Indicates the Mime type of the file e.g. if a file with a .pdf file extension then the MimeType will be application/pdf |
SourceFile | byte[] | A byte array containing the file data |
string GetTextExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | name | ||
) |
Gets the text extension of a document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty | ||||||||||||||||
name | The key used to retrieve the text extension. Cannot be null or empty |
StringCollection GetTextExtensions | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string[] | names | ||
) |
Gets the list of text extensions of a document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty. | ||||||||||||||||
names | The list of keys used to retrieve the text extensions. Cannot be null or empty. None of the names can be null or empty. |
ValidationExecutionContext GetValidationExecutionContext | ( | string | sessionId | ) |
Returns validation execution context that allows to determine component and place within job/process where validation logic is executing.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
Name | Type | Comment |
---|---|---|
Component | Short | KTA component which executes the context |
ExtensionData | ExtensionDataObject | Extension Data. System.Runtime.Serialization.ExtensionDataObject: stores data from a versioned data contract that has been extended by adding new members. |
WordCollection GetWordsInRectangle | ( | string | sessionId, |
WordCollection | words, | ||
int | top, | ||
int | left, | ||
int | height, | ||
int | width | ||
) |
Returns a collection of words that are fully contained within the specified rectangle.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
words | The collection of words |
top | The top of rectangle |
left | The left of rectangle |
height | The height of rectangle |
width | The width of rectangle |
void InsertTableFieldRow | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | tableFieldId, | ||
int | rowIndex | ||
) |
Inserts an empty row to the table field of the supplied document at the specified position.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document whose table field needs to be updated by adding a new row. Cannot be null or empty. | ||||||||||||||||
tableFieldId | The id or name of the table field. Cannot be null or empty. | ||||||||||||||||
rowIndex | Index at which the row needs to be added. The index is zero-based, that is, the first row has index 0, the second row has index 1, and so forth. If rowIndex is negative, then a new row will be added to the end of the table (that is, it will be the last row). |
void InterpolateTableField | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | tableFieldId, | ||
int | selectedIndex | ||
) |
Populates the table with recognized OCR data on a page using the data from the row at the selected index as a template. Index is zero-based i.e. index 0 is row 1, index 1 is row 2 etc.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document whose table field needs to be interpolated. Cannot be null or empty. | ||||||||||||||||
tableFieldId | The id of the table field that needs to be interpolated. Cannot be null or empty. | ||||||||||||||||
selectedIndex | Index of the row which should be used as the main template for finding other rows. The index is zero-based i.e. the first row is index 0, the 2nd row is index 1 etc. |
Item No | Item Description | Unit Price | Quantity | Total Price |
---|---|---|---|---|
104564 | Pencil | $0.80 | 10 | $8.00 |
124583 | Paper | $2.00 | 5 | $10.00 |
462590 | Ruler | $1.00 | 10 | $10.00 |
no data | no data | no data | no data | $28.00 |
bool IsPageRenditionDefined | ( | string | sessionId, |
string | documentId, | ||
string | pageId, | ||
short | renditionNumber | ||
) |
Determines whether the specified page rendition is defined.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. |
renditionNumber | The rendition number. Must be greater than zero. |
void MergeDocuments | ( | string | sessionId, |
StringCollection | documentIds | ||
) |
Merges together documents identified by the supplied document ids where the first specified document is set as the merge-to document. All other documents will have their pages moved to the end of the first document in the order they appear in the documentIds collection.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentIds | A collection of strings identifying the documents to be merged. Cannot be null. |
void MoveDocument | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | folderId, | ||
int | insertIndex | ||
) |
Moves a document either within the parent folder or to the specified folder at the specified position.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document which needs to be moved to the specified folder. Cannot be null or empty. | ||||||||||||||||
folderId | The id of the folder to which the document needs to be moved. Cannot be null or empty. | ||||||||||||||||
insertIndex | Index location within the target folder where the document should be added. The index is zero-based so the first position is 0, the second position is 1, and so forth. |
void MoveFolder | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
string | toFolderId, | ||
int | insertIndex | ||
) |
Moves the folder either within the parent folder or to a different folder at the specified index.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
folderId | The id of the source folder that needs to be moved to the target folder. Cannot be null or empty. | ||||||||||||||||
toFolderId | The id of the target folder to which the source folder needs to be moved. Cannot be null or empty. | ||||||||||||||||
insertIndex | Index at which the folder will be moved in the target folder. The index is zero-based so the first sub-folder has index 0, the second sub-folder has index 1, and so forth. Suppose folder A needs to be moved to folder B. B has two sub-folders, C and D. The insert index is 1. The folder A will be inserted at index 1 in folder B, that is, between C and D as C has index 0, the first sub-folder. |
void MovePages | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | toDocumentId, | ||
PageIndexCollection | pageIndexes, | ||
int | insertIndex | ||
) |
Moves pages of the source document at the specified indices either within itself or to a different document at a specified insert index.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document with pages to be moved. Cannot be null or empty. | ||||||||||||||||
toDocumentId | The id of the document to which the pages will be moved. Cannot be null or empty. | ||||||||||||||||
pageIndexes | A collection of PageIndex objects containing the indices of the pages to be moved. The indices are zero-based so the first page has index 0, the second page has index 1, and so forth. Cannot be null. PageIndex members.
| ||||||||||||||||
insertIndex | Index at which the pages will be inserted in the target document. The index is zero-based so the first page has index 0, the second page has index 1, and so forth. |
void RejectDocument | ( | string | sessionId, |
string | documentId, | ||
string | reason | ||
) |
Rejects the document with the specified reason.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The identifier of the document to be rejected. Cannot be null or empty. |
reason | A string containing the reason for the rejection. |
void RejectDocuments | ( | string | sessionId, |
StringCollection | documentIds, | ||
ReportingData | reportingData, | ||
string | reason | ||
) |
Rejects the documents identified by the supplied document ids.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentIds | A collection of string objects identifying the documents to be rejected. Cannot be null | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
reason | A string containing the reason for the rejection. |
void RejectPages | ( | string | sessionId, |
string | documentId, | ||
PageIndexCollection | pageIndexes, | ||
string | reason | ||
) |
Rejects the pages with the specified reason.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
documentId | The identifier of the document containing the pages to be rejected. Cannot be null or empty. | ||||||||
pageIndexes | A collection of PageIndex objects containing the indices of the pages to be rejected. The indices are zero-based so the first page has index 0, the second page has index 1, and so forth. Cannot be null. PageIndex members.
| ||||||||
reason | A string containing the reason for the rejection. |
bool RemoveAllPageMasks | ( | string | sessionId, |
string | documentId, | ||
int | pageIndex | ||
) |
Removes all masks from the page with specified index.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageIndex | The index of the page. Cannot be negative. |
int RemovePageMasks | ( | string | sessionId, |
string | documentId, | ||
int | pageIndex, | ||
int | left, | ||
int | top, | ||
int | right, | ||
int | bottom | ||
) |
Removes all masks from the page with specified index that intersect with or are contained in the specified rectangle.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageIndex | The index of the page. Cannot be negative. |
left | X coordinate of the rectangle's top-left corner. Cannot be negative. |
top | Y coordinate of the rectangle's top-left corner. Cannot be negative. |
right | X coordinate of the rectangle's bottom-right corner. Cannot be negative. |
bottom | Y coordinate of the rectangle's bottom-right corner. Cannot be negative. |
void RotatePages | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
PageIndexCollection | pageIndexes, | ||
short | rotationAngle, | ||
bool | preserveTextData | ||
) |
Rotates page(s) source image and all its rendition images with optional preserving OCR data.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null.
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty. | ||||||||||||||||
pageIndexes | Collection of page indexes within document to rotate. Cannot be null or empty. | ||||||||||||||||
rotationAngle | Rotation angle: 0 - no rotation, 90 - image rotated left by 90 degrees, 180 - image rotated by 180 degrees, 270 - image rotated right by 90 degrees. | ||||||||||||||||
preserveTextData | True to rotate and preserve OCR data. |
void RotatePagesRendition | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
PageIndexCollection | pageIndexes, | ||
short | rotationAngle, | ||
short | renditionNumber | ||
) |
Rotates page(s) specific rendition. Source image and other renditions are not affected after rotation.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null.
| ||||||||||||||||
documentId | The id of the document. Cannot be null or empty. | ||||||||||||||||
pageIndexes | Collection of page indexes within document to rotate. Cannot be null or empty. | ||||||||||||||||
rotationAngle | Rotation angle: 0 - no rotation, 90 - image rotated left by 90 degrees, 180 - image rotated by 180 degrees, 270 - image rotated right by 90 degrees. | ||||||||||||||||
renditionNumber | The rendition number to rotate. Must be greater than zero. |
FieldValidationResult2Collection RunDocumentFieldsValidation | ( | string | sessionId, |
string | documentId, | ||
RuntimeFieldIdentityCollection | runtimeFields | ||
) |
Run validation for document using given fields and return field validation results.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | |||||||||||||||
documentId | The document identifier. | |||||||||||||||
runtimeFields | A collection of RuntimeFieldIdentity objects containing identity of the field or table/complex field cell.
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Field validation error message |
FieldId | String | Field identifier |
FieldName | String | Field name |
FormatedValue | String | Field value formatted to match field type |
IsValid | Bool | Indicates whether this field instance is valid |
TableCellValidationResults | TableCellValidationResultCollection | A collection of TableCellValidationResult objects containing validation data for table cells of a field |
FieldValidationResult2Collection RunFolderFieldsValidation | ( | string | sessionId, |
string | folderId, | ||
RuntimeFieldIdentityCollection | runtimeFields | ||
) |
Run validation for folder using given fields and return field validation results.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | |||||||||||||||
folderId | The folder identifier. | |||||||||||||||
runtimeFields | A collection of RuntimeFieldIdentity objects containing identity of the field or table/complex field cell.
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Field validation error message |
FieldId | String | Field identifier |
FieldName | String | Field name |
FormatedValue | String | Field value formatted to match field type |
IsValid | Bool | Indicates whether this field instance is valid |
TableCellValidationResults | TableCellValidationResultCollection | A collection of TableCellValidationResult objects containing validation data for table cells of a field |
void SaveBinaryExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | name, | ||
string | mimeType, | ||
byte[] | data | ||
) |
Saves the binary extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
documentId | The document identifier. |
name | The name. |
mimeType | Type of the MIME. |
data | The data. |
void SaveFolderBinaryExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
string | name, | ||
string | mimeType, | ||
byte[] | data | ||
) |
Saves the folder binary extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
folderId | The folder identifier. |
name | The name. |
mimeType | Type of the MIME. |
data | The data. |
void SaveFolderTextExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
string | name, | ||
string | text | ||
) |
Saves the folder text extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
folderId | The folder identifier. |
name | The name. |
text | The text. |
void SavePageBinaryExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | pageId, | ||
string | name, | ||
string | mimeType, | ||
byte[] | data | ||
) |
Saves the page binary extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
documentId | The document identifier. |
pageId | The page identifier. |
name | The name. |
mimeType | Type of the MIME. |
data | The data. |
PageImageData SavePageImage | ( | string | sessionId, |
string | batchId, | ||
byte[] | data, | ||
string | mimeType | ||
) |
Saves the page image to the repository.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
batchId | A string that uniquely identifies the capture batch. This value can be obtained in the context of an open batch through a form action. Cannot be null or empty. |
data | The binary image data. The following formats are supported: Bitmap (BMP), Digital Imaging and Communications in Medicine (Dicom), Graphics Interchange Format (GIF), Joint Bi-level Image Experts Group (Jbig2), Joint Photographic Experts Group (JPEG), Joint Photographic Experts Group 2000 (Jpeg2000), PaintBrush (PCX), Portable Network Graphics (PNG), Tagged Image File Format (TIFF), and Windows Media Photo (WMP). Cannot be null. |
mimeType | The Mime type of the image. Cannot be null or empty. |
void SavePageRendition | ( | string | sessionId, |
string | documentId, | ||
string | pageId, | ||
short | renditionNumber, | ||
string | mimeType, | ||
byte[] | imageStream | ||
) |
Saves the specified page rendition.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null or empty. |
pageId | The id of the page which belongs to the specified document. Cannot be null or empty. |
renditionNumber | The rendition number. Must be greater than zero. |
mimeType | The MIME type of the image stream. |
imageStream | The byte array representation of the image stream. |
void SavePageTextExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | pageId, | ||
string | name, | ||
string | text | ||
) |
Saves the page text extension.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingData | The reporting data. Not applicable. |
documentId | The document identifier. |
pageId | The page identifier. |
name | The name. |
text | The text. |
void SaveTextExtension | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | name, | ||
string | text | ||
) |
Saves the text extension of a document. Giving a text extension a specific prefix makes it available in Transformation Designer script as an XValue. To do this, prefix the name parameter with “XValue.”. For example, if you call the name “XValue.MyName”, then you can use the following code in the Transformation Designer script: pXDoc.Fields(0).Text = pXDoc.XValues.ItemByName("MyName").Value
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The document instance id of the document. | ||||||||||||||||
name | The key used to store the text extension. | ||||||||||||||||
text | The string data to store with the specified key. |
SearchResult SearchFuzzyDatabase | ( | string | sessionId, |
FuzzyDatabaseIdentity | databaseIdentity, | ||
SearchQuery | query, | ||
DocumentTypeIdentity | documentTypeIdentity | ||
) |
Searches the fuzzy database for the provided query.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
databaseIdentity | A FuzzyDatabaseIdentity object containing the fuzzy database details which needs to be searched in. Cannot be null
| ||||||||||||||||
query | A Model.Forms.Events.SearchQuery object containing the information related to the query that needs to be searched in the fuzzy database. Cannot be null
| ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity object containing details of the document type. Cannot be null
|
Name | Type | Comment |
---|---|---|
RecordItems | FuzzyRecordItemCollection | array of column names |
FieldMappingCollection | FuzzyDatabaseFieldMappingCollection | mapping of the database field name with the document type |
void SetDocumentFieldsStatus | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
FieldStatusCollection | fieldsStatus | ||
) |
Sets the multuple document fields status. Pre-defined document system fields are NOT supported.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||||||
documentId | The id of the document whose field status needs to be set. Cannot be null or empty. | ||||||||||||||||||||
fieldsStatus | A FieldStatusCollection collection of FieldStatus objects identifying the status update for each field. Cannot be null FieldStatus members.
|
Enumeration | Description |
---|---|
0 | Invalid |
1 | Valid |
2 | Force Valid |
3 | Confirmed |
4 | Verified |
5 | Unverified |
6 | ExtractionConfident |
If the field is a table field and the TableRow and/or TableColumn properties are not set, then the following applies:
void SetDocumentFieldStatus | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
RuntimeFieldIdentity | fieldIdentity, | ||
short | documentFieldStatus, | ||
string | message, | ||
object | fieldValue | ||
) |
Sets the document field status. Pre-defined document system fields are NOT supported.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||||||
documentId | The id of the document whose field status needs to be set. Cannot be null or empty. | ||||||||||||||||||||
fieldIdentity | A RuntimeFieldIdentity object identifying the field whose status needs to be set. Cannot be null.
| ||||||||||||||||||||
documentFieldStatus | The field status. See Remarks section for enumeration value. | ||||||||||||||||||||
message | The error message that will be set for the field 'Invalid' status. Can be null or empty. | ||||||||||||||||||||
fieldValue | The field value. It is required for the “ExtractionConfident” and "Confirmed" statuses. In case of "ExtractionConfident" it should be treated as a boolean value. For "Confirmed", it is used for setting the value of the field. In other cases value is ignored. |
Enumeration | Description |
---|---|
0 | Invalid |
1 | Valid |
2 | Force Valid |
3 | Confirmed |
4 | Verified |
5 | Unverified |
6 | ExtractionConfident |
If the field is a table field and the TableRow and/or TableColumn properties are not set, then the following applies:
void SetDocumentStatus | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
short | documentStatus, | ||
string | message | ||
) |
Sets the status of the specified document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document whose status needs to be set. Cannot be null or empty. | ||||||||||||||||
documentStatus | The document status.
| ||||||||||||||||
message | The error message that needs be set for the Review Invalid status. Can be null or empty. |
void SetFolderFieldStatus | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
RuntimeFieldIdentity | fieldIdentity, | ||
short | folderFieldStatus, | ||
string | message, | ||
object | fieldValue | ||
) |
Sets the folder field status. Pre-defined folder system fields are NOT supported.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||
folderId | The id of the folder whose field status will be set. Cannot be null or empty | ||||||||||||||||||||
fieldIdentity | A RuntimeFieldIdentity object identifying the field whose status needs to be set. Cannot be null
| ||||||||||||||||||||
folderFieldStatus | Field status. See Remarks section for enumeration value | ||||||||||||||||||||
message | The error message that will be set for field Invalid status. Can be null | ||||||||||||||||||||
fieldValue | The field value. This is required only for status of Confirmed |
Enumeration | Description |
---|---|
0 | Invalid |
1 | Valid |
2 | Force Valid |
3 | Confirmed |
4 | Verified |
5 | Unverified |
void SetFolderStatus | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
short | folderStatus, | ||
string | message | ||
) |
Sets the folder status.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
folderId | The id of the folder whose status needs to be set. Cannot be null or empty | ||||||||||||||||
folderStatus | The folder status.
| ||||||||||||||||
message | The error message that will be set for invalid/override status. Can be null otherwise |
void SetPageSourceImageFromRendition | ( | string | sessionId, |
string | documentId, | ||
string | pageId, | ||
short | renditionNumber | ||
) |
Sets the page source image from the rendition with the specified number.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The document identifier. Cannot be null or empty. |
pageId | The identifier of the page which belongs to the specified document. Cannot be null or empty. |
renditionNumber | The rendition number. Must be greater than zero. |
string SplitDocument | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
int | pageIndex | ||
) |
Splits a document into two by creating a new document and moving the pages starting from the specified index to the new document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||
documentId | The id of the document which needs to be split. Cannot be null or empty. | ||||||||||||||||
pageIndex | The page index at which the document needs to be split. The index is zero-based and must be greater than zero in value; this means that the document cannot be split at the first page. |
DocumentIdentityCollection SplitDocumentAndClassify | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
SplitDocumentInfoCollection | splitDocumentInfoCollection | ||
) |
Splits a document into one or more documents using each index set in SplitDocumentInfo by creating new documents and moving the pages starting from each specified index to the new documents. Each of the newly created documents can also have properties set as specified in their respective SplitDocumentInfo data.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API.
| ||||||||||||||||||||||||
documentId | The id of the document which needs to be split. | ||||||||||||||||||||||||
splitDocumentInfoCollection | A collection of SplitDocumentInfo objects, which contain information about how to split the document. Cannot be null.
|
string SplitFolder | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
int | index | ||
) |
Splits a folder into two by creating a new folder and moving the documents starting from the specified index to the new folder.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
folderId | The id of the folder to be split into two. An exception will be raised if the folderId is null, empty, or not a valid GUID value. An exception will also be raised if the folder cannot be found. | ||||||||||||||||
index | Zero-based (index 0 is the first document) index to split from. An exception will be raised if the index is negative. |
FormattingResult TestFieldFormatter | ( | string | sessionId, |
string | value, | ||
FieldFormatter | fieldFormatter | ||
) |
Please note that this function is deprecated. Please use TestFieldFormatter2 instead.
Tests the field formatter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
value | The value which needs to be tested against the formatter. Cannot be null | ||||||||
fieldFormatter | A FieldFormatter object identifying the formatter. Cannot be null
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
FormattedText | String | The formatted text |
FormattingResult TestFieldFormatter2 | ( | string | sessionId, |
string | value, | ||
FieldFormatter | fieldFormatter, | ||
BusinessRuleInputCollection | ruleInputs | ||
) |
Tests the field formatter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
value | The value which needs to be tested against the formatter. Cannot be null | ||||||||
fieldFormatter | A FieldFormatter object identifying the formatter. Cannot be null
| ||||||||
ruleInputs | Collection of variables required for business rule execution. |
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
FormattedText | String | The formatted text |
Agility.Sdk.Model.Capture.Validation.ValidationResult TestFieldValidator | ( | string | sessionId, |
string | value, | ||
Validator | validator | ||
) |
Tests a validator on a document field's value.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
value | The value that needs to be validated against the field validator. Cannot be null | ||||||||
validator | A Validator object containing the validator details. Cannot be null
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
void UnrejectDocuments | ( | string | sessionId, |
StringCollection | documentIds, | ||
ReportingData | reportingData | ||
) |
Unrejects the documents specified by the supplied document identifiers and clears the rejection reasons.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentIds | A collection of string objects identifying the documents to be unrejected. Cannot be null. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
|
void UnrejectPages | ( | string | sessionId, |
string | documentId, | ||
PageIndexCollection | pageIndexes | ||
) |
Unrejects the pages.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The document identifier. |
pageIndexes | The page indexes. |
void UpdateDocumentFieldPropertyValues | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
FieldPropertiesCollection | fieldProperties | ||
) |
The API sets the Values of System properties of Document fields.You have to provide the System GUIDs(which are listed below) for the System Properties for the Fields.This API cannot be used in a TotalAgility process or form as TotalAgility does not support its class structure.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentId | The id of the document whose field value is to be retrieved. Cannot be null or empty | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldProperties | A Collection of type FieldProperties containing the details of the fields which needs to be updated. FieldProperties class contains RuntimeFieldIdentity and FieldSystemPropertyCollection as members. RuntimeFieldIdentity members.
The value for Confidence must be between 0 and 1 (e.g. 0.88) as a percentage. |
void UpdateDocumentFieldValue | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
RuntimeField | runtimeField | ||
) |
Updates the value of the specified document field, including pre-defined document system fields such as verified, rejected, number of pages, etc. See Remarks section below for document system fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||
documentId | The id of the document whose field value needs to be updated. | ||||||||||||||||||||||||
runtimeField | A RuntimeField object identifying the field value to be updated. Cannot be null
|
Name | Type | Id |
---|---|---|
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
OriginalId | String | 43F14EB486E140B299C8679914101812 |
Rejected | Boolean | A6E9047F80954F12A9F17896705012C3 |
RejectionReason | String | A852B51DCC6A47E68146B5DA8C56BD6E |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
OnlineLearningOptions | Enum | DD30500FCB0C467193110FB8631ECAB2 |
OnlineLearningComments | String | 66A8E1BB50B94C829C9016A5D34BB608 |
FileName | String | 1F8220766FAF42278F5CF8081DBF6D87 |
ImageProcessingBlankPagesRemovedCount | Int32 | DAD9CDF9021D4CC8BD2995151B82C41E |
ImageProcessingAllPagesDetectedBlank | Boolean | D685392D874D433AAD4B17FD19E6F786 |
Enumeration | Description |
---|---|
0 | None (no online learning) |
1 | GenericClassification (generic classification) |
2 | GenericExtraction (generic extraction) |
4 | Specific (specific online learning) |
8 | Limloc (DCX file in use for LIMLoc Unassisted Training) |
void UpdateDocumentFieldValues | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
RuntimeFieldCollection | runtimeFields | ||
) |
Updates the values of the specified document fields, including pre-defined document system fields such as verified, rejected, number of pages, etc. See Remarks section below for document system fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||
documentId | The id of the document whose field values need to be updated. | ||||||||||||||||||||||||
runtimeFields | A collection of type RuntimeField indicating the field values to be updated. Cannot be null RuntimeField members.
|
Name | Type | Id |
---|---|---|
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
OriginalId | String | 43F14EB486E140B299C8679914101812 |
Rejected | Boolean | A6E9047F80954F12A9F17896705012C3 |
RejectionReason | String | A852B51DCC6A47E68146B5DA8C56BD6E |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
OnlineLearningOptions | Enum | DD30500FCB0C467193110FB8631ECAB2 |
OnlineLearningComments | String | 66A8E1BB50B94C829C9016A5D34BB608 |
FileName | String | 1F8220766FAF42278F5CF8081DBF6D87 |
ImageProcessingBlankPagesRemovedCount | Int32 | DAD9CDF9021D4CC8BD2995151B82C41E |
ImageProcessingAllPagesDetectedBlank | Boolean | D685392D874D433AAD4B17FD19E6F786 |
Enumeration | Description |
---|---|
0 | None (no online learning) |
1 | GenericClassification (generic classification) |
2 | GenericExtraction (generic extraction) |
4 | Specific (specific online learning) |
8 | Limloc (DCX file in use for LIMLoc Unassisted Training) |
void UpdateDocumentsProcessingCompleted | ( | string | sessionId, |
StringCollection | documentIds | ||
) |
Report that processing of the specified documents have completed.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentIds | The document ids. |
void UpdateDocumentType | ( | string | sessionId, |
string | documentId, | ||
DocumentTypeIdentity | documentTypeIdentity | ||
) |
Updates the type of the document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentId | The id of the document. Cannot be null | ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity object identifying the document type. Cannot be null
|
void UpdateDocumentType2 | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
DocumentTypeIdentity | documentTypeIdentity | ||
) |
Updates the type of the document.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null.
| ||||||||||||||||
documentId | The id of the document. Cannot be null | ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity object identifying the document type. Cannot be null
|
void UpdateDocumentTypeWithConfidence | ( | string | sessionId, |
string | documentId, | ||
DocumentTypeIdentity | documentTypeIdentity, | ||
double | confidenceLevel | ||
) |
Please note that this function is deprecated. Please use UpdateDocumentTypeWithConfidence2 instead.
Updates the document with the specified document type and confidence for that document type.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null. |
documentTypeIdentity | The document type identity, must not be null. The id of the document type identity must not be null as well. |
confidenceLevel | The confidence level. A value between 0 and 1, inclusive. |
void UpdateDocumentTypeWithConfidence2 | ( | string | sessionId, |
string | documentId, | ||
DocumentTypeIdentity | documentTypeIdentity, | ||
double | confidenceLevel, | ||
bool | classificationConfident | ||
) |
Updates the document with the specified document type, the confidence for that document type, and whether the classfication is confident or not.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document. Cannot be null. |
documentTypeIdentity | The document type identity, must not be null. The id of the document type identity must not be null as well. |
confidenceLevel | The confidence level. A value between 0 and 1, inclusive. |
classificationConfident | If set to true , then the classification is confident. |
void UpdateDocumentTypeWithConfidence3 | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
DocumentTypeIdentity | documentTypeIdentity, | ||
double | confidenceLevel, | ||
bool | classificationConfident | ||
) |
Updates the document with the specified document type, the confidence for that document type, and whether the classfication is confident or not.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
reportingData | A ReportingData object containing the reporting data. Can be null.
| ||||||||
documentId | The id of the document. Cannot be null. | ||||||||
documentTypeIdentity | The document type identity, must not be null. The id of the document type identity must not be null as well. | ||||||||
confidenceLevel | The confidence level. A value between 0 and 1, inclusive. | ||||||||
classificationConfident | If set to true , then the classification is confident. |
void UpdateDocumentVariant | ( | string | sessionId, |
string | documentId, | ||
string | variantName | ||
) |
Updates the document variant for the document with the specified id.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The document identifier. Cannot be null or empty. |
variantName | Name of the document variant. Cannot be null or empty. |
void UpdateFolderFieldValue | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
RuntimeField | runtimeField | ||
) |
Updates the value of the specified folder field.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||
folderId | The id of the folder whose field value needs to be updated. Cannot be null or empty | ||||||||||||||||||||||||
runtimeField | A RuntimeField object identifying the field whose value needs to be updated. Cannot be null
|
Name | Type | Id |
---|---|---|
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
NamePatternCustomText | string | 7DD998F6134D469DBA4FD7BD44ADF60D |
void UpdateFolderFieldValues | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | folderId, | ||
RuntimeFieldCollection | runtimeFields | ||
) |
Updates the values of the specified folder fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||
folderId | The id of the folder whose field values need to be updated. Cannot be null or empty | ||||||||||||||||||||||||
runtimeFields | A collection of type RuntimeField identifying the fields whose values need to be updated. Cannot be null RuntimeField members.
|
Name | Type | Id |
---|---|---|
Valid | Boolean | 5B83535412F142669762C8C08CFE690F |
Verified | Boolean | 037EE38EF08F48B485DD62F0214E5C34 |
ErrorDescription | String | D0D4F7EB416C4E91BD8A10FC805D5390 |
ReviewValid | Boolean | D735014F88744E3899D6AB8EAA84634A |
ReviewForcedValid | Boolean | D03C74648AA54281B6DC8891BA8BAB13 |
NamePatternCustomText | string | 7DD998F6134D469DBA4FD7BD44ADF60D |
void UpdatePages | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | docId, | ||
PageData2Collection | pageData2Collection | ||
) |
Updates the pages of a specified document with the supplied page properties.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
docId | The id of the document whose pages need to be updated. Cannot be null or empty | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pageData2Collection | A collection of type PageData2 identifying the the pages and the properties that need to be updated. Cannot be null. PageData2 members.
|
void UpdateSourceFile | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
DocumentSourceFile | sourceFile | ||
) |
Updates the source file.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The document identifier. | ||||||||||||||||
sourceFile | The source file is a DocumentSourceFile object containing the file and its Mime type.
|
void UpdateWords | ( | string | sessionId, |
ReportingData | reportingData, | ||
string | documentId, | ||
string | pageId, | ||
WordUpdateCollection | wordUpdates | ||
) |
This API method updates the Text property of each of the specified words in the textlines of the specified page.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
reportingData | A ReportingData object containing the reporting data. Can be null. NOT used by this API
| ||||||||||||||||
documentId | The id of the document whose page properties are to be retrieved. Cannot be null or empty | ||||||||||||||||
pageId | The id of the page whose properties are to be retrieved. Cannot be null or empty | ||||||||||||||||
wordUpdates | WordUpdateCollection A collection of WordUpdate WordUpdate members.
|
FieldValidationResult2Collection ValidateAllDocumentFields | ( | string | sessionId, |
DocumentTypeIdentity | documentTypeIdentity, | ||
RuntimeField2Collection | documentFields, | ||
DocumentSystemProperties | documentSystemProperties | ||
) |
Validates document fields against the field validators and formatters.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity identity object identifying the document type. Cannot be null.
| ||||||||||||||||
documentFields | The list of one or more document fields, including their values, table cells, and field properties. The properties are optional as default values will be used if these are not specified. If a field exists in the documentFields parameter but is not a member of the document type, it is simply ignored. Cannot be null. | ||||||||||||||||
documentSystemProperties | The document system properties, which are needed for multi-field rules. This is optional, as default values will be used if this parameter is not specified. |
bool ValidateDocument | ( | string | sessionId, |
string | documentId | ||
) |
Validates a document by validating all its document fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document that is to have its fields validated. Cannot be null or empty |
ValidationResult ValidateDocumentField | ( | string | sessionId, |
string | documentTypeId, | ||
RuntimeFieldValue | field | ||
) |
Validates the specified document field against the field validators and formatters.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
documentTypeId | The id of the document type to which the field belongs. Cannot be null or empty | ||||||||||||
field | A RuntimeFieldValue object identifying the field that needs to be validated. Cannot be null
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates whether the value passed validation or not |
FormattedValue | String | The formatted value, if valid |
ValidationResultCollection ValidateDocumentFields | ( | string | sessionId, |
string | documentTypeId, | ||
RuntimeFieldValueCollection | fields | ||
) |
Validates the specified document fields against the fields validators and formatters.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
documentTypeId | The id of the the document type that the fields belong to. Cannot be null or empty | ||||||||||||
fields | A RuntimeFieldValueCollection collection of RuntimeFieldValue objects identifying fields to be validated. Cannot be null RuntimeFieldValue members.
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
ReviewValidationResult ValidateDocumentForReview | ( | string | sessionId, |
string | documentId | ||
) |
Validates the specified document against the document's validation rules.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
documentId | The id of the document that is to be validated. Cannot be null or empty |
Name | Type | Comment |
---|---|---|
ReviewValid | Boolean | Indicates whether the document is reviewed as valid or not |
ErrorDescription | String | Contains a description of any document review error |
ReviewValidationResult ValidateDocumentForReviewWithType | ( | string | sessionId, |
string | documentId, | ||
DocumentTypeIdentity | documentTypeIdentity | ||
) |
Validates the specified document against the document's validation rules using the supplied document type.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentId | The id of the document that needs to be validated. Cannot be null or empty | ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity identity object identifying the document type. Cannot be null
|
Name | Type | Comment |
---|---|---|
ReviewValid | Boolean | Indicates if reviewed as valid or not |
ErrorDescription | String | Contains a description of any error |
bool ValidateDocumentWithType | ( | string | sessionId, |
string | documentId, | ||
DocumentTypeIdentity | documentTypeIdentity | ||
) |
Please note that this function is deprecated. Please use ValidateDocument instead.
Validates a document by validating all its document fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
documentId | The id of the document that needs it's fields validated. Cannot be null or empty | ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity object containing the document type information. Can NOT be null. NOT used by this API
|
bool ValidateFolder | ( | string | sessionId, |
string | folderId | ||
) |
Validates a folder by validating all its fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
folderId | The id of the folder whose fields need to be validated. Cannot be null or empty |
ValidationResult ValidateFolderField | ( | string | sessionId, |
string | folderTypeId, | ||
RuntimeFieldValue | field | ||
) |
Validates the specified folder field against the field validators and formatters.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
folderTypeId | The id of the folder type that the field belongs to. Cannot be null or empty | ||||||||||||
field | A RuntimeFieldValue object identifying the field that needs to be validated. Cannot be null
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
ValidationResultCollection ValidateFolderFields | ( | string | sessionId, |
string | folderTypeId, | ||
RuntimeFieldValueCollection | fields | ||
) |
Validates the specified folder fields against the fields validators and formatters.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
folderTypeId | The id of the folder type that the fields belong to. Cannot be null or empty | ||||||||||||
fields | A RuntimeFieldValueCollection collection of RuntimeFieldValue objects identifying fields to be validated. Cannot be null RuntimeFieldValue members.
|
Name | Type | Comment |
---|---|---|
ErrorMessage | String | Describes the error if vaildation fails |
IsValid | Boolean | Indicates if value passed validation or not |
FormattedValue | String | The formatted value if valid |
ReviewValidationResult ValidateFolderForReview | ( | string | sessionId, |
string | folderId | ||
) |
Validates the specified folder against the folder's validation rules.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
folderId | The id of the folder that needs to be validated. Cannot be null or empty |
Name | Type | Comment |
---|---|---|
ReviewValid | Boolean | Indicates if reviewed as valid or not |
ErrorDescription | String | Contains a description of any error |
ReviewValidationResult ValidateFolderForReviewWithType | ( | string | sessionId, |
string | folderId, | ||
FolderTypeIdentity | folderTypeIdentity | ||
) |
Validates the specified folder against the folder validation rules using the specified folder type.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
folderId | The id of the folder that needs to be validated. Cannot be null or empty | ||||||||||||||||
folderTypeIdentity | A FolderTypeIdentity identity object identifying the folder type. Cannot be null
|
Name | Type | Comment |
---|---|---|
ReviewValid | Boolean | Indicates if reviewed as valid or not |
ErrorDescription | String | Contains a description of any error |
bool ValidateFolderWithType | ( | string | sessionId, |
string | folderId, | ||
FolderTypeIdentity | folderTypeIdentity | ||
) |
Please note that this function is deprecated. Please use ValidateFolder instead.
Validates a folder by validating all its fields.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
folderId | The id of the folder to be validated. Cannot be null or empty | ||||||||||||||||
folderTypeIdentity | A FolderTypeIdentity object containing the folder type details. Can NOT be null. NOT used by this API
|