Entity Search
This class extends Search and allows requests to be made to any resource under the /entities endpoint of the OpenGate North API.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | this is configuration about Opengate North API. |
| url | string |
❌ | this define a specific resource to make the search |
| filter | object |
❌ | this is the filter |
| limit | object |
❌ | this is the pagination about the search |
| sort | object |
❌ | this define parameters to order the result of search |
| group | object |
❌ | this define parameters to group |
| select | object |
❌ | this define fields to retrieve |
execute()
This invokes a request to the OpenGate North API; the response is handled via promises.
Retorna
Tip
Tipo: Promise