query-orchestration/queryapi.summary.md

Query API Endpoints Summary

Client Service

• POST /client - Create a new client with provided details
• GET /client/{id} - Get a specific client by its ID
• PATCH /client/{id} - Update an existing client with new details
• GET /client/{id}/status - Retrieve the sync status for a client

Collector Service

• GET /client/{id}/collector - Get a collector configuration by client ID
• PATCH /client/{id}/collector - Set or update collector configuration for a client

Documents Service

• GET /client/{id}/document - List all documents for a specific client
• POST /client/{id}/document - Upload a single PDF file for a client
• POST /client/{id}/document/batch - Upload multiple PDFs as ZIP archive for batch processing
• GET /client/{id}/document/batch - List batch uploads for a client with pagination
• GET /client/{id}/document/batch/{batch_id} - Get detailed status of a specific batch upload
• DELETE /client/{id}/document/batch/{batch_id} - Cancel a batch upload currently processing
• GET /document/{id} - Get document details by its ID

Query Service

• GET /query - List queries based on filter criteria
• POST /query - Create a new query with provided details
• GET /query/{id} - Get a specific query by its ID
• PATCH /query/{id} - Update an existing query with new details
• POST /query/{id}/test - Execute a test run of a query with parameters

Export Service

• POST /client/{id}/export - Trigger an export process for a client
• GET /export/{id} - Check the current state of an export

Auth Service

• GET /login - Initiate login flow by redirecting to Cognito IDP
• GET /login-callback - Handle OAuth2 callback and exchange code for tokens
• GET /logout - Logout user and invalidate session
• GET /home - Get the home page menu for authenticated users