Using the Document Management APIs

You can invoke the set of Document Management APIs from an RPA Studio application that uses the Document Management APIs.

After data is extracted from a document and business logic is applied, the document is pushed to the RPA Review Center.

A document is categorized as an extraction exception when the extracted data is incomplete. Such documents are not processed further and are routed to the relevant category for the use case. When the end user reviews the document in the Review Center and submits it for reprocessing, the completed document is retrieved in the RPA Process Flow and processed to completion.

A new document in the Review Center is created with the POST/api/v1/rpa/exception/usecasetypes/{id}/documents API. The request payload contains all the information retrieved from the document by the flow as shown below.

The “idm_document_ID” field is a unique attribute of the document created in the IDM, under a specific IDM Document Type.

For example, you can create an RPADocumentProcessing type dedicated to the Review Center, with a unique attribute such as ID. This attribute is included in the request payload and used by RPA to load the document preview.

Property	Description
Reprocess	Re-submitting or re-running a document through the processing workflow. When a document is submitted on Review Center, the flag is automatically changed to TRUE.
Visibility	Access or display scope of a document or document entity, determining who can see or interact with the document within the system .
Document_name	Name or identifier assigned to a document within the system. This name is used to identify, retrieve, and manage documents through API calls
Category_key	The identifier of the category assigned to a document. This key is used to classify documents and determine how the documents are processed, displayed, or routed in workflows
IDM_document_id	The unique identifier assigned to a document within the Internal Document Management (IDM) system. This ID is used to track, retrieve, and manage the document programmatically .
Document_entities	The structured set of data fields, tables, or components that define the information captured, displayed, or processed for a document. Key : The unique internal identifier for a specific data field or element within a document entity. Value: The actual data stored or captured for a specific field defined in a document entity.
Table_data	The actual row-by-row data stored in a table-type document entity Name: The identifier of the table entity to which the row data belongs. Rows: The individual data records within a table structure extracted from a document. Each row contains a set of field values that correspond to the column definitions of the table, enabling the Review Center to display and process tabular content accurately. Key : The unique identifier assigned to a table within the extracted document data. The key distinguishes one table from another and is used by the Review Center to reference, retrieve, and process the correct table during review operations. Value : The complete extracted table content associated with the table’s key. The key contains the table name, rows, and the corresponding cell values, enabling the Review Center to display and process the table data during review.
Document_users	The list of users associated with a specific document in the RPA Review Center. These users include creators, reviewers, or approvers who are authorized to view, review, or act on the document. The document management APIs use this field to identify and manage user access, assignments, and permissions for that document within the Review Center workflow.

When reprocessing, all documents available for reprocessing can be retrieved with the GET /api/v1/rpa/exception/usecasetypes/{id}/documents API by setting the value of the reprocess parameter to TRUE.

The response contains the document after review. Document entities from this response can then be used to complete processing as required by the business use case.

To retrieve a specific document, use the GET /api/v1/rpa/exception/documents/{docId} API. To update an existing document, use the PUT method in the API. To update specific fields in a document, use the PATCH method in the API.