Skip to content

Using Endpoints

Jump to bottom
deniskavcic edited this page Feb 1, 2023 · 1 revision

Using Endpoints

With each entry in gba.Endpoint table a new GET API is exposed. These endpoints can be called in a similar manner to Get / APIs, but in addition to standard parameters of that APIs, user can also provide own query parameters that are then applied to placeholders in filter.

Result is flattened DTO object based on the definition specified in gba.EndpointProperty table.

Like with GET /, the return object is PagedResult, composed as:

{
  "recordsTotal": "total count of available records",
  "recordsFiltered": "total count of filtered records",
  "page": "returned page number",
  "pageSize": "returned page size",
  "data": ["list of Entity DTO objects"]
}

Example of calling Endpoint defined in example of Endpoint filter definition:

GET https://localhost/api/custom/endpoint/for/employees/?managerId=b075a16e-bc35-4ad2-9010-5a957957b5ae

Clone this wiki locally