Creating data stewardship campaigns and data models through MDM REST API

How to create data stewardship campaigns and data models via REST API

Talend MDM REST API allows you to create the relevant campaign(s) and data stewardship data model(s) in Talend Data Stewardship for an MDM data model.

Talend MDM can be integrated with Talend Data Stewardship to perform integrated matching tasks. In this case, if an MDM data model has one or more match rules attached to it, its relevant campaign(s) and data stewardship data model(s) will be created or updated automatically in Talend Data Stewardship upon its deployment. However, you can choose to create them manually through the REST API.

This article applies to Talend Platform products with MDM 6.4.0 and above.

Create data stewardship campaigns and data models via REST API

Subscription

Create relevant data stewardship data model(s) and campaign(s) for an MDM data model in Talend Data Stewardship.

Request

PUT /talendmdm/services/rest/tds/setup?model={modelName}

Request URL

http://{serverurl}/talendmdm/services/rest/tds/setup?model={modelName}

Query parameters

serverurl: Indicates the URL used to access MDM, including the port.
modelName: Specifies the name of the MDM data model for which you want to create the relevant data stewardship data model(s) and campaign(s) in Talend Data Stewardship.

Headers

Authorization: Basic Authentication scheme.
Header Accept: application/json

Request Body

No content.

Response Body

If the execution is a complete success, the response body will include the names and labels of all relevant data stewardship data model(s) and campaign(s) created in Talend Data Stewardship:

{
  "success": 
 {
    "datamodel": 
    [
      {
         "name": "tmdm_<mdm_data_model_name1>_<entity_name1>"
         "label": "<mdm_data_model_name1> - <entity_name1> - tmdm"
      },
      {
         "name": "tmdm_<mdm_data_model_name1>_<entity_name2>"
         "label": "<mdm_data_model_name1> - <entity_name2> - tmdm"
      }
    ],
    "campaign": 
    [     
      {
         "name": "tmdm-<mdm_data_model_name1>-<entity_name1>"
         "label": "<mdm_data_model_name1> - <entity_name1> - tmdm"
      },
      {
         "name": "tmdm-<mdm_data_model_name1>-<entity_name2>"
         "label": "<mdm_data_model_name1> - <entity_name2> - tmdm"
      }    
    ]
 }
}

If the execution is a partial success, the response body will include the names and labels of relevant data stewardship data model(s) and campaign(s) created successfully, and the names and labels of relevant data stewardship data model(s) or campaign(s) failed to be created and a message indicating the reason why the operation failed:

{
  "success": 
 {
    "datamodel": 
    [
      {
         "name": "tmdm_<mdm_data_model_name1>_<entity_name1>"
         "label": "<mdm_data_model_name1> - <entity_name1> - tmdm"
      },
      {
         "name": "tmdm_<mdm_data_model_name1>_<entity_name2>"
         "label": "<mdm_data_model_name1> - <entity_name2> - tmdm"
      }
    ],
    "campaign": 
    [     
      {
         "name": "tmdm-<mdm_data_model_name1>-<entity_name1>"
         "label": "<mdm_data_model_name1> - <entity_name1> - tmdm"
      },
      {
         "name": "tmdm-<mdm_data_model_name1>-<entity_name2>"
         "label": "<mdm_data_model_name1> - <entity_name2> - tmdm"
      }    
    ]
 },  
  "failure": 
 {
    "datamodel": 
      {
         "name": "tmdm-<mdm_data_model_name1>-<entity_name9>"
         "label": "<mdm_data_model_name1> - <entity_name9> - tmdm"
      },
    "message": "Error message"   
 }
}

Response Code

200 - Indicates that the operation is executed successfully, and the relevant campaign(s) and data stewardship data model(s) are created in Talend Data Stewardship.
401 - Indicates an MDM or Talend Data Stewardship authentication failure.
403 - Indicates that the user is not allowed to create or update the relevant campaign(s) and data stewardship data model(s) in Talend Data Stewardship.
420 - Indicates the failure to process the campaign(s) or the data stewardship data model(s).
500 - Indicates an internal server error.
501 - Indicates that the integration of Talend Data Stewardship with MDM is not configured.