{"openapi":"3.1.0","info":{"title":"WorkFINITY® Interface AI API","description":"\n## WorkFINITY® Solution Configuration Management System — Interface AI API\n\nA high-performance enterprise REST API for configuring, orchestrating, and managing system interfaces, communication protocols, external integration endpoints, and contract schemas across WorkFINITY®.\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### 🧱 Core Architecture & Data Model\n- **Interface Hub (`dbo.Interface_Hub`)**: Global catalog of reusable integration definitions, endpoint contracts, methods, protocols, request/response structures, and schema mappings.\n- **Category Interfaces (`dbo.Interface`)**: Concrete implementations and contextual bindings of interfaces assigned to operational business categories, items, and checklists.\n- **Lifecycle & Availability**: Active/inactive status toggling, category-filtered availability queries, and multi-endpoint bulk attachments.\n\n---\n\n### ⚡ Endpoints & Features\n- **Interface Management**: List, bulk create, update, and remove interface assignments scoped by category.\n- **Interface Hub Repository**: Register, inspect, edit, toggle active status, and remove global interface contracts.\n- **System Diagnostics**: Real-time service uptime, database ping probes, and live OpenAPI specification endpoints.\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.0.0"},"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://interface-ai-portal.workfinity.com","description":"Production Portal"}],"paths":{"/health":{"get":{"tags":["Health"],"summary":"Service health and readiness check","description":"Returns service status, database configuration status, and API version.","operationId":"health_health_get","responses":{"200":{"description":"Service is healthy and ready to accept requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}},"/db-ping":{"get":{"tags":["Health"],"summary":"Database connectivity ping test","description":"Executes a lightweight query (SELECT 1) against SQL Server to verify database connectivity.","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"}}}},"/api/stats":{"get":{"tags":["Utilities"],"summary":"Application operational runtime statistics","description":"Returns service name, current version, process uptime in seconds, and 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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/interface/list/{interface_category}":{"get":{"tags":["Interfaces"],"summary":"List category interface bindings","description":"Retrieve paginated interface bindings for a specific category (item or checklist), with optional interface ID and name filtering.","operationId":"list_interfaces_api_interface_list__interface_category__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"interface_category","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"description":"Interface category name (e.g. 'item', 'checklist')","title":"Interface Category"},"description":"Interface category name (e.g. 'item', 'checklist')"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"1-based page number","default":1,"title":"Page"},"description":"1-based page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of records per page","default":20,"title":"Page Size"},"description":"Number of records per page"},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional Interface ID filter","title":"Id"},"description":"Optional Interface ID filter"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional Interface name filter","title":"Name"},"description":"Optional Interface name filter"},{"name":"item_definition_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by Item Definition GUID","title":"Item Definition Id"},"description":"Filter by Item Definition GUID"},{"name":"checklist_definition_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by Checklist Definition GUID","title":"Checklist Definition Id"},"description":"Filter by Checklist Definition GUID"}],"responses":{"200":{"description":"Paginated list of interface bindings retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfacePagedResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/interface/hub-list/{interface_category}":{"get":{"tags":["Interfaces"],"summary":"List available Interface Hub definitions for category","description":"Retrieve paginated available Interface Hub definitions eligible for binding to a specific category, with optional item or checklist scoping.","operationId":"list_available_interface_hub_api_interface_hub_list__interface_category__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"interface_category","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"description":"Interface category name (e.g. 'item', 'checklist')","title":"Interface Category"},"description":"Interface category name (e.g. 'item', 'checklist')"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"1-based page number","default":1,"title":"Page"},"description":"1-based page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of records per page","default":20,"title":"Page Size"},"description":"Number of records per page"},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional Interface Hub ID filter","title":"Id"},"description":"Optional Interface Hub ID filter"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional Interface name filter","title":"Name"},"description":"Optional Interface name filter"},{"name":"item_definition_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by Item Definition GUID","title":"Item Definition Id"},"description":"Filter by Item Definition GUID"},{"name":"checklist_definition_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by Checklist Definition GUID","title":"Checklist Definition Id"},"description":"Filter by Checklist Definition GUID"}],"responses":{"200":{"description":"Paginated list of available Interface Hub definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceHubAvailablePagedResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/interface":{"post":{"tags":["Interfaces"],"summary":"Bulk create category interface bindings","description":"Attach one or more Interface Hub definitions to an item or checklist definition with optional configuration JSON.","operationId":"create_interfaces_api_interface_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceBulkCreate"}}},"required":true},"responses":{"201":{"description":"Interface bindings created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceBulkCreateResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Validation error or duplicate definition IDs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/interface/{interface_id}":{"put":{"tags":["Interfaces"],"summary":"Update category interface binding","description":"Modify configuration JSON, active status, or definition association for an existing category interface binding.","operationId":"update_interface_api_interface__interface_id__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"interface_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Target Interface GUID","title":"Interface Id"},"description":"Target Interface GUID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interfaces__InterfaceUpdate"}}}},"responses":{"200":{"description":"Interface binding updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interfaces__InterfaceOut"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Interface binding not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Interfaces"],"summary":"Delete category interface binding","description":"Permanently remove an interface binding record by its unique ID.","operationId":"delete_interface_api_interface__interface_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"interface_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Target Interface GUID to delete","title":"Interface Id"},"description":"Target Interface GUID to delete"}],"responses":{"200":{"description":"Interface binding removed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interfaces__InterfaceMessageResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Interface binding not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/interfaces/list":{"get":{"tags":["Interface Definitions"],"summary":"List global interface definitions","description":"Retrieve paginated interface definitions from the Interface Hub repository, with optional filtering by ID, name, or protocol/interface type.","operationId":"get_interface_repository_api_interfaces_list_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"1-based page number","default":1,"title":"Page"},"description":"1-based page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Number of records per page","default":10,"title":"Page Size"},"description":"Number of records per page"},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional Interface Definition GUID filter","title":"Id"},"description":"Optional Interface Definition GUID filter"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter definitions by partial or exact name","title":"Name"},"description":"Filter definitions by partial or exact name"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"description":"Filter definitions by interface type / protocol","title":"Type"},"description":"Filter definitions by interface type / protocol"}],"responses":{"200":{"description":"Paginated list of interface definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceListResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/interface/addInterface":{"post":{"tags":["Interface Definitions"],"summary":"Create interface definition","description":"Register a new reusable interface definition, protocol specification, or integration contract in the Interface Hub repository.","operationId":"create_interface_api_interface_addInterface_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceCreate"}}},"required":true},"responses":{"201":{"description":"Interface definition registered successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceMessageResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Validation error or invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/interface/editInterface/{Id}":{"put":{"tags":["Interface Definitions"],"summary":"Update interface definition","description":"Update existing interface definition attributes, protocol configuration, metadata, or documentation notes.","operationId":"edit_interface_api_interface_editInterface__Id__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Unique Interface Definition GUID to update","title":"Id"},"description":"Unique Interface Definition GUID to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceUpdate"}}}},"responses":{"200":{"description":"Interface definition updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceMessageResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Interface definition not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/interface/deleteInterface/{Id}":{"delete":{"tags":["Interface Definitions"],"summary":"Delete interface definition","description":"Remove an interface definition from the Interface Hub catalog by its unique identifier.","operationId":"delete_interface_api_interface_deleteInterface__Id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Unique Interface Definition GUID to delete","title":"Id"},"description":"Unique Interface Definition GUID to delete"}],"responses":{"200":{"description":"Interface definition deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceMessageResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Interface definition not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/interface/toggleInterface/{Id}":{"put":{"tags":["Interface Definitions"],"summary":"Toggle interface active/inactive status","description":"Flip the active status flag of an interface definition between active and inactive.","operationId":"status_toggle_interface_api_interface_toggleInterface__Id__put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Unique Interface Definition GUID whose status should be toggled","title":"Id"},"description":"Unique Interface Definition GUID whose status should be toggled"}],"responses":{"200":{"description":"Interface definition status toggled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceMessageResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Interface definition not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/interfaces/import":{"post":{"tags":["Interface Definitions"],"summary":"Import interface definitions from a file","description":"Creates Interface Hub definitions from a CSV or JSON file (docs/import-templates/07-interfaces.csv). Columns: Name (required), InterfaceType, Description, IsActive; Direction, InternalOrExternal, RequestFields and ResponseFields are kept in the description. A name the application already has is skipped; each failed row is reported with its row number. Use dryRun=true to validate only.","operationId":"import_interface_definitions_api_interfaces_import_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"applicationId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Application GUID the definitions belong to","title":"Applicationid"},"description":"Application GUID the definitions belong to"},{"name":"dryRun","in":"query","required":false,"schema":{"type":"boolean","description":"Validate and report without saving","default":false,"title":"Dryrun"},"description":"Validate and report without saving"},{"name":"createdByUserId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Creator UserAccount GUID","title":"Createdbyuserid"},"description":"Creator UserAccount GUID"},{"name":"X-App-Id","in":"header","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Used when applicationId is not given","title":"X-App-Id"},"description":"Used when applicationId is not given"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_import_interface_definitions_api_interfaces_import_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportResult"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Empty or unreadable file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/data-quality":{"get":{"tags":["Data Quality"],"summary":"Integrity scan for interface bindings and definitions","description":"Detects orphaned category interface bindings, enabled bindings to inactive definitions, and corrupted configuration JSON.","operationId":"data_quality_scan_api_data_quality_get","responses":{"200":{"description":"Data quality scan report generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataQualityReportResponse"}}}},"401":{"description":"Missing or invalid internal authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"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":"WorkFINITY® Interface AI API","status":"ok","uptime_sec":3600.5,"version":"1.0.0"}},"Body_import_interface_definitions_api_interfaces_import_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"Interfaces as CSV or JSON"}},"type":"object","required":["file"],"title":"Body_import_interface_definitions_api_interfaces_import_post"},"DataQualityReportResponse":{"properties":{"orphaned_interfaces":{"items":{"type":"object"},"type":"array","title":"Orphaned Interfaces","description":"Interfaces referencing missing Interface Hub definitions"},"inactive_bindings":{"items":{"type":"object"},"type":"array","title":"Inactive Bindings","description":"Enabled interfaces referencing inactive definitions"},"invalid_json_configs":{"items":{"type":"object"},"type":"array","title":"Invalid Json Configs","description":"Interfaces with unparseable configuration JSON"},"summary":{"$ref":"#/components/schemas/DataQualitySummary","description":"Summary counts of data quality integrity issues"}},"type":"object","required":["summary"],"title":"DataQualityReportResponse","example":{"inactive_bindings":[],"invalid_json_configs":[],"orphaned_interfaces":[],"summary":{"inactive_bindings":0,"invalid_json_configs":0,"orphaned_interfaces":0}}},"DataQualitySummary":{"properties":{"orphaned_interfaces":{"type":"integer","title":"Orphaned Interfaces","description":"Total category interfaces referencing non-existent Interface Hub definitions","default":0},"inactive_bindings":{"type":"integer","title":"Inactive Bindings","description":"Total enabled interfaces referencing inactive Interface Hub definitions","default":0},"invalid_json_configs":{"type":"integer","title":"Invalid Json Configs","description":"Total interface records with unparsable configurationJson","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":"WorkFINITY® Interface AI API","ok":true}},"ErrorResponse":{"properties":{"detail":{"type":"string","title":"Detail","description":"Error explanation message"}},"type":"object","required":["detail"],"title":"ErrorResponse","example":{"detail":"Invalid request or authorization failed"}},"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"},"db_configured":{"type":"boolean","title":"Db Configured","description":"Indicates whether database server details are configured","default":true},"version":{"type":"string","title":"Version","description":"API version string","default":"1.0.0"}},"type":"object","title":"HealthResponse","example":{"db_configured":true,"status":"ok","version":"1.0.0"}},"ImportResult":{"properties":{"ok":{"type":"boolean","title":"Ok"},"dryRun":{"type":"boolean","title":"Dryrun"},"entity":{"type":"string","title":"Entity"},"summary":{"$ref":"#/components/schemas/ImportSummary"},"errors":{"items":{"$ref":"#/components/schemas/ImportRowError"},"type":"array","title":"Errors","default":[]}},"type":"object","required":["ok","dryRun","entity","summary"],"title":"ImportResult"},"ImportRowError":{"properties":{"row":{"type":"integer","title":"Row"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"},"reason":{"type":"string","title":"Reason"}},"type":"object","required":["row","reason"],"title":"ImportRowError"},"ImportSummary":{"properties":{"created":{"type":"integer","title":"Created","default":0},"skipped":{"type":"integer","title":"Skipped","default":0},"errors":{"type":"integer","title":"Errors","default":0}},"type":"object","title":"ImportSummary"},"InterfaceBulkCreate":{"properties":{"interfaceDefinitionIds":{"items":{"type":"string","format":"uuid"},"type":"array","minItems":1,"title":"Interfacedefinitionids","description":"List of unique Interface Hub definition GUIDs to bind"},"itemDefinitionId":{"type":"string","format":"uuid","title":"Itemdefinitionid","description":"Target Item Definition GUID"},"checklistDefinitionId":{"type":"string","format":"uuid","title":"Checklistdefinitionid","description":"Target Checklist / Workflow Definition GUID"},"configurationJson":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Configurationjson","description":"Optional custom JSON configuration string"},"isEnabled":{"type":"boolean","title":"Isenabled","description":"Whether the interface binding is enabled","default":true},"createdByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Createdbyuserid","description":"Optional creator UserAccount GUID"}},"type":"object","required":["interfaceDefinitionIds","itemDefinitionId","checklistDefinitionId"],"title":"InterfaceBulkCreate","example":{"checklistDefinitionId":"b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e","configurationJson":"{\"timeout_ms\": 5000, \"retry_attempts\": 3, \"endpoint_env\": \"production\"}","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","interfaceDefinitionIds":["071b29b9-03a0-42b4-bd9f-06b3bcc2a4a5","408ab02f-3a52-4ddf-8402-ed7094c38691"],"isEnabled":true,"itemDefinitionId":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"}},"InterfaceBulkCreateResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Operation summary message"},"items":{"items":{"$ref":"#/components/schemas/app__schemas__interfaces__InterfaceOut"},"type":"array","title":"Items","description":"Created interface bindings"}},"type":"object","required":["message"],"title":"InterfaceBulkCreateResponse","example":{"items":[{"checklistDefinitionId":"b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e","configurationJson":"{\"timeout_ms\": 5000}","createdAtUtc":"2026-10-19T10:00:00Z","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","id":"c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f","interfaceDefinitionId":"071b29b9-03a0-42b4-bd9f-06b3bcc2a4a5","isEnabled":true,"itemDefinitionId":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","rowVersion":"AAAAAAAACA0="}],"message":"2 interface(s) created successfully"}},"InterfaceCreate":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name","description":"Interface definition name"},"interfaceType":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Interfacetype","description":"Protocol or interface category (e.g. 'REST', 'SOAP', 'WEBHOOK')"},"createdByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Createdbyuserid","description":"Creator UserAccount GUID"},"applicationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Applicationid","description":"Scoping Application GUID"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Detailed explanation of the interface contract"},"repositoryId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Repositoryid","description":"Associated repository identifier"},"isActive":{"type":"boolean","title":"Isactive","description":"Whether the interface definition is active and eligible for binding","default":true}},"type":"object","required":["name"],"title":"InterfaceCreate","example":{"applicationId":"a5aae627-11c5-4610-9f7f-a5c7144313de","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","description":"Integration endpoint that creates a loan account after underwriting approval","interfaceType":"REST","isActive":true,"name":"Core Banking - Create Loan Account","repositoryId":"bc69dae7-f2c1-4674-91ff-5198f0709c0e"}},"InterfaceHubAvailablePagedResponse":{"properties":{"total":{"type":"integer","title":"Total","description":"Total available definitions count"},"page":{"type":"integer","title":"Page","description":"Current 1-based page number"},"page_size":{"type":"integer","title":"Page Size","description":"Page size limit"},"items":{"items":{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceOut"},"type":"array","title":"Items","description":"Available Interface Hub definitions"}},"type":"object","required":["total","page","page_size"],"title":"InterfaceHubAvailablePagedResponse"},"InterfaceListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceOut"},"type":"array","title":"Items","description":"List of interface definitions"},"total":{"type":"integer","title":"Total","description":"Total matching records count"},"page":{"type":"integer","title":"Page","description":"Current 1-based page number"},"page_size":{"type":"integer","title":"Page Size","description":"Page size limit"}},"type":"object","required":["total","page","page_size"],"title":"InterfaceListResponse","example":{"items":[{"applicationId":"a5aae627-11c5-4610-9f7f-a5c7144313de","createdAtUtc":"2026-10-12T13:35:02.544Z","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","description":"Creates the loan account after acceptance","id":"408ab02f-3a52-4ddf-8402-ed7094c38691","interfaceType":"REST","isActive":true,"name":"Core Banking - Create Loan Account","repositoryId":"bc69dae7-f2c1-4674-91ff-5198f0709c0e","rowVersion":"AAAAAAAACA4="}],"page":1,"page_size":10,"total":1}},"InterfacePagedResponse":{"properties":{"total":{"type":"integer","title":"Total","description":"Total matching records count"},"page":{"type":"integer","title":"Page","description":"Current 1-based page number"},"page_size":{"type":"integer","title":"Page Size","description":"Page size limit"},"items":{"items":{"$ref":"#/components/schemas/app__schemas__interfaces__InterfaceOut"},"type":"array","title":"Items","description":"List of category interface bindings"}},"type":"object","required":["total","page","page_size"],"title":"InterfacePagedResponse","example":{"items":[{"checklistDefinitionId":"b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e","configurationJson":"{\"timeout_ms\": 5000}","createdAtUtc":"2026-10-19T10:00:00Z","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","id":"c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f","interfaceDefinitionId":"071b29b9-03a0-42b4-bd9f-06b3bcc2a4a5","isEnabled":true,"itemDefinitionId":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","rowVersion":"AAAAAAAACA0="}],"page":1,"page_size":20,"total":1}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"app__schemas__interface_hub__InterfaceMessageResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Result message"},"data":{"anyOf":[{"$ref":"#/components/schemas/app__schemas__interface_hub__InterfaceOut"},{"type":"null"}],"description":"Target interface definition if applicable"}},"type":"object","required":["message"],"title":"InterfaceMessageResponse","example":{"data":{"applicationId":"a5aae627-11c5-4610-9f7f-a5c7144313de","createdAtUtc":"2026-10-12T13:35:02.544Z","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","description":"Creates the loan account after acceptance","id":"408ab02f-3a52-4ddf-8402-ed7094c38691","interfaceType":"REST","isActive":true,"name":"Core Banking - Create Loan Account","repositoryId":"bc69dae7-f2c1-4674-91ff-5198f0709c0e","rowVersion":"AAAAAAAACA4="},"message":"Interface created successfully"}},"app__schemas__interface_hub__InterfaceOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique Interface Definition GUID"},"name":{"type":"string","title":"Name","description":"Interface definition name"},"interfaceType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interfacetype","description":"Protocol or interface category"},"createdAtUtc":{"type":"string","format":"date-time","title":"Createdatutc","description":"UTC creation timestamp"},"createdByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Createdbyuserid","description":"Creator UserAccount GUID"},"applicationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Applicationid","description":"Associated Application GUID"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Interface description"},"repositoryId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Repositoryid","description":"Associated repository identifier"},"isActive":{"type":"boolean","title":"Isactive","description":"Whether definition is active"},"updatedAtUtc":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedatutc","description":"UTC last updated timestamp"},"updatedByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updatedbyuserid","description":"Updater UserAccount GUID"},"updatedNotes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatednotes","description":"Revision notes"},"rowVersion":{"type":"string","title":"Rowversion","description":"Concurrency row version string"}},"type":"object","required":["id","name","createdAtUtc","isActive","rowVersion"],"title":"InterfaceOut","example":{"applicationId":"a5aae627-11c5-4610-9f7f-a5c7144313de","createdAtUtc":"2026-10-12T13:35:02.544Z","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","description":"Creates the loan account after acceptance","id":"408ab02f-3a52-4ddf-8402-ed7094c38691","interfaceType":"REST","isActive":true,"name":"Core Banking - Create Loan Account","repositoryId":"bc69dae7-f2c1-4674-91ff-5198f0709c0e","rowVersion":"AAAAAAAACA4="}},"app__schemas__interface_hub__InterfaceUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Name","description":"Updated interface name"},"interfaceType":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Interfacetype","description":"Updated interface type"},"applicationId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Applicationid","description":"Updated application GUID"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Updated description"},"repositoryId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Repositoryid","description":"Updated repository identifier"},"isActive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isactive","description":"Updated active status"},"updatedByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updatedbyuserid","description":"Updater UserAccount GUID"},"updatedNotes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatednotes","description":"Change log or revision notes"}},"type":"object","title":"InterfaceUpdate","example":{"applicationId":"a5aae627-11c5-4610-9f7f-a5c7144313de","description":"Updated endpoint with OAuth2 authentication and enhanced retry policies","interfaceType":"REST","isActive":true,"name":"Core Banking - Create Loan Account (v2)","repositoryId":"bc69dae7-f2c1-4674-91ff-5198f0709c0e","updatedByUserId":"aaaaaaaa-0000-0000-0000-000000000003","updatedNotes":"Updated timeout to 10s and migrated to v2 contract"}},"app__schemas__interfaces__InterfaceMessageResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Result or confirmation message"}},"type":"object","required":["message"],"title":"InterfaceMessageResponse","example":{"message":"Interface deleted successfully"}},"app__schemas__interfaces__InterfaceOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"itemDefinitionId":{"type":"string","format":"uuid","title":"Itemdefinitionid"},"checklistDefinitionId":{"type":"string","format":"uuid","title":"Checklistdefinitionid"},"interfaceDefinitionId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Interfacedefinitionid"},"configurationJson":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Configurationjson"},"isEnabled":{"type":"boolean","title":"Isenabled"},"createdAtUtc":{"type":"string","format":"date-time","title":"Createdatutc"},"createdByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Createdbyuserid"},"updatedAtUtc":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedatutc"},"updatedByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updatedbyuserid"},"rowVersion":{"type":"string","title":"Rowversion"}},"type":"object","required":["id","itemDefinitionId","checklistDefinitionId","isEnabled","createdAtUtc","rowVersion"],"title":"InterfaceOut","example":{"checklistDefinitionId":"b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e","configurationJson":"{\"timeout_ms\": 5000}","createdAtUtc":"2026-10-19T10:00:00Z","createdByUserId":"aaaaaaaa-0000-0000-0000-000000000003","id":"c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f","interfaceDefinitionId":"071b29b9-03a0-42b4-bd9f-06b3bcc2a4a5","isEnabled":true,"itemDefinitionId":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","rowVersion":"AAAAAAAACA0="}},"app__schemas__interfaces__InterfaceUpdate":{"properties":{"interfaceDefinitionId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Interfacedefinitionid","description":"Reassigned Interface Hub definition GUID"},"configurationJson":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Configurationjson","description":"Updated custom JSON configuration string"},"isEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isenabled","description":"Updated enabled/disabled flag"},"updatedByUserId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updatedbyuserid","description":"Updater UserAccount GUID"}},"type":"object","title":"InterfaceUpdate","example":{"configurationJson":"{\"timeout_ms\": 10000, \"retry_attempts\": 5}","interfaceDefinitionId":"071b29b9-03a0-42b4-bd9f-06b3bcc2a4a5","isEnabled":true,"updatedByUserId":"aaaaaaaa-0000-0000-0000-000000000003"}}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","description":"Enter internal service auth secret (e.g. wf_internal_7uFq3sV8k2Qp1mN6yX0dJr9vL5aZcT4hG8nP2sW5)","in":"header","name":"X-Internal-Auth"}}},"tags":[{"name":"Interfaces","description":"Category-scoped interface assignments and configuration management against `dbo.Interface` and `dbo.Interface_Hub`."},{"name":"Interface Definitions","description":"Enterprise reusable interface definitions, endpoints, protocols, and contract management in `dbo.Interface_Hub`."},{"name":"Data Quality","description":"Integrity scans for category interfaces and Interface Hub definitions (orphaned bindings, inactive definitions, invalid configuration JSON)."},{"name":"Utilities","description":"Service operational runtime metrics, process uptime, and diagnostics."},{"name":"Health","description":"Service health checks and database connectivity diagnostics."}]}