Type case - processing TypeCase entity data
In this article, we will describe the TypeCaseRest 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 ITypeCaseAction and Spring Remoting RMI /TypeCaseAction.
https://<hgdb_server_name>[:port]/mercury-ws-app/restServices/TypeCaseRest.wadl
Example: https://testcluster.hgdb.io/mercury-ws-app/restServices/TypeCaseRest.wadl.
https://<hgdb_server_name>[:port]/mercury-ws-app/services/TypeCaseRest?wsdl
Example: https://testcluster.hgdb.io/mercury-ws-app/services/TypeCaseRest?wsdl.
The page is under construction and does not contain all the information yet. Please be patient.
TypeCaseRest - logical layer service. Responsible for processing case type version data TypeCase. Below is a list of available methods and their descriptions:
List of basic methods
| 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. |
| ⬜ | getAllCaseTypes(POST) | returns a list of the latest versions of all types defined for cases. |
| ⬜ | getAllDocumentTypes(POST) | returns a list of the latest versions of all types defined for documents. |
| ⬜ | filter(POST) | searches for objects representing case types based on the given criteria. |
| ⬜ | findAll(POST) | returns a list of the latest versions of all object types (cases and documents). |
| ⬜ | findAllBySumControl(POST) | returns the version of case types based on the checksum criterion. |
| ⬜ | findAllVersionByTypeCode(POST) | returns all versions of a case type based on its type code. |
| ⬜ | findAllVersionByTypeName(POST) | returns all versions of a case type based on its type name. |
| ⬜ | findByIdentity(POST) | returns a version of a case type based on its identifier. |
| ⬜ | findByIdentityPart(POST) | returns a version of a case type based on its identifier part. |
| ⬜ | findByKey(POST) | returns a version of a case type based on its key. |
| ⬜ | findByKeyBag(POST) | returns versions of case types based on its keys. |
| ⬜ | findByKindCode(POST) | returns versions of case types based on its type code. |
| ⬜ | findFirst(POST) | retrieves the first object representing a case type. |
| ⬜ | findLastVersionByTypeCode(POST) | returns the latest version of a case type based on its type code. |
| ⬜ | findLastVersionByTypeName(POST) | returns the latest version of a case type based on its type name. |
| ⬜ | findLatestVersionBySumControl(POST) | returns the latest version of a case type based on its checksum. |
| ⬜ | insert(POST) | inserts a new case type object. |
| ⬜ | insertBag(POST) | inserts multiple new case type objects. |
| ⬜ | remove(POST) | removes a case type object. |
| ⬜ | removeBag(POST) | removes multiple case type objects. |
| ⬜ | update(POST) | updates a case type object. |
| ⬜ | updateBag(POST) | updates multiple objects representing issue types. |
| ⬜ | loadNameValuePair(POST) | loads a name-value pair for an issue type. |
| ⬜ | searchNameValuePairByName(POST) | searches for a name-value pair for an issue type by name. |
List of additional methods
Additional methods that manage document type synchronization with an external CMIS document repository:
| Method(HTTP Method) | Description | |
|---|---|---|
| ⬜ | checkSynchronizationWithCMIS(POST) | checks whether document types are synchronized with the CMIS repository. |
| ⬜ | synchronizationWithCMIS(POST) | synchronizes document types with the CMIS repository. |
List of system methods
Methods supporting system operation:
| Method(HTTP Method) | Description | |
|---|---|---|
| ⬜ | setQueryCacheEnabled(POST) | enables or disables query cache for case types. |
| ⬜ | getSampleCaseHeaderByTypeCode(POST) | returns a sample case header based on the type code. |
| ⬜ | getSampleCaseHeaderByTypeId(POST) | returns a sample case header based on the type identifier. |