- URL:
- https://<catalog-url>/<serviceName>/RelationalCatalogServer/entities
- Methods:
GET- Child Resources:
- Entity
- Version Introduced:
- 10.5
Description
An entity describes a table or view in a database. This resource provides an array of all the entities the service has access to.
Request Parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is html. Values: html | json |
Example Usage
JSON Response Syntax
{
"entities": [
{
"catalogId": "", //unique ID for the entity
"alias": "", //user-friendly name (not guaranteed to be unique)
}, …
]
}JSON Response Example
{
"entities": [
{
"catalogId": "dbo.flight_aircraft",
"alias": "flight_aircraft"
},
{
"catalogId": "dbo.flight_airline",
"alias": "flight_airline"
},
{
"catalogId": "dbo.flight_airport",
"alias": "flight_airport"
},
{
"catalogId": "dbo.flight_departure",
"alias": "flight_departure"
},
{
"catalogId": "dbo.flight_route",
"alias": "flight_route"
}
]
}