Case type code - processing TypeCode entity data
In this article, we will discuss the description of the TypeCodeRest service. It is a REST service of the logical layer that provides basic methods for retrieving and editing data with the names of case object types. The service has its equivalents supporting the SOAP protocols ITypeCodeAction and Spring Remoting RMI /TypeCodeAction.
https://<hgdb_server_name>[:port]/mercury-ws-app/restServices/TypeCodeRest.wadl
Example: https://testcluster.hgdb.io/mercury-ws-app/restServices/TypeCodeRest.wadl.
https://<hgdb_server_name>[:port]/mercury-ws-app/services/TypeCodeRest?wsdl
Example: https://testcluster.hgdb.io/mercury-ws-app/services/TypeCodeRest?wsdl.
The page is under construction and does not contain all the information yet. Please be patient.
TypeCodeRest - logical layer service. Responsible for retrieving and updating the TypeCode object. Below is a list of available methods with their descriptions:
| Method(HTTP Method) | Description | |
|---|---|---|
| ☑️ | echo(POST) | test method, to verify the connection to the MercuryDB 3.0 (HgDB) service server. See the article Testing the connection with Echo. |
| ⬜ | filter(POST) | search for objects representing object type codes based on the given criteria. |
| ⬜ | findAll(POST) | retrieve all objects representing object type codes (cases and documents). |
| ⬜ | findAllCaseTypeCodes(POST) | retrieve all objects representing stored case type codes. |
| ⬜ | findAllDocumentTypeCodes(POST) | retrieve all objects representing stored document type codes. |
| ⬜ | findByKey(POST) | retrieve an object representing the object type code of a case or document based on the key. |
| ⬜ | findByKeyBag(POST) | retrieve objects representing case or document object type codes based on keys. |
| ⬜ | findByKindCode(POST) | retrieve objects representing case or document object type codes based on type code. |
| ⬜ | findFirst(POST) | retrieve first object representing case object type code. |
| ⬜ | insert(POST) | insert new object representing case or document object type code. |
| ⬜ | insertBag(POST) | insert multiple new objects representing case or document object type codes. |
| ⬜ | remove(POST) | remove object representing case or document object type code. |
| ⬜ | removeBag(POST) | remove multiple objects representing case or document object type codes. |
| ⬜ | update(POST) | update object representing case or document object type code. |
| ⬜ | updateBag(POST) | update multiple objects representing case or document object type codes. |
| ⬜ | loadNameValuePair(POST) | load a name-value pair for a case or document object type code. |
| ⬜ | searchNameValuePairByName(POST) | search for a name-value pair for an object type code based on name. |