Testowanie połączenia za pomocą metody Echo

Info

Każda usługa zaimplementowana w systemie Mercury DB (HgDB) 3.0 zawiera metodę echo (żądanie wysyłane metodą 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

Metoda testowania połączenia.

Żądanie metody

Za pomocą poniżej tabeli opisano poszczególne składowe żądania wysyłanego do metody echo za pośrednictwem protokołu REST:

Parametr	Opis	Przykładowa wartość
context	Kontekst żądania, dane sterujące, zobacz opis znajdujący się w artykule Kontekst żądania usług SOAP/REST.	{"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, "requestProperties": {}}
someText	Wartość tekstu, którego wartość powinna zostać zwrócona w odpowiedzi.	Hello World!

Przykład żądania w postaci JSON

{
  "context": {
    "appName": "mercury-ws-app",
    "appVersion": "1.0",
    "userName": "anonymous",
    "comment": null,
    "maxResults": 10000,
    "queryTimeout": 2147483647,
    "locale": "pl_PL",
    "timeZone": "Europe/Warsaw",
    "userFullName": null,
    "eager4omdBuilder": "true",
    "trustedData": false,
    "ignoredCustomFields": null,
    "currentRole": null,
    "userRoles": null,
    "sourceOfRequest": "USER_DEV.localhost",
    "rootVersionContextID": null,
    "rootTagName": null,
    "directRequest": false,
    "formats": {
      "date.format.long": "dd-MM-yyyy HH:mm:ss XXX"
    },
    "ignoreAlternateFields": true,
    "decodeResult": "DATE_AND_LOB",
    "maxDepthResult": 3,
    "decodeRequest": "DATE_AND_LOB",
    "ignoreCaseHeaderInResponse": true,
    "cacheUsage": "REFRESH",
    "httpResponseCacheUsage": "NONE",
    "defaultLuceneSortClause": null,
    "viewDefinition": null
  },
  "someText": "Hello World!"
}

Odpowiedź metody

Za pomocą poniżej tabeli opisano poszczególne składowe odpowiedzi zwracanej przez metodę echo:

Parametr	Opis	Przykładowa wartość
errorCode	Kod błędu. Gdy operacja zakończy się sukcesem, przyjmuje wartość null.	null
errorMessage	Treść komunikatu 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 usługi w postaci JSON

{
   "errorCode": null,
   "errorMessage": null,
   "value": "Hello World!"
}