API endpoints and usage

The Review Center APIs are grouped into Use Case Management, Document Management, and Template Management. These APIs enable you to configure use cases, manage documents, and retrieve templates for Review Center operations.

  • Use Case Management APIs:
    • GET /api/v1/rpa/exception/usecasetypes – Lists available use case types
    • POST /api/v1/rpa/exception/usecasetypes – Creates a new RPA use case type configuration
    • GET /api/v1/rpa/exception/usecasetypes/{usecasetypeid} – Retrieves details for a specific use case type using the usecasetypeid API
    • PUT /api/v1/rpa/exception/usecasetypes/{usecasetypeid} – Updates an existing use case type
    • DELETE /api/v1/rpa/exception/usecasetypes - Deletes one or multiple usecases. Usecases with locked documents are not deleted. Only RPA-ADMIN users can delete usecases.
  • Document Management APIs:
    • GET /api/v1/rpa/exception/usecasetypes/{id}/documents – Lists documents for a given use case type
    • POST /api/v1/rpa/exception/usecasetypes/{id}/documents – Adds new documents with header entities and line items
    • GET /api/v1/rpa/exception/documents/{docId} – Retrieves full details for a document by ID
    • PUT /api/v1/rpa/exception/documents/{docId} – Updates document details and content
    • PATCH /api/v1/rpa/exception/documents/{docId} – Updates specific fields in a document
    • DELETE /api/v1/rpa/exception/documents/{docId} - Deletes a single document if not locked. Only RPA-ADMIN users can delete documents.
    • DELETE /api/v1/rpa/exception/documents - Deletes multiple documents. Locked documents are not deleted. Only RPA-ADMIN users can delete documents
  • Template Management APIs:
    • GET /api/v1/rpa/exception/{casetype}/template - Retrieves the request template for a specific case type. Casetype can be document or usecase.
  • Use Case Translation APIs:
    • GET /api/v1/rpa/exception/usecasetypes/{usecasetypeid}/translations – Get the list of the translations for the selected use case type
    • POST /api/v1/rpa/exception/usecasetypes/{usecasetypeid}/translations – Creates a new translation for a usecase type
    • DELETE /api/v1/rpa/exception/usecasetypes/{usecasetypeid}/translations – Deletes translations for a Usecase type
    • PUT /api/v1/rpa/exception/usecasetypes/{usecasetypeid}/ translations – Update an existing translation for a usecase type