Skip to main content

Entities

Gateway prefix: ${API_BASE}/metadata/entities/...

DTO fields (EntityDto)​

  • id string (returned)
  • name string, required, entity name (such as table name or business name)
  • dataSourceId string, required, associated data source ID
  • table string, optional, physical table name
  • description string, optional, description
  • fields array (returned), list of fields

Create entity​

  • POST /entities

Example:

curl -X POST \
  "${API_BASE}/metadata/entities" \
  -H "Content-Type: application/json" \
  -d '{
    "name":"orders",
    "dataSourceId":"ds-1001",
    "table":"orders",
    "description":"Orders table"
  }'

Update / delete / get by ID​

  • PUT /entities/{id}
  • DELETE /entities/{id}
  • GET /entities/{id}
curl -X PUT "${API_BASE}/metadata/entities/en-5001" -H "Content-Type: application/json" -d '{"description":"Orders table (updated)"}'
curl -X DELETE "${API_BASE}/metadata/entities/en-5001"
curl -X GET "${API_BASE}/metadata/entities/en-5001"

Get by name​

  • GET /entities/name/{name}
curl -X GET "${API_BASE}/metadata/entities/name/orders"

Search and filter by data source​

  • GET /entities?keyword=&page=&pageSize=&sortBy=&sortDirection=
  • GET /entities/datasource/{dataSourceId}
curl "${API_BASE}/metadata/entities?keyword=order&page=0&pageSize=10"
curl -X GET "${API_BASE}/metadata/entities/datasource/ds-1001"