Każda usługa zaimplementowana w systemie HgDB zawiera metodę echo(POST). Pozwala ona na weryfikację poprawności zdefiniowanej komunikacji pomiędzy klientem a serwerem. Przykładem zastosowania metody jest implementacja źródła danych dla systemu Grafana: datasource.ts gdzie w metodzie testDatasource() wykorzystano wywołanie metody echo usługi CaseSearchRest.
echo(POST)
Metoda testowania połączenia.
Żądanie usługi
Opis żądania wysyłanego do usługi - parametry wejściowe:
| Parametr | Opis | Przykład |
|---|---|---|
| context | Kontekst żądania (zobacz Context i CaseHeader) | {
userName: 'anonymous',
userFullName: null,
locale: null,
timeZone: null,
maxResults: 1,
currentRole: 'anonymous',
userRoles: null,
sourceOfRequest: null,
maxDepthResult: 1,
decodeResult: DECODE_DATE_AND_LOB,
ignoreCaseHeaderInResponse: false,
}
|
| someText | Wartość testowa | "Hello World!" |
Odpowiedź usługi
Odpowiedź usługi ma następujące parametry wyjściowe:
| Parametr | Opis | Przykład |
|---|---|---|
| errorCode | Kod błędu. Gdy operacja zakończy się sukcesem, przyjmuje wartość null . Informacje na temat danych zawartych w wartości tego parametru można uzyskać czytając artykuł Co oznacza wartość pola "errorCode"? | null |
| errorMessage | Komunikat błędu. Gdy operacja zakończy się sukcesem, przyjmuje wartość null . | null |
| value | Wartość odpowiedzi. Gdy operacja zakończy się sukcesem, przyjmuje wartość parametru wejściowego "someText" | "Hello World!" |
Przykład odpowiedzi w postaci JSON:
{
"errorCode": null,
"errorMessage": null,
"value": "Hello World!"
}
