All REST Endpoints

Sort by

Task Path Method

Group by API

Attachments

Management of Document Attachments in Capture

Create an Attachment

Method: post

Path: /capture/api/v1.1/documents/{docId}/attachments

Delete an Attachment

Method: delete

Path: /capture/api/v1.1/documents/{docId}/attachments/{attId}

Get an Attachment

Method: get

Path: /capture/api/v1.1/documents/{docId}/attachments/{attId}

Get the Attachment Content

Method: get

Path: /capture/api/v1.1/documents/{docId}/attachments/{attId}/content

List all Document Attachments

Method: get

Path: /capture/api/v1.1/documents/{docId}/attachments

Update an Attachment

Method: put

Path: /capture/api/v1.1/documents/{docId}/attachments/{attId}

Auditing

Query and Analize Batch and Document Processing

Get a Batch Audit Detail

Method: get

Path: /capture/api/v1.1/audit/batches/{batchId}

Get a Document Audit Detail

Method: get

Path: /capture/api/v1.1/audit/documents/{docId}

List all Batch Audit Details

Method: get

Path: /capture/api/v1.1/audit/batches

List all Document Audit Details

Method: get

Path: /capture/api/v1.1/audit/documents

Batches

Management of Batches in Capture

Get a Batch

Method: get

Path: /capture/api/v1.1/batches/{batchId}

Get the history of a Batch

Method: get

Path: /capture/api/v1.1/batches/{batchId}/history

List all Batches

Method: get

Path: /capture/api/v1.1/batches

Documents

Management of Documents in Capture

Delete a Document

Method: delete

Path: /capture/api/v1.1/documents/{docId}

Get a Document

Method: get

Path: /capture/api/v1.1/documents/{docId}

Get the Document Content

Method: get

Path: /capture/api/v1.1/documents/{docId}/content

List all Documents

Method: get

Path: /capture/api/v1.1/documents

Update a Document

Method: put

Path: /capture/api/v1.1/documents/{docId}

Steps

Query and Update Processing Task Queues

Complete Document Processing in a Task Queue

Method: put

Path: /capture/api/v1.1/steps/{stepId}/tasks/documents/complete

Get Documents from a Processing Task Queue

Method: get

Path: /capture/api/v1.1/steps/{stepId}/tasks/documents

System

System Level Operations

System and API Information

Method: get

Path: /capture/api/v1.1/systemInfo