{"openapi":"3.1.0","info":{"title":"Code Manager AI API","description":"\n## WorkFINITY® Solution Configuration Management System — Code Manager AI API\n\nA high-performance enterprise REST API for managing hierarchical reference data, catalog structures, multi-modal AI ingestion, and automated data quality scans over `dbo.CodeManager`.\n\n---\n\n### 🔑 Authentication\nMost endpoints in this microservice require internal service authentication.\nClick the green **Authorize 🔓** button in Swagger UI and provide your internal service secret:\n- **Header:** `X-Internal-Auth`\n- **Value:** `<INTERNAL_SERVICE_SECRET>` (e.g., `wf_internal_...`)\n\nPublic diagnostic endpoints (`/health` and `/db-ping`) do not require authentication.\n\n---\n\n### 🧱 Hierarchy & Data Model\n- **`TYPES` (Root Container)**: A special root container type named `TYPES` anchors all top-level category definitions (e.g. `COUNTRY`, `ROLE`, `BOOK`, `CATEGORY`).\n- **Types & Subtypes**: Hierarchical classifications linked via `ParentCodeManagerId`.\n- **Codes & Subcodes**: Concrete lookup records (e.g. `ADMIN`, `US`, `IN-KA`) mapped under their respective parent type or code.\n- **Deep Cascading Traversal**: Supports unlimited parent-child nesting with ancestor breadcrumbs and leaf node aggregation.\n\n---\n\n### 🤖 Multi-Modal AI & NLPS\n- **Natural Language Parsing**: Add, update, delete, and query codes using natural language prompts (`/nl-add`, `/nl-update`, `/nl-delete`, `/nl-query`, `/api/ai/unified`).\n- **Multi-modal Ingestion**: Extract structured codes and tables directly from images via OCR (`/add-from-image`), PDFs (`/add-from-pdf`), and Word documents (`/add-from-doc`).\n\n---\n\n### 📦 Bulk Transfer & Data Quality\n- **High-Throughput Transfer**: Export and import supporting **JSON**, **CSV**, **Excel**, **Word (DOCX)**, and **PDF** formats with full `dryRun` pre-validation.\n- **Data Quality Scans**: Automated detection of duplicate keys, orphan parent linkages, cycle loops, and code overlaps.\n- **Audit Logging**: Request latency tracking, error logging, and OpenAI token consumption records.\n","termsOfService":"https://workfinity.net/terms","contact":{"name":"WorkFINITY Support","url":"https://workfinity.net/","email":"support@workfinity.net"},"license":{"name":"Proprietary","url":"https://workfinity.net/"},"version":"1.9-debug"},"servers":[{"url":"/","description":"Current Server (Auto-detected)"},{"url":"http://localhost:8000","description":"Local Development (Port 8000)"},{"url":"http://localhost:5000","description":"Local Development (Port 5000)"},{"url":"https://codemanager-ai-portal.workfinity.com","description":"Production Portal"}],"paths":{"/db-ping":{"get":{"tags":["Health"],"summary":"Database connectivity ping test","description":"Executes a lightweight `SELECT 1` query against the configured database to verify SQL Server connectivity and driver operation.","operationId":"db_ping_db_ping_get","responses":{"200":{"description":"Database connection healthy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbPingResponse"}}}},"500":{"description":"Database connection failed or unreachable"}}}},"/codemanager-sample":{"get":{"tags":["Health"],"summary":"Sample records from CodeManager table","description":"Retrieves the first N sample records from `dbo.CodeManager` or legacy table to preview table schema and active rows.","operationId":"codemanager_sample_codemanager_sample_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of sample rows to retrieve (default: 5)","default":5,"title":"Limit"},"description":"Maximum number of sample rows to retrieve (default: 5)"}],"responses":{"200":{"description":"Sample records list and total retrieved count","content":{"application/json":{"schema":{}}}},"500":{"description":"Failed to read sample rows from table"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/health":{"get":{"tags":["Health"],"summary":"Service health and readiness check","description":"Returns service status, whether AI system prompts are loaded, OpenAI API key status, and current application version.","operationId":"health_health_get","responses":{"200":{"description":"Service is healthy and ready to accept requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}},"/admin/reload-prompt":{"post":{"tags":["Health"],"summary":"Reload AI system prompt template","description":"Forces a dynamic reload of the AI system prompt template from disk or environment variables without restarting the application process.","operationId":"reload_prompt_admin_reload_prompt_post","responses":{"200":{"description":"System prompt template successfully reloaded","content":{"application/json":{"schema":{}}}},"500":{"description":"Failed to reload system prompt template"}}}},"/add-from-prompt":{"post":{"tags":["Code Manager AI"],"summary":"AI extract & persist from prompt","description":"Processes natural language instructions (or raw JSON payload) via LLM to extract CodeManager types/codes and optionally persist them directly into dbo.CodeManager. Accepts payload via JSON body or query parameter.","operationId":"add_from_prompt_add_from_prompt_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"prompt","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Natural language instruction (e.g. 'Add city name Bengaluru under state Karnataka') or JSON payload (fallback if body omitted)","title":"Prompt"},"description":"Natural language instruction (e.g. 'Add city name Bengaluru under state Karnataka') or JSON payload (fallback if body omitted)"},{"name":"save_to_db","in":"query","required":false,"schema":{"type":"boolean","description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)","default":true,"title":"Save To Db"},"description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PromptRequest"},{"type":"null"}],"description":"Optional JSON request body containing prompt string","title":"Body"}}}},"responses":{"200":{"description":"List of extracted (and optionally persisted) CodeManager items","content":{"application/json":{"schema":{}}}},"400":{"description":"Invalid input or empty prompt"},"500":{"description":"AI extraction or persistence failure"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/add-from-image":{"post":{"tags":["Code Manager AI"],"summary":"AI extract & persist from image (OCR)","description":"Uploads an image file (PNG, JPG, etc.) containing lists, forms, or tables of reference codes. Performs AI OCR text extraction and maps records into dbo.CodeManager.","operationId":"add_from_image_add_from_image_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"save_to_db","in":"query","required":false,"schema":{"type":"boolean","description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)","default":true,"title":"Save To Db"},"description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_add_from_image_add_from_image_post"}}}},"responses":{"200":{"description":"List of extracted items from image OCR, with optional persistence status","content":{"application/json":{"schema":{}}}},"400":{"description":"Empty image upload"},"422":{"description":"No legible text detected in image"},"500":{"description":"OCR processing or database error"}}}},"/add-from-pdf":{"post":{"tags":["Code Manager AI"],"summary":"AI extract & persist from PDF","description":"Uploads a PDF document to parse text content and tables, converting discovered reference codes into structured items with optional database persistence.","operationId":"add_from_pdf_add_from_pdf_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"save_to_db","in":"query","required":false,"schema":{"type":"boolean","description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)","default":true,"title":"Save To Db"},"description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_add_from_pdf_add_from_pdf_post"}}}},"responses":{"200":{"description":"List of extracted items from PDF document, with optional persistence status","content":{"application/json":{"schema":{}}}},"400":{"description":"Empty PDF document upload"},"500":{"description":"PDF parsing or AI processing error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/add-from-doc":{"post":{"tags":["Code Manager AI"],"summary":"AI extract & persist from Word document","description":"Uploads a Microsoft Word document (.docx or .doc) to extract structured reference data via AI with optional database persistence.","operationId":"add_from_doc_add_from_doc_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"save_to_db","in":"query","required":false,"schema":{"type":"boolean","description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)","default":true,"title":"Save To Db"},"description":"If true, directly inserts the extracted items into dbo.CodeManager (default: true)"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_add_from_doc_add_from_doc_post"}}}},"responses":{"200":{"description":"List of extracted items from Word document, with optional persistence status","content":{"application/json":{"schema":{}}}},"400":{"description":"Empty DOC/DOCX document upload"},"500":{"description":"Document parsing or AI processing error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/nl-add":{"post":{"tags":["NL-DB"],"summary":"Natural language ADD (tbl_codemanager)","description":"Processes a natural language creation prompt (e.g. 'Add state California under country US' or 'Create role MANAGER') using OpenAI LLM parsing into structured rows. Supports `dry_run=true` to preview the parsed action and target rows without writing to database.","operationId":"nl_add_nl_add_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NLText"}}},"required":true},"responses":{"200":{"description":"Parsed action result with created or previewed records","content":{"application/json":{"schema":{}}}},"400":{"description":"Invalid prompt or non-create operation"},"500":{"description":"Parsing or database execution error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/nl-update":{"post":{"tags":["NL-DB"],"summary":"Natural language UPDATE (tbl_codemanager)","description":"Processes a natural language update instruction (e.g. 'Update role ADMIN set description to System Administrator') into field updates and target WHERE clauses. Supports `dry_run=true` to preview mutations without writing to database.","operationId":"nl_update_nl_update_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NLText"}}},"required":true},"responses":{"200":{"description":"Update operation summary and modified row count","content":{"application/json":{"schema":{}}}},"400":{"description":"Invalid prompt or non-update operation"},"500":{"description":"Parsing or database execution error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/nl-delete":{"post":{"tags":["NL-DB"],"summary":"Natural language DELETE (tbl_codemanager)","description":"Processes a natural language deletion prompt (e.g. 'Delete city Springfield under state IL confirm'). Requires explicit confirmation syntax for destructive actions. Supports `dry_run=true` to preview records to be deleted.","operationId":"nl_delete_nl_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NLText"}}},"required":true},"responses":{"200":{"description":"Delete operation summary and removed row count","content":{"application/json":{"schema":{}}}},"400":{"description":"Missing confirmation or non-delete operation"},"500":{"description":"Parsing or database execution error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/nl-query":{"post":{"tags":["NL-DB"],"summary":"Natural language QUERY (tbl_codemanager)","description":"Translates free-form natural language search prompts (e.g. 'Show all states in India' or 'Find active roles') into structured database filters and returns matched records with an AI summary.","operationId":"nl_query_nl_query_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"compat","in":"query","required":false,"schema":{"type":"boolean","description":"(ignored) legacy wrapper is always returned","default":true,"title":"Compat"},"description":"(ignored) legacy wrapper is always returned"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NLText"}}}},"responses":{"200":{"description":"Query result rows matching the natural language criteria","content":{"application/json":{"schema":{}}}},"500":{"description":"Query parsing or execution failure"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/ingest":{"post":{"tags":["NL-DB"],"summary":"Multi-format document and data ingestion","description":"Single unified ingestion endpoint that accepts images, PDFs, Microsoft Word (.docx), PowerPoint (.pptx), CSV, and JSON files. Automatically extracts text, uses AI to structure into reference items, and optionally persists into dbo.CodeManager.","operationId":"ingest_anything_ingest_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","description":"Validate / preview only (no DB writes)","default":true,"title":"Dry Run"},"description":"Validate / preview only (no DB writes)"},{"name":"auto_parse_text","in":"query","required":false,"schema":{"type":"boolean","description":"(ignored for image/pdf/docx/pptx now — always create JSON via system prompt if not already JSON)","default":true,"title":"Auto Parse Text"},"description":"(ignored for image/pdf/docx/pptx now — always create JSON via system prompt if not already JSON)"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_ingest_anything_ingest_post"}}}},"responses":{"200":{"description":"Ingested items list with extraction status and preview data","content":{"application/json":{"schema":{}}}},"400":{"description":"Empty upload or unsupported file format"},"500":{"description":"Document parsing or LLM extraction error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/types/paged":{"get":{"tags":["Types"],"summary":"List types (paginated)","description":"Retrieve paginated list of code types and root categories from dbo.CodeManager.","operationId":"api_types_list_paged_api_types_paged_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number (default: 1)","default":1,"title":"Page"},"description":"Page number (default: 1)"},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Page size (default: 10, max: 200)","default":10,"title":"Pagesize"},"description":"Page size (default: 10, max: 200)"},{"name":"codeType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by CodeType (e.g. ROLE, COUNTRY, CATEGORY)","title":"Codetype"},"description":"Filter by CodeType (e.g. ROLE, COUNTRY, CATEGORY)"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Code key","title":"Code"},"description":"Filter by Code key"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by Name contains (case-insensitive)","title":"Name"},"description":"Search by Name contains (case-insensitive)"},{"name":"parentCodeManagerId","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Parent Code or GUID","title":"Parentcodemanagerid"},"description":"Filter by Parent Code or GUID"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"Paginated list of code types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerPagedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/types":{"get":{"tags":["Types"],"summary":"List all types","description":"Retrieve all code types and categories from dbo.CodeManager.","operationId":"api_types_list_api_types_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"codeType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by CodeType (e.g. ROLE, COUNTRY, CATEGORY)","title":"Codetype"},"description":"Filter by CodeType (e.g. ROLE, COUNTRY, CATEGORY)"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Code key","title":"Code"},"description":"Filter by Code key"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by Name contains (case-insensitive)","title":"Name"},"description":"Search by Name contains (case-insensitive)"},{"name":"parentCodeManagerId","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Parent Code or GUID","title":"Parentcodemanagerid"},"description":"Filter by Parent Code or GUID"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"List of code types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CodeManagerResponse"},"title":"Response Api Types List Api Types Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Types"],"summary":"Create a new type","description":"Create a new code type/group entry in dbo.CodeManager. Requires Name and CodeType (defaults to CODE_GROUP if omitted).","operationId":"api_types_create_api_types_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerCreateRequest","description":"Requires 'CodeType' (or 'type') and 'Name'. 'Code' is auto-assigned if omitted."}}}},"responses":{"201":{"description":"Created code type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"400":{"description":"Validation error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/types/all":{"get":{"tags":["Types"],"summary":"Get all types (flat)","description":"Retrieve all raw code type rows from dbo.CodeManager without pagination.","operationId":"api_types_all_flat_api_types_all_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"Flat list of all types and total count","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/types/{typeKey}":{"get":{"tags":["Types"],"summary":"Get type by key or Id","description":"Retrieve a single code type by its Code key or GUID Id.","operationId":"api_types_get_api_types__typeKey__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"typeKey","in":"path","required":true,"schema":{"type":"string","description":"Code key (e.g. ROLE, LOAN_PURPOSE) or GUID Id","title":"Typekey"},"description":"Code key (e.g. ROLE, LOAN_PURPOSE) or GUID Id"}],"responses":{"200":{"description":"Code type details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"404":{"description":"Type not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Types"],"summary":"Update a type","description":"Update an existing code type by its Code key or GUID Id.","operationId":"api_types_update_api_types__typeKey__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"typeKey","in":"path","required":true,"schema":{"type":"string","description":"Code key or GUID Id to update","title":"Typekey"},"description":"Code key or GUID Id to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerUpdateRequest","description":"Fields to update: Name, Description, OrderNumber, IsActive, UpdatedNotes, etc."}}}},"responses":{"200":{"description":"Updated code type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"400":{"description":"Missing fields or validation error"},"404":{"description":"Type not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Types"],"summary":"Delete a type","description":"Delete a code type by its Code key or GUID Id (rejects if child items exist).","operationId":"api_types_delete_api_types__typeKey__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"typeKey","in":"path","required":true,"schema":{"type":"string","description":"Code key or GUID Id to delete","title":"Typekey"},"description":"Code key or GUID Id to delete"}],"responses":{"200":{"description":"Type deleted successfully","content":{"application/json":{"schema":{}}}},"400":{"description":"Cannot delete type with child items"},"404":{"description":"Type not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/codes/paged":{"get":{"tags":["Codes","Codes"],"summary":"List codes (paginated)","description":"Retrieve a paginated list of code items from dbo.CodeManager with optional filtering by CodeType, Code, Name, or Parent.","operationId":"api_codes_list_paged_api_codes_paged_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number (default: 1)","default":1,"title":"Page"},"description":"Page number (default: 1)"},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Page size (default: 10, max: 200)","default":10,"title":"Pagesize"},"description":"Page size (default: 10, max: 200)"},{"name":"codeType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by CodeType (e.g. ROLE, LOAN_PURPOSE, STATE, CITY)","title":"Codetype"},"description":"Filter by CodeType (e.g. ROLE, LOAN_PURPOSE, STATE, CITY)"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Code key (e.g. ADMIN, MANAGER, IN-KA)","title":"Code"},"description":"Filter by Code key (e.g. ADMIN, MANAGER, IN-KA)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by Name contains (case-insensitive)","title":"Name"},"description":"Search by Name contains (case-insensitive)"},{"name":"parentCodeManagerId","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Parent Code or GUID Id","title":"Parentcodemanagerid"},"description":"Filter by Parent Code or GUID Id"},{"name":"sortBy","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by: OrderNumber | Name | Code | CreatedAtUtc","default":"OrderNumber","title":"Sortby"},"description":"Field to sort by: OrderNumber | Name | Code | CreatedAtUtc"},{"name":"sortDir","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort direction: 'asc' or 'desc'","default":"asc","title":"Sortdir"},"description":"Sort direction: 'asc' or 'desc'"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"Paginated list of code items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerPagedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/codes":{"get":{"tags":["Codes","Codes"],"summary":"List codes","description":"Search and list code items from dbo.CodeManager filtered by CodeType, Code, Name, or Parent.","operationId":"api_codes_list_api_codes_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"codeType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by CodeType (e.g. ROLE, LOAN_PURPOSE, STATE, CITY)","title":"Codetype"},"description":"Filter by CodeType (e.g. ROLE, LOAN_PURPOSE, STATE, CITY)"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Code key (e.g. ADMIN, MANAGER, IN-KA)","title":"Code"},"description":"Filter by Code key (e.g. ADMIN, MANAGER, IN-KA)"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by Name contains (case-insensitive)","title":"Name"},"description":"Search by Name contains (case-insensitive)"},{"name":"parentCodeManagerId","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by Parent Code or GUID Id","title":"Parentcodemanagerid"},"description":"Filter by Parent Code or GUID Id"},{"name":"sortBy","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by: OrderNumber | Name | Code | CreatedAtUtc","default":"OrderNumber","title":"Sortby"},"description":"Field to sort by: OrderNumber | Name | Code | CreatedAtUtc"},{"name":"sortDir","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort direction: 'asc' or 'desc'","default":"asc","title":"Sortdir"},"description":"Sort direction: 'asc' or 'desc'"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"List of matching code items","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CodeManagerResponse"},"title":"Response Api Codes List Api Codes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Codes","Codes"],"summary":"Create a new code","description":"Create a new code item under a CodeType in dbo.CodeManager.","operationId":"api_codes_create_api_codes_post","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerCreateRequest","description":"Requires 'CodeType' (or 'type') and 'Name'. 'Code' is auto-assigned if omitted."}}}},"responses":{"201":{"description":"Created code item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"400":{"description":"Validation error"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/codes/stats":{"get":{"tags":["Codes","Codes"],"summary":"Get CodeManager summary statistics","description":"Retrieve high-level dashboard metrics: total records, active/inactive counts, distinct types count, root count, and item breakdown per CodeType.","operationId":"api_codes_stats_api_codes_stats_get","responses":{"200":{"description":"Statistics overview","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerStatsResponse"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/codes/export":{"get":{"tags":["Codes","Codes"],"summary":"Export codes (JSON or CSV)","description":"Export code items as a downloadable CSV spreadsheet or formatted JSON file.","operationId":"api_codes_export_api_codes_export_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"codeType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional CodeType to filter exported items","title":"Codetype"},"description":"Optional CodeType to filter exported items"},{"name":"format","in":"query","required":false,"schema":{"type":"string","description":"Export format: 'json' or 'csv'","default":"json","title":"Format"},"description":"Export format: 'json' or 'csv'"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/codes/types":{"get":{"tags":["Codes","Codes"],"summary":"List distinct CodeTypes","description":"Retrieve all distinct category types (CodeTypes) currently defined in dbo.CodeManager (e.g. ROLE, LOAN_PURPOSE, STATE, CITY).","operationId":"api_codes_types_api_codes_types_get","responses":{"200":{"description":"Distinct CodeTypes list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerTypesListResponse"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/codes/bulk":{"post":{"tags":["Codes","Codes"],"summary":"Bulk create codes","description":"Create multiple code items in a single request within dbo.CodeManager.","operationId":"api_codes_bulk_create_api_codes_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerBulkCreateRequest","description":"Array of code items to create"}}},"required":true},"responses":{"201":{"description":"Created code items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerBulkResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/codes/{code}/children":{"get":{"tags":["Codes","Codes"],"summary":"List child codes","description":"Retrieve all direct child codes under a parent code key (e.g. 'IN') or GUID Id.","operationId":"api_codes_children_api_codes__code__children_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Parent Code key (e.g. IN) or GUID Id","title":"Code"},"description":"Parent Code key (e.g. IN) or GUID Id"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"List of direct child codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CodeManagerResponse"},"title":"Response Api Codes Children Api Codes  Code  Children Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/codes/{type}/{code}":{"get":{"tags":["Codes","Codes"],"summary":"Get specific code","description":"Retrieve a single code item by its CodeType and Code (or GUID Id).","operationId":"api_codes_get_api_codes__type___code__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","description":"Category / CodeType (e.g. ROLE, LOAN_PURPOSE)","title":"Type"},"description":"Category / CodeType (e.g. ROLE, LOAN_PURPOSE)"},{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code key (e.g. ADMIN) or GUID Id","title":"Code"},"description":"Code key (e.g. ADMIN) or GUID Id"}],"responses":{"200":{"description":"Code details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"404":{"description":"Code not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Codes","Codes"],"summary":"Update a code by type and code","description":"Update a code item by its CodeType and Code (or GUID Id).","operationId":"api_codes_update_api_codes__type___code__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Category / CodeType (e.g. ROLE, LOAN_PURPOSE)","title":"Type"},"description":"Category / CodeType (e.g. ROLE, LOAN_PURPOSE)"},{"name":"code","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Code key (e.g. ADMIN) or GUID Id","title":"Code"},"description":"Code key (e.g. ADMIN) or GUID Id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerUpdateRequest","description":"Fields to update: Name, Description, OrderNumber, IsActive, UpdatedNotes, etc."}}}},"responses":{"200":{"description":"Updated code item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"400":{"description":"Validation error or no fields to update"},"404":{"description":"Code not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Codes","Codes"],"summary":"Delete a code by type and code","description":"Deactivate or permanently delete a code item by its CodeType and Code (rejects if child items exist).","operationId":"api_codes_delete_api_codes__type___code__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","description":"Category / CodeType (e.g. ROLE)","title":"Type"},"description":"Category / CodeType (e.g. ROLE)"},{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code key or GUID Id","title":"Code"},"description":"Code key or GUID Id"},{"name":"hardDelete","in":"query","required":false,"schema":{"type":"boolean","description":"Set to true for permanent physical deletion. Defaults to false (soft-delete / deactivate).","default":false,"title":"Harddelete"},"description":"Set to true for permanent physical deletion. Defaults to false (soft-delete / deactivate)."}],"responses":{"200":{"description":"Code deleted successfully","content":{"application/json":{"schema":{}}}},"400":{"description":"Cannot delete code with child items"},"404":{"description":"Code not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/codes/{code}":{"put":{"tags":["Codes","Codes"],"summary":"Update a code by Code or Id","description":"Update a code item directly by its Code key or GUID Id.","operationId":"api_codes_update_single_api_codes__code__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Code key or UUID Id","title":"Code"},"description":"Code key or UUID Id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerUpdateRequest","description":"Fields to update: Name, Description, OrderNumber, IsActive, UpdatedNotes, etc."}}}},"responses":{"200":{"description":"Updated code item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"400":{"description":"Validation error or no fields to update"},"404":{"description":"Code not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Codes","Codes"],"summary":"Delete a code by Code or Id","description":"Deactivate or permanently delete a code item directly by its Code key or GUID Id (rejects if child items exist).","operationId":"api_codes_delete_single_api_codes__code__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code key or GUID Id to delete","title":"Code"},"description":"Code key or GUID Id to delete"},{"name":"hardDelete","in":"query","required":false,"schema":{"type":"boolean","description":"Set to true for permanent physical deletion. Defaults to false (soft-delete / deactivate).","default":false,"title":"Harddelete"},"description":"Set to true for permanent physical deletion. Defaults to false (soft-delete / deactivate)."}],"responses":{"200":{"description":"Code deleted successfully","content":{"application/json":{"schema":{}}}},"400":{"description":"Cannot delete code with child items"},"404":{"description":"Code not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/codes/{code}/restore":{"post":{"tags":["Codes","Codes"],"summary":"Restore / reactivate a code","description":"Reactivate an inactive / soft-deleted code item by setting IsActive = 1.","operationId":"api_codes_restore_api_codes__code__restore_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code key or GUID Id to restore","title":"Code"},"description":"Code key or GUID Id to restore"}],"responses":{"200":{"description":"Restored code item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeManagerResponse"}}}},"404":{"description":"Code not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/hierarchy/tree":{"get":{"tags":["Hierarchy"],"summary":"Get hierarchy trees","description":"Retrieve full nested hierarchy trees from dbo.CodeManager (e.g. Country -> State -> City, Category -> Subcategory -> Subcategory Type, Role groupings). Filter by rootCodeType (e.g. 'COUNTRY', 'CATEGORY'), rootCode (e.g. 'IN', 'LENDING'), or maxDepth.","operationId":"api_hierarchy_trees_api_hierarchy_tree_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"rootCodeType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter trees by root CodeType (e.g. COUNTRY, CATEGORY, CODE_GROUP)","title":"Rootcodetype"},"description":"Filter trees by root CodeType (e.g. COUNTRY, CATEGORY, CODE_GROUP)"},{"name":"rootCode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start tree from a specific root code (e.g. IN, US, LENDING)","title":"Rootcode"},"description":"Start tree from a specific root code (e.g. IN, US, LENDING)"},{"name":"maxDepth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":20,"minimum":1},{"type":"null"}],"description":"Maximum tree depth levels to traverse","title":"Maxdepth"},"description":"Maximum tree depth levels to traverse"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"List of nested hierarchy trees","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyTreeNodeResponse"},"title":"Response 200 Api Hierarchy Trees Api Hierarchy Tree Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/hierarchy/tree/{code}":{"get":{"tags":["Hierarchy"],"summary":"Get hierarchy tree under a specific code","description":"Retrieve the nested hierarchy sub-tree rooted at the specified node key or GUID Id (e.g. 'IN', 'LENDING', 'US').","operationId":"api_hierarchy_node_tree_api_hierarchy_tree__code__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Root Code key (e.g. IN, LENDING) or GUID Id","title":"Code"},"description":"Root Code key (e.g. IN, LENDING) or GUID Id"},{"name":"maxDepth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":20,"minimum":1},{"type":"null"}],"description":"Maximum tree depth levels to traverse","title":"Maxdepth"},"description":"Maximum tree depth levels to traverse"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"Nested hierarchy sub-tree","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HierarchyTreeNodeResponse"}}}},"404":{"description":"Node not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/hierarchy/path/{code}":{"get":{"tags":["Hierarchy"],"summary":"Get ancestor breadcrumb path for a code","description":"Retrieve the upward breadcrumb path from the top-level root down to the target node (e.g. 'IN-MH-MUM' -> 'India > Maharashtra > Mumbai').","operationId":"api_hierarchy_ancestor_path_api_hierarchy_path__code__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code key (e.g. IN-MH-MUM, UNSECURED, IN-KA) or GUID Id","title":"Code"},"description":"Code key (e.g. IN-MH-MUM, UNSECURED, IN-KA) or GUID Id"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"Ancestor breadcrumb path","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HierarchyPathResponse"}}}},"404":{"description":"Node not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/hierarchy/nodes":{"get":{"tags":["Hierarchy"],"summary":"Get flattened hierarchy nodes","description":"Retrieve all nodes annotated with flattened hierarchy metadata (level, isLeaf, rootCode, displayPath, codePath). Ideal for cascading dropdowns and data tables.","operationId":"api_hierarchy_flat_nodes_api_hierarchy_nodes_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"codeType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by CodeType (e.g. STATE, CITY, SUB_CATEGORY)","title":"Codetype"},"description":"Filter by CodeType (e.g. STATE, CITY, SUB_CATEGORY)"},{"name":"rootCode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter nodes under a specific root ancestor (e.g. IN, US, LENDING)","title":"Rootcode"},"description":"Filter nodes under a specific root ancestor (e.g. IN, US, LENDING)"},{"name":"level","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Filter by depth level (0=root, 1=level 1, etc.)","title":"Level"},"description":"Filter by depth level (0=root, 1=level 1, etc.)"},{"name":"isLeaf","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter leaf nodes (nodes with no children)","title":"Isleaf"},"description":"Filter leaf nodes (nodes with no children)"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"List of flattened hierarchy nodes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyNodeFlatResponse"},"title":"Response 200 Api Hierarchy Flat Nodes Api Hierarchy Nodes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/hierarchy/chains":{"get":{"tags":["Hierarchy"],"summary":"Get distinct hierarchy chains","description":"Retrieve all detected parent-to-child CodeType chains across the database (e.g. 'COUNTRY -> STATE -> CITY', 'CATEGORY -> SUB_CATEGORY -> SUB_CATEGORY_TYPE').","operationId":"api_hierarchy_chains_api_hierarchy_chains_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include inactive/deleted records","default":false,"title":"Includedeleted"},"description":"Include inactive/deleted records"}],"responses":{"200":{"description":"List of distinct hierarchy chains","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyChainResponse"},"title":"Response 200 Api Hierarchy Chains Api Hierarchy Chains Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/ai/query":{"post":{"tags":["AI/NLPS"],"summary":"Unified AI NLPS operations endpoint","description":"Single comprehensive Natural Language Processing Service endpoint that automatically identifies the intent (create, update, delete, or query), extracts structured parameters, and executes the operation over dbo.CodeManager.","operationId":"ai_unified_api_ai_query_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"compat","in":"query","required":false,"schema":{"type":"boolean","description":"(ignored) legacy wrapper is always returned","default":true,"title":"Compat"},"description":"(ignored) legacy wrapper is always returned"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NLText"}}}},"responses":{"200":{"description":"Unified operation payload with entity details and execution metrics","content":{"application/json":{"schema":{}}}},"400":{"description":"Unable to determine intent or invalid instruction"},"422":{"description":"Unsafe bulk operation without confirmation keyword"},"500":{"description":"AI execution or database error"}}}},"/api/catalog/filter":{"get":{"tags":["Catalog"],"summary":"Unified search filter across Types and Codes","description":"Performs a cross-cutting search across both category types and lookup codes in dbo.CodeManager. Supports filtering by name substring, type key, parentType, and parentCode.","operationId":"api_catalog_filter_api_catalog_filter_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive substring match on name","title":"Name"},"description":"Case-insensitive substring match on name"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Type key: filters Codes by type; also exact-match Types by key","title":"Type"},"description":"Type key: filters Codes by type; also exact-match Types by key"},{"name":"parentType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional parentType for Codes (or 'TYPES' for Types)","title":"Parenttype"},"description":"Optional parentType for Codes (or 'TYPES' for Types)"},{"name":"parentCode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional parentCode for Codes (or TYPES parent code for Types)","title":"Parentcode"},"description":"Optional parentCode for Codes (or TYPES parent code for Types)"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include soft-deleted rows","default":false,"title":"Includedeleted"},"description":"Include soft-deleted rows"}],"responses":{"200":{"description":"List of matching types and codes with normalized entity classifications","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/catalog/filter/paged":{"get":{"tags":["Catalog"],"summary":"Unified filter across Types and Codes (paginated)","description":"Paginated search across both category types and lookup codes in dbo.CodeManager. Supports configurable page index (`page`), page size (`pageSize`), field sorting (`sortBy`), and direction (`sortDir`).","operationId":"api_catalog_filter_paged_api_catalog_filter_paged_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive substring search on Name","title":"Name"},"description":"Case-insensitive substring search on Name"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by CodeType key","title":"Type"},"description":"Filter by CodeType key"},{"name":"parentType","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional parentType filter","title":"Parenttype"},"description":"Optional parentType filter"},{"name":"parentCode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional parentCode filter","title":"Parentcode"},"description":"Optional parentCode filter"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include soft-deleted records","default":false,"title":"Includedeleted"},"description":"Include soft-deleted records"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page index (1-based)","default":1,"title":"Page"},"description":"Page index (1-based)"},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Items per page (max: 200)","default":10,"title":"Pagesize"},"description":"Items per page (max: 200)"},{"name":"sortBy","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort key: 'name', 'entityType', or 'seq'","default":"name","title":"Sortby"},"description":"Sort key: 'name', 'entityType', or 'seq'"},{"name":"sortDir","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort direction: 'asc' or 'desc'","default":"asc","title":"Sortdir"},"description":"Sort direction: 'asc' or 'desc'"}],"responses":{"200":{"description":"Paginated list of matching items with total count and page metrics","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/catalog/types/{typeName}/children":{"get":{"tags":["Catalog"],"summary":"List nested child types under a parent type","description":"Retrieves child type definitions nested under the specified parent type name (e.g., retrieving sub-categories under CATEGORY or administrative levels under COUNTRY).","operationId":"api_catalog_types_in_type_api_catalog_types__typeName__children_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"typeName","in":"path","required":true,"schema":{"type":"string","description":"Parent type display name, business key, or numeric code","title":"Typename"},"description":"Parent type display name, business key, or numeric code"},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include soft-deleted rows","default":false,"title":"Includedeleted"},"description":"Include soft-deleted rows"}],"responses":{"200":{"description":"List of child type records","content":{"application/json":{"schema":{}}}},"404":{"description":"Parent type not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/search":{"get":{"tags":["Utilities"],"summary":"Simple substring search across types and codes","description":"Searches across dbo.CodeManager records for types and codes matching the substring query in key, code, name, or description.","operationId":"api_search_api_search_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","description":"Free-text to find in key/name/description","default":"","title":"Q"},"description":"Free-text to find in key/name/description"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max items to return (default: 20)","default":20,"title":"Limit"},"description":"Max items to return (default: 20)"}],"responses":{"200":{"description":"List of matching types and codes search results","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/resolve":{"get":{"tags":["Utilities"],"summary":"Resolve a TYPE or CODE to a client-side route","description":"Resolves a TYPE or CODE identifier, key, or GUID into a client-side route path (e.g. '/types#BOOK' or '/codes#BOOK:BOOK1').","operationId":"api_resolve_api_resolve_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Type key (e.g., CUSTOMER, BOOK)","title":"Type"},"description":"Type key (e.g., CUSTOMER, BOOK)"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional code within the type (e.g. BOOK1)","title":"Code"},"description":"Optional code within the type (e.g. BOOK1)"},{"name":"target","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Free-form code or type name to resolve","title":"Target"},"description":"Free-form code or type name to resolve"},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Direct GUID Id in dbo.CodeManager","title":"Id"},"description":"Direct GUID Id in dbo.CodeManager"}],"responses":{"200":{"description":"Resolved path and entity details","content":{"application/json":{"schema":{}}}},"400":{"description":"Missing search parameters"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/settings":{"get":{"tags":["Utilities"],"summary":"Frontend settings and feature flags","description":"Retrieves application metadata, current environment, and enabled AI/OCR feature flags.","operationId":"api_settings_api_settings_get","responses":{"200":{"description":"Application settings and feature flags payload","content":{"application/json":{"schema":{}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/transfer/export":{"get":{"tags":["Transfer"],"summary":"Export Types and Codes","description":"Exports reference data from dbo.CodeManager into multiple formats:\n- **Formats**: `json` (nested payload), `csv` (flattened tabular), `zip` (multi-file archive), `pdf` (formatted document), `docx` (Word document).\n- **Dataset Scopes**: `all` (both Types and Codes), `types` (Types only), `codes` (Codes only).","operationId":"transfer_export_handler_api_transfer_export_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"dataset","in":"query","required":false,"schema":{"type":"string","pattern":"^(all|types|codes)$","description":"Scope of dataset to export ('all', 'types', or 'codes')","default":"all","title":"Dataset"},"description":"Scope of dataset to export ('all', 'types', or 'codes')"},{"name":"format","in":"query","required":false,"schema":{"type":"string","pattern":"^(json|csv|zip|pdf|docx)$","description":"Output serialization format ('json', 'csv', 'zip', 'pdf', 'docx')","default":"json","title":"Format"},"description":"Output serialization format ('json', 'csv', 'zip', 'pdf', 'docx')"}],"responses":{"200":{"description":"Exported file stream or JSON structure","content":{"application/json":{"schema":{}}}},"400":{"description":"Invalid format or dataset filter"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/transfer/import":{"post":{"tags":["Transfer"],"summary":"Import Types and Codes from file","description":"Imports reference data into dbo.CodeManager from an uploaded file:\n- **Supported Formats**: JSON, CSV, ZIP, Microsoft Word (.docx), and text-based PDF.\n- **Modes**:\n  - `upsert`: Insert new records, update existing records.\n  - `insert`: Insert new records only, skip duplicates.\n  - `replace`: Overwrite conflicting items completely.\n- **Dry Run**: When `dryRun=true` (default), parses and validates data without modifying database.","operationId":"transfer_import_handler_api_transfer_import_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"mode","in":"query","required":false,"schema":{"type":"string","pattern":"^(upsert|insert|replace)$","description":"Import conflict resolution mode: 'upsert', 'insert', or 'replace'","default":"upsert","title":"Mode"},"description":"Import conflict resolution mode: 'upsert', 'insert', or 'replace'"},{"name":"dryRun","in":"query","required":false,"schema":{"type":"boolean","description":"When true, validates file and reports changes without writing to database","default":true,"title":"Dryrun"},"description":"When true, validates file and reports changes without writing to database"},{"name":"dataset","in":"query","required":false,"schema":{"type":"string","pattern":"^(auto|all|types|codes)$","description":"Target dataset scope: 'auto', 'all', 'types', or 'codes'","default":"auto","title":"Dataset"},"description":"Target dataset scope: 'auto', 'all', 'types', or 'codes'"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_transfer_import_handler_api_transfer_import_post"}}}},"responses":{"200":{"description":"Import result statistics and status summary","content":{"application/json":{"schema":{}}}},"400":{"description":"Invalid file format or parsing error"},"500":{"description":"Import execution failure"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/import":{"post":{"tags":["Transfer"],"summary":"Import Types and Codes (Compatibility route)","description":"Compatibility import endpoint matching legacy `/api/import`.\nSupports importing reference datasets from **JSON**, **CSV**, **ZIP**, **Word (DOCX)**, and **PDF**.\nSupports `upsert`, `insert`, and `replace` modes with comprehensive `dryRun` validation.","operationId":"import_compat_handler_api_import_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"mode","in":"query","required":false,"schema":{"type":"string","pattern":"^(upsert|insert|replace)$","description":"Import conflict resolution mode: 'upsert', 'insert', or 'replace'","default":"upsert","title":"Mode"},"description":"Import conflict resolution mode: 'upsert', 'insert', or 'replace'"},{"name":"dryRun","in":"query","required":false,"schema":{"type":"boolean","description":"When true, validates file and returns changes without committing to database","default":true,"title":"Dryrun"},"description":"When true, validates file and returns changes without committing to database"},{"name":"scope","in":"query","required":false,"schema":{"type":"string","pattern":"^(auto|all|types|codes)$","description":"Dataset scope: 'auto', 'all', 'types', or 'codes'","default":"auto","title":"Scope"},"description":"Dataset scope: 'auto', 'all', 'types', or 'codes'"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_import_compat_handler_api_import_post"}}}},"responses":{"200":{"description":"Import operation results and summary counts","content":{"application/json":{"schema":{}}}},"400":{"description":"Invalid file format or validation errors"},"500":{"description":"Import processing failure"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/audit":{"get":{"tags":["Audit Logs"],"summary":"Query and filter audit logs","description":"Search structured audit log entries recorded in JSONL storage with multi-criteria filtering by date, status code, error type, and pagination.","operationId":"get_audit_logs_api_audit_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date in YYYY-MM-DD format. Filter entries to this date. Ignored if date_from/date_to or start_date/end_date are provided.","title":"Date"},"description":"Date in YYYY-MM-DD format. Filter entries to this date. Ignored if date_from/date_to or start_date/end_date are provided."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date in YYYY-MM-DD format (inclusive)","title":"Date From"},"description":"Start date in YYYY-MM-DD format (inclusive)"},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date in YYYY-MM-DD format (inclusive)","title":"Date To"},"description":"End date in YYYY-MM-DD format (inclusive)"},{"name":"error_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by error type","title":"Error Type"},"description":"Filter by error type"},{"name":"status_code","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by HTTP status code","title":"Status Code"},"description":"Filter by HTTP status code"},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date/time in ISO format","title":"Start Date"},"description":"Start date/time in ISO format"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date/time in ISO format","title":"End Date"},"description":"End date/time in ISO format"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of entries to return","default":100,"title":"Limit"},"description":"Maximum number of entries to return"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page index (1-based). For example, offset=3 with limit=10 returns page 3 (entries 20-29)","default":1,"title":"Offset"},"description":"Page index (1-based). For example, offset=3 with limit=10 returns page 3 (entries 20-29)"}],"responses":{"200":{"description":"Filtered list of audit log entries with pagination metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogResponse"}}}},"400":{"description":"Invalid date range parameters"},"500":{"description":"Failed to read or parse audit log file"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/dq-scan":{"get":{"tags":["Data Quality"],"summary":"Data quality integrity scan","description":"Executes comprehensive data quality validation across dbo.CodeManager:\n- **Duplicates**: Detects rows sharing identical CodeType and Code or Type and Name.\n- **Orphans**: Identifies child codes whose `ParentCodeManagerId` does not resolve to an active parent node.\n- **Overlaps**: Finds codes defined across multiple parent classifications.","operationId":"dq_scan_api_dq_scan_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"strict_orphans","in":"query","required":false,"schema":{"type":"boolean","description":"Enable strict orphan checking requiring explicit parent linkage","default":false,"title":"Strict Orphans"},"description":"Enable strict orphan checking requiring explicit parent linkage"}],"responses":{"200":{"description":"Data quality analysis report and summary counts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataQualityReportResponse"}}}},"500":{"description":"Internal error during data quality scanning"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/data-quality":{"get":{"tags":["Data Quality"],"summary":"Data quality diagnostics (Legacy / compatibility)","description":"Compatibility endpoint for `/api/dq-scan`. Identifies duplicate records, orphan references, and code overlaps.","operationId":"data_quality_api_data_quality_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"strict_orphans","in":"query","required":false,"schema":{"type":"boolean","description":"Enable strict orphan checking requiring explicit parent linkage","default":false,"title":"Strict Orphans"},"description":"Enable strict orphan checking requiring explicit parent linkage"}],"responses":{"200":{"description":"Data quality analysis report and summary counts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataQualityReportResponse"}}}},"500":{"description":"Internal error during data quality scanning"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/stats":{"get":{"tags":["Utilities"],"summary":"Application operational runtime statistics","description":"Returns service name, current version, process uptime in seconds, and health status.","operationId":"api_stats_api_stats_get","responses":{"200":{"description":"Runtime operational metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppStatsResponse"}}}},"401":{"description":"Missing or invalid internal authorization header"}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"AppStatsResponse":{"properties":{"app":{"type":"string","title":"App","description":"Application service name"},"version":{"type":"string","title":"Version","description":"Application release version"},"uptime_sec":{"type":"number","title":"Uptime Sec","description":"Process uptime in seconds"},"status":{"type":"string","title":"Status","description":"Operational status","default":"ok"}},"type":"object","required":["app","version","uptime_sec"],"title":"AppStatsResponse","example":{"app":"Code Manager API","status":"ok","uptime_sec":3600.5,"version":"1.0.0"}},"AuditLogResponse":{"properties":{"entries":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Entries","description":"Filtered audit log entries"},"total":{"type":"integer","title":"Total","description":"Total matching entries count","default":0},"page":{"type":"integer","title":"Page","description":"Current page number","default":1},"limit":{"type":"integer","title":"Limit","description":"Page size limit","default":100},"offset":{"type":"integer","title":"Offset","description":"1-based page offset index","default":1},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Single date filter if specified"},"date_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date From","description":"Start date filter if specified"},"date_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date To","description":"End date filter if specified"},"filters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Filters","description":"Active query filters applied"},"debug":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Debug","description":"Log diagnostic information"}},"type":"object","title":"AuditLogResponse"},"Body_add_from_doc_add_from_doc_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"Word document (.docx or .doc) containing reference code definitions"}},"type":"object","required":["file"],"title":"Body_add_from_doc_add_from_doc_post"},"Body_add_from_image_add_from_image_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"Image file (PNG, JPG, JPEG, WEBP) to scan and extract"}},"type":"object","required":["file"],"title":"Body_add_from_image_add_from_image_post"},"Body_add_from_pdf_add_from_pdf_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"PDF document (.pdf) containing reference code data"}},"type":"object","required":["file"],"title":"Body_add_from_pdf_add_from_pdf_post"},"Body_import_compat_handler_api_import_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"JSON, CSV, ZIP, DOCX, or PDF file (PDF must be text-based, not scanned)"}},"type":"object","required":["file"],"title":"Body_import_compat_handler_api_import_post"},"Body_ingest_anything_ingest_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"One of: image/*, application/pdf, .docx, .pptx, .csv, .json"}},"type":"object","required":["file"],"title":"Body_ingest_anything_ingest_post"},"Body_transfer_import_handler_api_transfer_import_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"JSON, CSV, ZIP, DOCX, or PDF file (PDF must be text-based, not scanned)"}},"type":"object","required":["file"],"title":"Body_transfer_import_handler_api_transfer_import_post"},"CodeManagerBulkCreateRequest":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CodeManagerCreateRequest"},"type":"array","title":"Items","description":"List of code items to create"}},"type":"object","required":["items"],"title":"CodeManagerBulkCreateRequest"},"CodeManagerBulkResponse":{"properties":{"created":{"items":{"$ref":"#/components/schemas/CodeManagerResponse"},"type":"array","title":"Created","description":"List of created code items"},"count":{"type":"integer","title":"Count","description":"Number of items created"}},"type":"object","required":["created","count"],"title":"CodeManagerBulkResponse"},"CodeManagerCreateRequest":{"properties":{"CodeType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codetype","description":"Category / CodeType (e.g. ROLE, LOAN_PURPOSE, ENTITY, CATEGORY)"},"Code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Unique code key (e.g. ADMIN, HOME_RENOVATION). Auto-generated if omitted."},"Name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Display name (e.g. Admin, Home renovation)"},"OrderNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ordernumber","description":"Display order sequence (default: 0)","default":0},"IsActive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isactive","description":"Active status flag (default: true)","default":true},"ParentCodeManagerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcodemanagerid","description":"Parent row GUID or parent Code to link to"},"Description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description"},"UpdatedNotes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatednotes","description":"Optional notes or remarks"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Alias for CodeType"},"codeType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codetype","description":"Alias for CodeType"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Alias for Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Alias for Name"},"seq":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seq","description":"Alias for OrderNumber"},"orderNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ordernumber","description":"Alias for OrderNumber"},"useFlag":{"anyOf":[{},{"type":"null"}],"title":"Useflag","description":"Alias for IsActive"},"isActive":{"anyOf":[{},{"type":"null"}],"title":"Isactive","description":"Alias for IsActive"},"parentCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcode","description":"Alias for ParentCodeManagerId"},"parentCodeManagerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcodemanagerid","description":"Alias for ParentCodeManagerId"},"updatedNotes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatednotes","description":"Alias for UpdatedNotes"},"Remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Alias for UpdatedNotes"}},"additionalProperties":true,"type":"object","title":"CodeManagerCreateRequest","example":{"Code":"ADMIN","CodeType":"ROLE","Description":"Administrator role","IsActive":true,"Name":"Admin","OrderNumber":1,"UpdatedNotes":"Created via API"}},"CodeManagerPagedResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CodeManagerResponse"},"type":"array","title":"Items","description":"List of items for current page"},"total":{"type":"integer","title":"Total","description":"Total matching records count"},"page":{"type":"integer","title":"Page","description":"Current page number","default":1},"pageSize":{"type":"integer","title":"Pagesize","description":"Items per page","default":10}},"type":"object","required":["items","total"],"title":"CodeManagerPagedResponse"},"CodeManagerResponse":{"properties":{"Id":{"anyOf":[{},{"type":"null"}],"title":"Id","description":"Unique row GUID Id or legacy ID"},"CodeType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codetype","description":"Category / CodeType (e.g. ROLE, LOAN_PURPOSE)"},"Code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Unique code key (e.g. ADMIN)"},"Name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Display name (e.g. Admin)"},"OrderNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ordernumber","description":"Display order sequence","default":0},"CreatedAtUtc":{"anyOf":[{},{"type":"null"}],"title":"Createdatutc","description":"Creation timestamp in UTC"},"IsActive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isactive","description":"Active status flag","default":true},"CreatedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdbyuserid","description":"User GUID who created the record"},"Description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Detailed description"},"UpdatedAtUtc":{"anyOf":[{},{"type":"null"}],"title":"Updatedatutc","description":"Last update timestamp in UTC"},"UpdatedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedbyuserid","description":"User GUID who last updated the record"},"UpdatedNotes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatednotes","description":"Notes / remarks"},"RowVersion":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rowversion","description":"Concurrency row version"},"ParentCodeManagerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcodemanagerid","description":"Parent row GUID Id"}},"additionalProperties":true,"type":"object","title":"CodeManagerResponse","example":{"Code":"ADMIN","CodeType":"ROLE","CreatedAtUtc":"2026-10-13T11:43:33.658000","Description":"Administrator role","Id":"65FE6595-08EF-4F64-9B8E-AE6468096660","IsActive":true,"Name":"Admin","OrderNumber":1,"ParentCodeManagerId":"2D38AFD6-C5CA-4605-8D02-6811933C1C05","RowVersion":"0000000000002983","UpdatedNotes":"Created via API"}},"CodeManagerStatsResponse":{"properties":{"totalRecords":{"type":"integer","title":"Totalrecords","description":"Total records in dbo.CodeManager"},"activeRecords":{"type":"integer","title":"Activerecords","description":"Active records (IsActive = 1)"},"inactiveRecords":{"type":"integer","title":"Inactiverecords","description":"Inactive / soft-deleted records"},"distinctCodeTypesCount":{"type":"integer","title":"Distinctcodetypescount","description":"Total distinct CodeTypes"},"rootNodesCount":{"type":"integer","title":"Rootnodescount","description":"Top-level root records count"},"recordsByCodeType":{"additionalProperties":{"type":"integer"},"type":"object","title":"Recordsbycodetype","description":"Item counts per CodeType"}},"additionalProperties":true,"type":"object","required":["totalRecords","activeRecords","inactiveRecords","distinctCodeTypesCount","rootNodesCount","recordsByCodeType"],"title":"CodeManagerStatsResponse","example":{"activeRecords":30,"distinctCodeTypesCount":11,"inactiveRecords":0,"recordsByCodeType":{"CITY":8,"LOAN_PURPOSE":4,"ROLE":3,"STATE":4},"rootNodesCount":8,"totalRecords":30}},"CodeManagerTypesListResponse":{"properties":{"codeTypes":{"items":{"type":"string"},"type":"array","title":"Codetypes","description":"List of distinct CodeType category names"},"total":{"type":"integer","title":"Total","description":"Count of distinct CodeTypes"}},"type":"object","required":["codeTypes","total"],"title":"CodeManagerTypesListResponse"},"CodeManagerUpdateRequest":{"properties":{"Name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Updated display name"},"Code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Updated unique Code"},"CodeType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codetype","description":"Updated CodeType"},"OrderNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ordernumber","description":"Updated display order"},"IsActive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isactive","description":"Updated active status"},"ParentCodeManagerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcodemanagerid","description":"Updated parent GUID or Code"},"Description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Updated description"},"UpdatedNotes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatednotes","description":"Updated notes / remarks"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"seq":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seq"},"orderNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ordernumber"},"useFlag":{"anyOf":[{},{"type":"null"}],"title":"Useflag"},"isActive":{"anyOf":[{},{"type":"null"}],"title":"Isactive"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"updatedNotes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatednotes"},"Remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks"},"parentCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcode"},"parentCodeManagerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcodemanagerid"}},"additionalProperties":true,"type":"object","title":"CodeManagerUpdateRequest","example":{"Description":"Updated administrator role","IsActive":true,"Name":"Admin (Updated)","OrderNumber":1,"UpdatedNotes":"Updated via API"}},"DataQualityReportResponse":{"properties":{"duplicates":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Duplicates","description":"Duplicate type/code rows"},"orphans":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Orphans","description":"Orphaned records referencing non-existent parents"},"overlaps":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Overlaps","description":"Overlapping codes across types"},"summary":{"$ref":"#/components/schemas/DataQualitySummary","description":"Summary counts of data quality issues"}},"type":"object","required":["summary"],"title":"DataQualityReportResponse","example":{"duplicates":[],"orphans":[],"overlaps":[],"summary":{"duplicate_count":0,"orphan_count":0,"overlap_count":0}}},"DataQualitySummary":{"properties":{"duplicate_count":{"type":"integer","title":"Duplicate Count","description":"Total count of duplicate entries found","default":0},"orphan_count":{"type":"integer","title":"Orphan Count","description":"Total count of orphaned records found","default":0},"overlap_count":{"type":"integer","title":"Overlap Count","description":"Total count of overlapping code keys across types","default":0}},"type":"object","title":"DataQualitySummary"},"DbPingResponse":{"properties":{"ok":{"type":"boolean","title":"Ok","description":"Database connection test status","default":true},"app":{"type":"string","title":"App","description":"Application name"}},"type":"object","required":["app"],"title":"DbPingResponse","example":{"app":"Code Manager API","ok":true}},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Service operational status","default":"ok"},"prompt_loaded":{"type":"boolean","title":"Prompt Loaded","description":"Indicates whether AI system prompt is successfully loaded","default":true},"env_loaded":{"type":"boolean","title":"Env Loaded","description":"Indicates whether OpenAI API key is detected in the environment","default":true},"version":{"type":"string","title":"Version","description":"API version string","default":"1.0.0"}},"type":"object","title":"HealthResponse","example":{"env_loaded":true,"prompt_loaded":true,"status":"ok","version":"1.0.0"}},"HierarchyChainResponse":{"properties":{"chain":{"type":"string","title":"Chain","description":"Human-readable chain notation e.g. 'COUNTRY -> STATE -> CITY'"},"levels":{"items":{"type":"string"},"type":"array","title":"Levels","description":"Ordered list of CodeTypes in this hierarchy path"},"depth":{"type":"integer","title":"Depth","description":"Number of levels in this chain"},"rootCodeType":{"type":"string","title":"Rootcodetype","description":"Top-level CodeType"},"leafCodeType":{"type":"string","title":"Leafcodetype","description":"Bottom-level CodeType"},"itemCount":{"type":"integer","title":"Itemcount","description":"Count of leaf nodes matching this full chain","default":0}},"additionalProperties":true,"type":"object","required":["chain","levels","depth","rootCodeType","leafCodeType"],"title":"HierarchyChainResponse","example":{"chain":"COUNTRY -> STATE -> CITY","depth":3,"itemCount":4,"leafCodeType":"CITY","levels":["COUNTRY","STATE","CITY"],"rootCodeType":"COUNTRY"}},"HierarchyNodeFlatResponse":{"properties":{"Id":{"type":"string","title":"Id","description":"Row GUID Id"},"CodeType":{"type":"string","title":"Codetype","description":"Category / CodeType"},"Code":{"type":"string","title":"Code","description":"Code key"},"Name":{"type":"string","title":"Name","description":"Display name"},"OrderNumber":{"type":"integer","title":"Ordernumber","description":"Display order sequence","default":0},"IsActive":{"type":"boolean","title":"Isactive","description":"Active status flag","default":true},"ParentCodeManagerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcodemanagerid","description":"Parent row GUID Id"},"level":{"type":"integer","title":"Level","description":"Depth level from root (0 = root)","default":0},"isLeaf":{"type":"boolean","title":"Isleaf","description":"True if this node has no children","default":false},"rootCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rootcode","description":"Code key of top-level root ancestor"},"rootCodeType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rootcodetype","description":"CodeType of top-level root ancestor"},"parentCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcode","description":"Code key of immediate parent"},"displayPath":{"type":"string","title":"Displaypath","description":"Full display path (e.g. 'India > Maharashtra > Mumbai')","default":""},"codePath":{"type":"string","title":"Codepath","description":"Full code path (e.g. 'IN / IN-MH / IN-MH-MUM')","default":""},"childrenCount":{"type":"integer","title":"Childrencount","description":"Immediate children count","default":0}},"additionalProperties":true,"type":"object","required":["Id","CodeType","Code","Name"],"title":"HierarchyNodeFlatResponse"},"HierarchyPathItem":{"properties":{"level":{"type":"integer","title":"Level","description":"Depth level from root (0 = root)"},"Id":{"type":"string","title":"Id","description":"Row GUID Id"},"CodeType":{"type":"string","title":"Codetype","description":"Category / CodeType"},"Code":{"type":"string","title":"Code","description":"Code key"},"Name":{"type":"string","title":"Name","description":"Display name"}},"additionalProperties":true,"type":"object","required":["level","Id","CodeType","Code","Name"],"title":"HierarchyPathItem"},"HierarchyPathResponse":{"properties":{"target":{"$ref":"#/components/schemas/HierarchyPathItem","description":"Target node details"},"depth":{"type":"integer","title":"Depth","description":"Total depth of the path (number of levels)"},"displayPath":{"type":"string","title":"Displaypath","description":"Full display path string (e.g. 'India > Maharashtra > Mumbai')"},"codePath":{"type":"string","title":"Codepath","description":"Full code path string (e.g. 'IN / IN-MH / IN-MH-MUM')"},"path":{"items":{"$ref":"#/components/schemas/HierarchyPathItem"},"type":"array","title":"Path","description":"Ordered list of ancestor nodes from root to target"}},"additionalProperties":true,"type":"object","required":["target","depth","displayPath","codePath","path"],"title":"HierarchyPathResponse","example":{"codePath":"IN / IN-MH / IN-MH-MUM","depth":3,"displayPath":"India > Maharashtra > Mumbai","path":[{"Code":"IN","CodeType":"COUNTRY","Id":"B8B0B880-99E6-4074-9C80-141444EC3F59","Name":"India","level":0},{"Code":"IN-MH","CodeType":"STATE","Id":"E608B040-2F57-4272-9995-282D7DE98796","Name":"Maharashtra","level":1},{"Code":"IN-MH-MUM","CodeType":"CITY","Id":"0F8FB11A-6C93-4BCE-A656-785BE13E9A70","Name":"Mumbai","level":2}],"target":{"Code":"IN-MH-MUM","CodeType":"CITY","Id":"0F8FB11A-6C93-4BCE-A656-785BE13E9A70","Name":"Mumbai","level":2}}},"HierarchyTreeNodeResponse":{"properties":{"Id":{"type":"string","title":"Id","description":"Unique row GUID Id"},"CodeType":{"type":"string","title":"Codetype","description":"Category / CodeType (e.g. COUNTRY, STATE, CITY, CATEGORY)"},"Code":{"type":"string","title":"Code","description":"Unique code key (e.g. IN, IN-MH, IN-MH-MUM)"},"Name":{"type":"string","title":"Name","description":"Display name (e.g. India, Maharashtra, Mumbai)"},"OrderNumber":{"type":"integer","title":"Ordernumber","description":"Display order sequence","default":0},"IsActive":{"type":"boolean","title":"Isactive","description":"Active status flag","default":true},"ParentCodeManagerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentcodemanagerid","description":"Parent row GUID Id"},"level":{"type":"integer","title":"Level","description":"Hierarchy depth level (0 = root, 1 = child, 2 = grandchild)","default":0},"path":{"items":{"type":"string"},"type":"array","title":"Path","description":"Array of ancestor Code keys from root down to this node"},"displayPath":{"type":"string","title":"Displaypath","description":"Human-readable path e.g. 'India > Maharashtra > Mumbai'","default":""},"codePath":{"type":"string","title":"Codepath","description":"Code path e.g. 'IN / IN-MH / IN-MH-MUM'","default":""},"childrenCount":{"type":"integer","title":"Childrencount","description":"Count of immediate children","default":0},"totalDescendants":{"type":"integer","title":"Totaldescendants","description":"Total count of all nested descendants","default":0},"children":{"items":{"$ref":"#/components/schemas/HierarchyTreeNodeResponse"},"type":"array","title":"Children","description":"List of immediate child tree nodes"}},"additionalProperties":true,"type":"object","required":["Id","CodeType","Code","Name"],"title":"HierarchyTreeNodeResponse","example":{"Code":"IN","CodeType":"COUNTRY","Id":"B8B0B880-99E6-4074-9C80-141444EC3F59","IsActive":true,"Name":"India","OrderNumber":1,"children":[{"Code":"IN-MH","CodeType":"STATE","Id":"E608B040-2F57-4272-9995-282D7DE98796","IsActive":true,"Name":"Maharashtra","OrderNumber":1,"ParentCodeManagerId":"B8B0B880-99E6-4074-9C80-141444EC3F59","children":[{"Code":"IN-MH-MUM","CodeType":"CITY","Id":"0F8FB11A-6C93-4BCE-A656-785BE13E9A70","IsActive":true,"Name":"Mumbai","OrderNumber":1,"ParentCodeManagerId":"E608B040-2F57-4272-9995-282D7DE98796","children":[],"childrenCount":0,"codePath":"IN / IN-MH / IN-MH-MUM","displayPath":"India > Maharashtra > Mumbai","level":2,"path":["IN","IN-MH","IN-MH-MUM"],"totalDescendants":0}],"childrenCount":2,"codePath":"IN / IN-MH","displayPath":"India > Maharashtra","level":1,"path":["IN","IN-MH"],"totalDescendants":2}],"childrenCount":2,"codePath":"IN","displayPath":"India","level":0,"path":["IN"],"totalDescendants":6}},"NLText":{"properties":{"text":{"type":"string","title":"Text","description":"Natural language instruction"},"dry_run":{"type":"boolean","title":"Dry Run","description":"If true, parse only; do not persist.","default":false}},"type":"object","required":["text"],"title":"NLText"},"PromptRequest":{"properties":{"prompt":{"type":"string","title":"Prompt"}},"type":"object","required":["prompt"],"title":"PromptRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","description":"Enter internal service auth secret (e.g. wf_internal_7uFq3sV8k2Qp1mN6yX0dJr9vL5aZcT4hG8nP2sW5)","in":"header","name":"X-Internal-Auth"}}},"tags":[{"name":"NL-DB","description":"Natural language operations directly connected to `dbo.CodeManager` (AI add, update, delete, query, and multi-format file ingest)."},{"name":"AI/NLPS","description":"Unified Natural Language Processing Service endpoint (create/update/delete/query) powered by AI over `dbo.CodeManager`."},{"name":"Hierarchy","description":"Hierarchical tree, ancestors breadcrumb paths, and cascading parent-child data from `dbo.CodeManager` (e.g. Country -> State -> City, Category -> Subcategory -> Subcategory Type)."},{"name":"Types","description":"Code types and root category definitions in `dbo.CodeManager` (e.g. `CODE_GROUP`, `BOOK`, `ROLE`, `COUNTRY`)."},{"name":"Codes","description":"Code items and lookup entries in `dbo.CodeManager` linked to their parent categories via `ParentCodeManagerId`."},{"name":"Catalog","description":"Unified catalog search, filtering, and nested child type browsing against `dbo.CodeManager`."},{"name":"Data Quality","description":"Integrity scans for `dbo.CodeManager` (duplicate codes, orphan parent references, and name overlaps)."},{"name":"Utilities","description":"Fast global substring search and client route resolver for `dbo.CodeManager` records."},{"name":"Code Manager AI","description":"Multi-modal AI ingestion endpoints (prompt, image OCR, PDF, Word documents) with automatic database persistence."},{"name":"Transfer","description":"Data import and export services across JSON, CSV, Excel, Word, and PDF formats with dry-run validation."},{"name":"Audit Logs","description":"Audit logging and token tracking for API and AI operations."},{"name":"Health","description":"Service health checks and database connectivity diagnostics."}]}