API

Security implementation is based on the final version of OAuth 2.0 authorization framework , with a grant type of client_credentials . Every DocFusion API request requires an access_token as part of the authentication header. POST https...

GET /api/DocBatch/GetBatch Required User-Role : BatchViewer Gets a specified batch with its associated batch type, status and meta data. Request GET /api/DocBatch/GetBatch?tenantGuid={tenantGuid}&batchGuid={batchGuid} content...

GET /api/DocBatch/CreateBatch Required User-Role : BatchCreator Creates a batch container into which batch records (documents for processing) can be added. Request GET /api/DocBatch/CreateBatch?tenantGuid={tenantGui...

PUT /api/DocBatch/ApproveBatch Required User-Role: BatchCreator Approving a batch marks it ready for processing. This step is redundant when the Batch Type associated to the batch was configured to process records without approval...

PUT /api/DocBatch/MarkBatchUploadComplete Required User-Role: BatchCreator Sets the batch to the completed state. Once marked complete the batch no longer accepts batch records. The batch is then queued for processing and its sta...

GET /api/DocBatch/GetAllBatchTypes Required User-Role : Administrator Returns all Batch Types in a batch tenant. Request GET /api/DocBatch/GetAllBatchTypes?tenantGuid={tenantGuid} content-type: application/json authorization: B...

GET /api/DocBatch/GetBatchTypeByGuid Required User-Role : Administrator Returns a Batch Type within a batch tenant using its unique Guid. Request GET /api/DocBatch/GetBatchTypeByGuid?tenantGuid={tenantGuid}&batchTypeGuid={batch...

POST /api/DocBatch/InsertBatchType Required User-Role : Administrator Inserts a new Batch Type with the specified configuration. Functionally, Batch Types define conformance settings for batch records, how each will be validated agai...

POST /api/DocBatch/UpdateBatchType Required User-Role : Administrator Updates an existing Batch Type in a batch tenant. Request POST /api/DocBatch/UpdateBatchType?tenantGuid={tenantGuid} content-type: application/json authoriza...

DELETE /api/DocBatch/DeleteBatchType Required User-Role : Administrator Deletes an existing Batch Type from a specified batch tenant. Request DELETE /api/DocBatch/DeleteBatchType?tenantGuid={tenantGuid}&batchTypeGuid={batchT...

GET /api/DocBatch/GetBatchRecord Required User-Role : BatchViewer Returns the specified batch record and its payload. Request GET /api/DocBatch/GetBatchRecord?tenantGuid={tenantGuid}&batchGuid={batchGuid}&batchRecordId={batchReco...

POST /api/DocBatch/CreateBatchRecord Required User-Role : BatchCreator Creates a single batch record containing the payload of a document for processing. V alidation of the payload is started immediately by enabling the immedia...

POST /api/DocBatch/CreateBatchRecords Required User-Role: BatchCreator Create multiple batch records from a collection of files and a dictionary of metadata, referenced by filename. Each batch record within the collection conta...

POST /api/DocBatch/UpdateBatchRecordData Required User-Role : BatchCreator Updates a specified batch record's data and immediately begins validation. Request POST /api/DocBatch/UpdateBatchRecordData?tenantGuid={tenantGuid}...

PUT /api/DocBatch/MarkBatchRecordReadyForValidation Required User-Role: BatchCreator Sets the batch record as ready to be validated according to the Batch Type definition for the batch. Validation of batch records is performed asy...

PUT /api/DocBatch/RetryProcessBatchRecord Required User-Role: BatchCreator Retries the processing of a batch record after the data was updated using /api/DocBatch/UpdateBatchRecordData . The method can also be executed on batch...

POST /api/DocBatch/SearchBatchRecords Required User-Role : BatchViewer Searches for batch records within a batch and returns a subset by a specified criteria. You can also specify the size of the result set, e.g. 100 records. Req...

GET /api/DocBatch/GetBatchRecordDocument Required User-Role : BatchViewer Returns the payload of the document for the specified batch record as a stream. Request GET /api/DocBatch/GetBatchRecordDocument?tenantGuid={tenantGuid}&ba...

PUT /api/DocBatch/SetBatchRecordAsRetrieved Required User-Role: BatchCreator Marks the specified batch record's payload as retrieved. Useful for tracking purposes. Request PUT /api/DocBatch/SetBatchRecordAsRetrieved?t...

GET /api/DocBatch/GetBatchRecordLog Required User-Role : BatchViewer Gets the logs associated to a batch record as a stream. Request GET /api/DocBatch/GetBatchRecordLog?tenantGuid={tenantGuid}&batchGuid={batchGuid}&batchRecordId=...