Register
API Explorer 1 endpoints
https://obp-api-sandbox.nmbbank.co.tz

Get Dynamic Entity Diagnostics

GET /obp/v7.0.0/management/diagnostics/dynamic-entities

OBPv6.0.0-getDynamicEntityDiagnostics Roles: CanGetDynamicEntityDiagnostics Dynamic-EntityAPI

Get diagnostic information about Dynamic Entities to help troubleshoot Swagger generation issues.

Use Case: This endpoint is particularly useful when:

  • The Swagger endpoint (/obp/v6.0.0/resource-docs/OBPv6.0.0/swagger?content=dynamic) fails with errors like "expected boolean"
  • The OBP endpoint (/obp/v6.0.0/resource-docs/OBPv6.0.0/obp?content=dynamic) works fine
  • You need to identify which dynamic entity has malformed field definitions

What It Checks: This endpoint analyzes all dynamic entities (both system and bank level) for:

  • Boolean fields with invalid example values (e.g., actual JSON booleans or invalid strings instead of "true" or "false")
  • Malformed JSON in field definitions
  • Fields that cannot be converted to their declared types
  • Other validation issues that cause Swagger generation to fail

Response Format: The response contains:

  • issues - List of issues found, each with:
    • entity_name - Name of the problematic entity
    • bank_id - Bank ID (or "SYSTEM_LEVEL" for system entities)
    • field_name - Name of the problematic field
    • example_value - The current (invalid) example value
    • error_message - Description of what's wrong and how to fix it
  • total_issues - Count of total issues found
  • scanned_entities - List of all dynamic entities that were scanned (format: "EntityName (BANK_ID)" or "EntityName (SYSTEM)")

How to Fix Issues:

  1. Identify the problematic entity from the diagnostic output
  2. Update the entity definition using PUT /management/system-dynamic-entities/DYNAMIC_ENTITY_ID or PUT /management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID
  3. For boolean fields, ensure the example value is either "true" or "false" (as strings)
  4. Re-run this diagnostic to verify the fix
  5. Check that the Swagger endpoint now works

Example Issue:

{
  "entity_name": "Customer",
  "bank_id": "gh.29.uk",
  "field_name": "is_active",
  "example_value": "malformed_value",
  "error_message": "Boolean field has invalid example value. Expected 'true' or 'false', got: 'malformed_value'"
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Required Role: CanGetDynamicEntityDiagnostics

If no issues are found, the response will contain an empty issues list with total_issues: 0, but scanned_entities will show which entities were checked.

Example success response 
{
  "scanned_entities": [
    "MyEntity (gh.29.uk)",
    "AnotherEntity (SYSTEM)"
  ],
  "issues": [
    {
      "entity_name": "MyEntity",
      "bank_id": "gh.29.uk",
      "field_name": "is_active",
      "example_value": "malformed_value",
      "error_message": "Boolean field has invalid example value. Expected 'true' or 'false', got: 'malformed_value'"
    }
  ],
  "total_issues": 1,
  "orphaned_entities": [
    {
      "entity_name": "OldEntity",
      "bank_id": "gh.29.uk",
      "record_count": 42
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 getDynamicEntityDiagnostics Originally /obp/v6.0.0/management/diagnostics/dynamic-entities