MDMS V2 (Master Data Management Service)

Overview

MDMS v2 provides APIs for defining schemas, searching schemas, and adding master data against these defined schemas. All data is now stored in PostgreSQL tables instead of GitHub. MDMS v2 currently also includes v1 search API for fetching data from the database in the same format as MDMS v1 search API to ensure backward compatibility.

Pre-requisites

  1. Prior knowledge of Java/J2EE.

  2. Prior knowledge of Spring Boot.

  3. Prior knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.

  4. Prior knowledge of Git.

  5. Advanced knowledge of operating JSON data would be an added advantage to understanding the service.

Functionalities

  1. Create schema: MDMS v2 introduces functionality to define your schema with all validations and properties supported by JSON schema draft 07. Below is a sample schema definition for your reference -

"SchemaDefinition": {
        "tenantId": "pb",
        "code": "TradeLicense.TradeSubType",
        "description": "Trade sub-type which is a child of Trade type",
        "definition": {
            "$schema": "http://json-schema.org/draft-07/schema#",
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "pattern": "^[A-Za-z]+$"
                },
                "code": {
                    "type": "string"
                },
                "tradeTypeCode": {
                    "type": "string"
                }
            },
            "required": [
                "name",
                "code",
                "tradeTypeCode"
            ],
            "x-unique": [
                "name"
            ],
            "x-ref-schema": [
                {
                    "fieldPath": "tradeTypeCode",
                    "schemaCode": "TradeLicense.TradeType"
                }
            ]
        },
        "isActive": true
    }

To create a basic schema definition, use the following keywords:

  • $schema: specifies which draft of the JSON Schema standard the schema adheres to.

  • title and description: state the intent of the schema. These keywords donโ€™t add any constraints to the data being validated.

  • type: defines the first constraint on the JSON data.

Additionally, we have two keys which are not part of standard JSON schema attributes -

  • x-unique: specifies the fields in the schema utilizing which a unique identifier for each master data will be created.

  • x-ref-schema: specifies referenced data. This is useful in scenarios where the parent-child relationship needs to be established in master data. For example, Trade Type can be a parent master data to Trade Sub Type. In the example above, the field path represents the JsonPath of the attribute in the master data which contains the unique identifier of the parent which is being referenced. Schema code represents the schema under which the referenced master data needs to be validated for existence.

  1. Search schema: MDMS v2 has API to search schema based on the tenantid, schema code, and unique identifier.

  2. Create data: MDMS v2 enables data creation according to the defined schema. Below is an example of data based on the mentioned schema:

"Mdms": {
    "tenantId": "pb",
    "schemaCode": "TradeLicense.TradeSubType",
    "data": {
      "name": "Electronics",
      "code": "ELECTRONICS",
      "tradeTypeCode": "GOODS.MANUFACTURE"
      },
    "isActive": true
} 
  1. Search data: MDMS v2 exposes two search APIs - v1 and v2 search where v1 search API is completely backward compatible.

  2. Update data: MDMS v2 allows the updation of master data fields.

  3. Fallback functionality: Both the search APIs have fallback implemented where if data is not found for a particular tenant, the services fall back to the parent tenant(s) and return the response. If data is not found even for the parent tenant, an empty response is sent to the user.

API Details

  1. /mdms-v2/schema/v1/_create - Takes RequestInfo and SchemaDefinition in the request body. SchemaDefinition has all attributes which define the schema.

  2. /mdms-v2/schema/v1/_search - Takes RequestInfo and SchemaDefSearchCriteria in the request body and returns schemas based on the provided search criteria.

  3. /mdms-v2/v2/_create/{schemaCode} - Takes RequestInfo and Mdms in the request body where the MDMS object has all the information for the master being created and it takes schemaCode as path param to identify the schema against which data is being created.

  4. /mdms-v2/v2/_search - Takes RequestInfo and MdmsCriteria in the request body to return master data based on the provided search criteria. It also has a fallback functionality where if data is not found for the tenant which is sent, the services fall back to the parent tenant(s) to look for the data and return it.

  5. /mdms-v2/v2/_update/{schemaCode} - Takes RequestInfo and Mdms in the request body where the MDMS object has all the information for the master being updated and it takes schemaCode as path param to identify the schema against which data is being updated.

  6. /mdms-v2/v1/_search - This is a backwards-compatible API which takes RequestInfo and MdmsCriteria in the request body to return master data based on the provided search criteria and returns the response in MDMS v1 format. It also has fallback functionality where if data is not found for the tenant which is sent, the services fall back to the parent tenant(s) to look for the data and return it.

Postman Collection

https://api.postman.com/collections/12892142-771842a6-fe9d-4ba7-93ba-2fffdb525055?access_key=PMAT-01H5PA8YTK7H1357VGDQ4YMW7W

Last updated

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.