Skip to main content

Loading metadata

Info

Metadata retrieval services can be used to build applications presenting data stored in Mercury DB (HgDB) 3.0 (see the description of Mercury Portal 2.0). They can also be used to build a query builder.

You can read about how metadata is stored in the article describing the architecture: Case metadata. In this article, we will focus on describing the most important services and methods responsible for their retrieval and update. These services are available in the logical layer of the Mercury DB (HgDB) 3.0 application. They can be used to build a GUI that allows for the generation and definition (building) of case object types. Since metadata entities also contain information about the way forms are presented, colors, iconography, etc., they can be used to build applications presenting data stored in Mercury DB (HgDB) 3.0 (see the description of Mercury Portal 2.0).

  • TypeCodeRest - REST service of the logical layer, a set of basic methods for retrieving and editing data with the names of case object types. The service has its counterparts supporting the SOAP ITypeCodeAction and Spring Remoting RMI /TypeCodeAction protocols.
Info
Endpoint is available at:
https://<server_name>:<port>/mercury-ws-app/rest/service/TypeCodeRest
WADL is available at:
https://<server_name>:<port>/mercury-ws-app/restServices/TypeCodeRest.wadl

where:

  • <server_name> - name of the server on which the Mercury DB (HgDB) 3.0 application is installed,
  • <port> - port on which the Mercury DB (HgDB) 3.0 application listens (by default it is port 8080).

Example: https://testcluster.hgdb.io/mercury-ws-app/restServices/TypeCodeRest.wadl

  • TypeCaseRest - REST service of the logical layer, a set of basic methods for retrieving and editing all versions of object metadata. The service has its counterparts supporting the SOAP protocols ITypeCaseAction and Spring Remoting RMI /TypeCaseAction.
Info
Endpoint is available at:
https://<server_name>:<port>/mercury-ws-app/rest/service/TypeCaseRest
WADL is available at:
https://<server_name>:<port>/mercury-ws-app/restServices/TypeCaseRest.wadl

where:

  • <server_name> - name of the server on which the Mercury DB (HgDB) 3.0 application is installed,
  • <port> - port on which the Mercury DB (HgDB) 3.0 application is listening (by default it is port 8080).

Example: https://testcluster.hgdb.io/mercury-ws-app/restServices/TypeCaseRest.wadl

  • TypeCodeWithLastVersionBusinessRest - REST service of the business layer, a set of basic methods for retrieving and editing metadata of case objects in the latest version (metadata description may change, services present their latest form). The service has its counterparts supporting SOAP protocols ITypeCodeWithLastVersionBusinessAction and Spring Remoting RMI /TypeCodeWithLastVersionBusinessAction.
Info
Endpoint is available at:
https://<server_name>:<port>/mercury-ws-app/rest/service/TypeCodeWithLastVersionBusinessRest
WADL is available at:
https://<server_name>:<port>/mercury-ws-app/restServices/TypeCodeWithLastVersionBusinessRest.wadl

where:

  • <server_name> - name of the server on which the Mercury DB (HgDB) 3.0 application is installed,
  • <port> - port on which the Mercury DB (HgDB) 3.0 application listens (by default it is port 8080).

Example: https://testcluster.hgdb.io/mercury-ws-app/restServices/TypeCodeWithLastVersionBusinessRest.wadl