Typ sprawy - przetwarzanie danych encji TypeCase
W niniejszym artykule zajmiemy się opisem usługi TypeCaseRest. Jest to usługa REST warstwy logicznej, która udostępnia podstawowe metody pobierania i edycji danych z nazwami typów obiektów spraw. Serwis ma swoje odpowiedniki obsługujące protokoły SOAP ITypeCaseAction i Spring Remoting RMI /TypeCaseAction.
https://<nazwa_serwera_hgdb>[:port]/mercury-ws-app/restServices/TypeCaseRest.wadl
Przykład: https://testcluster.hgdb.io/mercury-ws-app/restServices/TypeCaseRest.wadl.
https://<nazwa_serwera_hgdb>[:port]/mercury-ws-app/services/TypeCaseRest?wsdl
Przykład: https://testcluster.hgdb.io/mercury-ws-app/services/TypeCaseRest?wsdl.
Strona jest w budowie i nie zawiera jeszcze wszystkich informacji. Proszę o cierpliwość.
TypeCaseRest - usługa warstwy logicznej. Odpowiada z za przetwarzanie danych wersji typu sprawy TypeCase. Poniżej znajduje się lista dostępnych metod wraz z ich opisami:
Lista metod podstawowych
| Metoda(Metoda HTTP) | Opis | |
|---|---|---|
| ☑️ | echo(POST) | metoda testowa, do weryfikacji połączenia z serwerem usług MercuryDB 3.0 (HgDB). Zobacz artykuł Testowanie połączenia za pomocą Echo. |
| ⬜ | getAllCaseTypes(POST) | zwraca listę ostatnich wersji wszystkich typów zdefiniowanych dla spraw. |
| ⬜ | getAllDocumentTypes(POST) | zwraca listę ostatnich wersji wszystkich typów zdefiniowanych dla dokumentów. |
| ⬜ | filter(POST) | wyszukiwanie obiektów reprezentujących typy spraw na podstawie podanych kryteriów. |
| ⬜ | findAll(POST) | zwraca listę ostatnich wersji wszystkich typów obiektów (spraw oraz dokumentów). |
| ⬜ | findAllBySumControl(POST) | zwraca wersję typów spraw na podstawie kryterium sumy kontrolnej. |
| ⬜ | findAllVersionByTypeCode(POST) | zwraca wszystkie wersje typu sprawy na podstawie kodu typu. |
| ⬜ | findAllVersionByTypeName(POST) | zwraca wszystkie wersje typu sprawy na podstawie nazwy typu. |
| ⬜ | findByIdentity(POST) | zwraca wersję typu sprawy na podstawie identyfikatora. |
| ⬜ | findByIdentityPart(POST) | zwraca wersję typu sprawy na podstawie części identyfikatora. |
| ⬜ | findByKey(POST) | zwraca wersję typu sprawy na podstawie klucza. |
| ⬜ | findByKeyBag(POST) | zwraca wersje typów spraw na podstawie kluczy. |
| ⬜ | findByKindCode(POST) | zwraca wersje typów spraw na podstawie kodu rodzaju typu. |
| ⬜ | findFirst(POST) | pobranie pierwszego obiektu reprezentującego typ sprawy. |
| ⬜ | findLastVersionByTypeCode(POST) | zwraca ostatnią wersję typu sprawy na podstawie kodu typu. |
| ⬜ | findLastVersionByTypeName(POST) | zwraca ostatnią wersję typu sprawy na podstawie nazwy typu. |
| ⬜ | findLatestVersionBySumControl(POST) | zwraca ostatnią wersję typu sprawy na podstawie sumy kontrolnej. |
| ⬜ | insert(POST) | wstawia nowy obiekt reprezentujący typ sprawy. |
| ⬜ | insertBag(POST) | wstawia wiele nowych obiektów reprezentujących typy spraw. |
| ⬜ | remove(POST) | usuwa obiekt reprezentujący typ sprawy. |
| ⬜ | removeBag(POST) | usuwa wiele obiektów reprezentujących typy spraw. |
| ⬜ | update(POST) | aktualizuje obiekt reprezentujący typ sprawy. |
| ⬜ | updateBag(POST) | aktualizuje wiele obiektów reprezentujących typy spraw. |
| ⬜ | loadNameValuePair(POST) | wczytuje parę nazwa-wartość dla typu sprawy. |
| ⬜ | searchNameValuePairByName(POST) | wyszukuje parę nazwa-wartość dla typu sprawy na podstawie nazwy. |
Lista metod dodatkowych
Dodatkowe metody zarządzające synchronizacją typów dokumentów z zewnętrznym repozytorium dokumentów CMIS:
| Metoda(Metoda HTTP) | Opis | |
|---|---|---|
| ⬜ | checkSynchronizationWithCMIS(POST) | sprawdza, czy typy dokumentów są zsynchronizowane z repozytorium CMIS. |
| ⬜ | synchronizationWithCMIS(POST) | synchronizuje typy dokumentów z repozytorium CMIS. |
Lista metod systemowych
Metody wspierające działanie systemu:
| Metoda(Metoda HTTP) | Opis | |
|---|---|---|
| ⬜ | setQueryCacheEnabled(POST) | włącza lub wyłącza pamięć podręczną zapytań dla typów spraw. |
| ⬜ | getSampleCaseHeaderByTypeCode(POST) | zwraca przykładowy nagłówek sprawy na podstawie kodu typu. |
| ⬜ | getSampleCaseHeaderByTypeId(POST) | zwraca przykładowy nagłówek sprawy na podstawie identyfikatora typu. |