Reference 360

Back Next

Import model for adding new assets and updating existing assets

Imports new assets from a previously exported model and updates the existing assets based on internal ID or alias. The import model API runs an import model job.

The import model REST API uses the identifiers of assets in a sequence. For more information about using identifiers to import assets, see Migrating reference data assets.

POST request

To import only new assets from a previously exported model based on internal ID or alias, submit a POST request with the following URI:

/rdm-service/external/v3/model/import?isDeltaImport=true&isDeltaUpdateIgnore=true

To import new assets from a previously exported model and update the existing assets, submit a POST request with the following URI:

/rdm-service/external/v3/model/import?isDeltaImport=true&isDeltaUpdateIgnore=false

Ensure that you use the response from the export model API as the request for the import model API. If you manually modify the exported model, the import process might fail.

The following table describes the parameter in the request:

Parameter	Description
isDeltaImport	Indicates whether to import only the new assets. Value can be true or false . Default is true .
isDeltaUpdateIgnore	Indicates whether to ignore updating the existing assets. Value can be true or false . Default is false .
isAsyncImport	Indicates whether to run an asynchronous job to import the assets. Value can be true or false . Default is true .

The import model accepts only a JSON request body up to 5 MB in size.

The request contains the attributes that the export model API returns. For more information, see Export model.

The following table describes the attributes in the request:

Field	Type	Description
version	String	Version of the export file.
referenceDataSets	-	Includes details about the reference data set.
id	String	IDs of the reference data sets. For more information, see Asset IDs.
name	String	Name of the asset.
description	String	Description of the asset.
hierarchical	Boolean	Indicates whether code lists in the reference data set inherit the hierarchical structure definition.
levels	Number	Optional. The number of hierarchical levels supported in the code lists associated with the reference data set. If hierarchical levels are not provided, the value is 1 . If hierarchical levels are unlimited, the value is -1 .
internalId	String	Internal ID of the reference data set.
alias	String	Alias of the reference data set.
defaultList	String	ID of the default code list.
domain	String	Optional. Domain of the asset.
confidentiality	String	Optional. Confidentiality of the asset.
priority	String	Optional. Priority of the asset.
status	String	Optional. Status of the asset.
codeValueFields	-	Includes the attribute definition for code values in the reference data set.
name	String	Name of the field.
origin	String	Origin of the definition of the field.
datatype	String	Datatype of the field. Values are String , Integer , Decimal , Boolean , Date , or Reference Data .
mandatory	Boolean	Indicates whether the attribute is required.
dependencyDef	-	Includes the definition of the asset specified as the dependency.
termId	String	ID of the asset specified as the dependency.
assetStakeholders	-	Stakeholders associated with the asset.
codeLists	-	Includes details about the code list.
id	String	ID of the code lists. For more information, see Asset IDs.
termId	String	ID of the reference data set to which the code list is associated.
name	String	Name of the code list.
internalId	String	Internal ID of the code list.
alias	String	Alias of the code list.
description	String	Description of the code list.
hierarchical	Boolean	Indicates whether code lists in the reference data set inherit the hierarchical structure definition.
levels	Number	Number of hierarchical levels supported in the code lists associated with the reference data set. If hierarchical levels are not provided, value is 1 . If hierarchical levels are unlimited, value is -1 .
codeValueFields	-	Includes the attribute definition for code values in the reference data set.
name	String	Name of the field.
origin	String	Origin of the definition of the field.
datatype	String	Datatype of the field. Values are String , Integer , Decimal , Boolean , Date , or Reference Data .
mandatory	Boolean	Indicates whether the attribute is required.
dependencyDef	-	Includes the definition of the asset specified as the dependency.
termId	String	ID of the asset specified as the dependency.
displayColumns	Array	Display columns used as labels for code values associated with the dependent asset.
dqValidationInfo	-	Includes details about the basic and advanced rule associations of code list attributes.
assetStakeholders	-	Stakeholders associated to the asset.
assetWorkflowConfiguration	-	Workflow configuration of the asset.
crosswalks	-	Details about the crosswalk.
id	String	ID of the crosswalk. For more information, see Asset IDs.
internalId	String	Internal ID of the crosswalk.
alias	String	Alias of the crosswalk.
description	String	Description of the crosswalk.
status	String	Status of the crosswalk.
sourceCodelistId	String	ID of the source code list to which the crosswalk is associated.
targetCodelistId	String	ID of the target code list.
assetStakeholders	-	Stakeholders associated to the asset.
enums	-	Includes details about enum groups and entries. For more information, see enums.
key	String	ID of the system reference data value.
label	String	Label for the system reference data value.
hierarchies	-	Includes details about the hierarchies.
id	String	ID of the hierarchy. For more information, see Asset IDs.
name	String	Name of the field.
internalId	String	Internal ID of the hierarchy.
alias	String	Alias of the hierarchy.
description	String	Description of the hierarchy.
codeListRelations	-	Code list relations defined by the hierarchies.

POST response

The response contains a detailed report about the import process.

The following table describes the attributes in the response body:

Field	Type	Description
jobId	String	The ID of the import model job.
status	String	Status of the import model job. Value can be RUNNING , SUCCESS , FAILED , or CANCELLED .
type	String	Type of the import model job.
createdBy	String	User name of the user who started the import process.
createdDate	String	Date when the user ran the import model job.

POST example

The following sample request imports only the new assets and skips the existing assets:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v3/model/import?isDeltaImport=true&isDeltaUpdateIgnore=true HTTP/1.1
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
  "version": "3.9",
  "referenceDataSets": [
    {
      "id": "fddde0de9f7740721d3ac264",
      "name": "Country",
      "description": "desc",
      "hierarchical": false,
      "levels": 1,
      "internalId": "country_int",
      "alias": "country_als",
      "defaultList": "be82a1de2bc0fbd095249478",
      "codeValueFields": [
        {
          "name": "Name",
          "labels": [
            {
              "language": "en",
              "value": "Name"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 1
        },
        {
          "name": "Code",
          "labels": [
            {
              "language": "en",
              "value": "Code"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 2
        }
      ],
      "assetStakeholders": {
        "stakeholders": [
          {}
        ]
      }
    },
    {
      "id": "aaa97c7034473568b09d65f7",
      "name": "rds2",
      "description": "desc",
      "hierarchical": false,
      "levels": 1,
      "defaultList": "51cf12512e6fa0602c4fe438",
      "codeValueFields": [
        {
          "name": "Name",
          "labels": [
            {
              "language": "en",
              "value": "Name"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 1
        },
        {
          "name": "Code",
          "labels": [
            {
              "language": "en",
              "value": "Code"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 2
        },
        {
          "name": "fieldDef",
          "labels": [
            {
              "language": "en",
              "value": "fieldDef"
            }
          ],
          "origin": "TERM",
          "datatype": "Reference",
          "mandatory": false,
          "relatedTermId": "fddde0de9f7740721d3ac264",
          "displayColumns": [
            "Name"
          ]
        }
      ],
      "dependencyDef": {
        "termId": "fddde0de9f7740721d3ac264",
        "displayColumns": [
          "Name"
        ]
      },
      "assetStakeholders": {
        "stakeholders": [
          {}
        ]
      }
    }
  ],
  "codeLists": [
    {
      "id": "db73317aab6d239460fdac9f",
      "termId": "fddde0de9f7740721d3ac264",
      "name": "rds1_cl1_name",
      "internalId": "rds1_cl1_int",
      "alias": "rds1_cl1_als",
      "description": "desc",
      "hierarchical": false,
      "codeValueFields": [
        {
          "name": "Name",
          "labels": [
            {
              "language": "en",
              "value": "Name"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 1
        },
        {
          "name": "Code",
          "labels": [
            {
              "language": "en",
              "value": "Code"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 2
        }
      ],
      "assetWorkflowConfiguration": {
        "assetApiWorkFlowEnabled": false,
        "assetWorkFlowTasks": [
          {
            "taskName": "TestTaskSendback",
            "taskAction": {
              "approve": "REQUIRED",
              "reject": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup2"
                }
              ]
            }
          },
          {
            "taskName": "TestTaskReject",
            "taskAction": {
              "approve": "OPTIONAL",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup1"
                }
              ]
            }
          },
          {
            "taskName": "TestTakApprove",
            "taskAction": {
              "approve": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup"
                }
              ]
            }
          }
        ]
      },
      "rdsName": "Country",
      "dqRulesFrsLocation": {
        "5sciIEK0QBKftMdqHqTCeT": {
          "name": "RuleSpecName",
          "project": "Default",
          "folder": "ExampleFolder"
        }
      },
      "dqValidationInfo": {
        "validationConfiguration": {
          "dqLightWeightRuleAssociations": [
            {
              "eClass": "http://informatica.com/mdm/v1/DQI#//DQLightWeightRuleAssociation",
              "associatedFieldName": {
                "$ref": "//@field[name='Name']"
              },
              "dqLightWeightRules": [
                {
                  "eClass": "http://informatica.com/mdm/v1/DQI#//DQLightWeightRuleConfiguration",
                  "description": "Minimum Length",
                  "validationMessage": "Enter a minimum of 3 characters.",
                  "downgradeTrustScorePercentage": 100,
                  "errorSeverity": "INFO",
                  "dqRuleName": "Minimum Length",
                  "dqLightWeightRuleId": "MIN_LENGTH",
                  "dqLightWeightRuleParameters": "[{\"min\":3}]",
                  "isEnabled": true
                }
              ]
            }
          ],
          "dqRuleAssociations": [
            {
              "ruleId": "5sciIEK0QBKftMdqHqTCeT",
              "statusField": "Validation",
              "statusCode": "Valid number",
              "statusMessageField": "Validation",
              "validationMessage": "",
              "errorSeverity": "ERROR",
              "associatedFieldName": {
                "$ref": "//@field[name='Name']"
              },
              "id": "Validation_AlternateIdentifier",
              "dqRuleName": "Validation_AlternateIdentifier",
              "description": "Validate if the alternate identifier has a valid format",
              "isEnabled": true,
              "ruleOutputFields": [],
              "ruleInputFields": [
                {
                  "accessPath": {
                    "eclass": "http://informatica.com/mdm/v2/Core#//AccessPath",
                    "pathElements": [
                      {
                        "$ref": "//@field[name='Name']"
                      }
                    ]
                  },
                  "ruleFieldName": "value",
                  "downgradeTrustScorePercentage": 100
                }
              ]
            }
          ],
          "eClass": "http://informatica.com/mdm/v1/DQI#//DQRuleValidationConfig"
        },
        "enabled": false
      },
      "assetStakeholders": {
        "stakeholders": [
          {}
        ]
      }
    },
    {
      "id": "fb4c079c4d8376e03f72a73a",
      "termId": "aaa97c7034473568b09d65f7",
      "name": "SapCountry",
      "description": "desc",
      "hierarchical": false,
      "codeValueFields": [
        {
          "name": "Name",
          "labels": [
            {
              "language": "en",
              "value": "Name"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 1
        },
        {
          "name": "Code",
          "labels": [
            {
              "language": "en",
              "value": "Code"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 2
        }
      ],
      "assetWorkflowConfiguration": {
        "assetApiWorkFlowEnabled": false,
        "assetWorkFlowTasks": [
          {
            "taskName": "TestTaskSendback",
            "taskAction": {
              "approve": "REQUIRED",
              "reject": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup2"
                }
              ]
            }
          },
          {
            "taskName": "TestTaskReject",
            "taskAction": {
              "approve": "OPTIONAL",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup1"
                }
              ]
            }
          },
          {
            "taskName": "TestTakApprove",
            "taskAction": {
              "approve": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup"
                }
              ]
            }
          }
        ]
      },
      "rdsName": "rds2",
      "dqValidationInfo": {
        "enabled": false
      },
      "assetStakeholders": {
        "stakeholders": [
          {}
        ]
      }
    },
    {
      "id": "71e94e4b43e146edb370461a",
      "termId": "aaa97c7034473568b09d65f7",
      "name": "IsoCountry",
      "description": "desc",
      "hierarchical": false,
      "codeValueFields": [
        {
          "name": "Name",
          "labels": [
            {
              "language": "en",
              "value": "Name"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 1
        },
        {
          "name": "Code",
          "labels": [
            {
              "language": "en",
              "value": "Code"
            }
          ],
          "origin": "TERM",
          "datatype": "String",
          "mandatory": true
          "position": 2
        }
      ],
      "assetWorkflowConfiguration": {
        "assetApiWorkFlowEnabled": false,
        "assetWorkFlowTasks": [
          {
            "taskName": "TestTaskSendback",
            "taskAction": {
              "approve": "REQUIRED",
              "reject": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup2"
                }
              ]
            }
          },
          {
            "taskName": "TestTaskReject",
            "taskAction": {
              "approve": "OPTIONAL",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup1"
                }
              ]
            }
          },
          {
            "taskName": "TestTakApprove",
            "taskAction": {
              "approve": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup"
                }
              ]
            }
          }
        ]
      },
      "rdsName": "rds2",
      "dqValidationInfo": {
        "enabled": false
      },
      "assetStakeholders": {
        "stakeholders": [
          {}
        ]
      }
    }
  ],
  "crosswalks": [
    {
      "id": "c984c9006ec3b492c2395e1a",
      "internalId": "cw_int",
      "alias": "cw_als",
      "description": "description",
      "status": "status",
      "sourceCodelistId": "71e94e4b43e146edb370461a",
      "targetCodelistId": "fb4c079c4d8376e03f72a73a",
      "assetStakeholders": {
        "stakeholders": [
          {}
        ]
      },
      "assetWorkflowConfiguration": {
        "assetApiWorkFlowEnabled": false,
        "assetWorkFlowTasks": [
          {
            "taskName": "TestTaskSendback",
            "taskAction": {
              "approve": "REQUIRED",
              "reject": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup2"
                }
              ]
            }
          },
          {
            "taskName": "TestTaskReject",
            "taskAction": {
              "approve": "OPTIONAL",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup1"
                }
              ]
            }
          },
          {
            "taskName": "TestTakApprove",
            "taskAction": {
              "approve": "REQUIRED",
              "sendBack": "REQUIRED"
            },
            "approvers": {
              "users": [],
              "userGroups": [
                {
                  "name": "testgroup"
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "enums": {
    "application": [
      {
        "key": "CRM",
        "label": "CRM"
      }
    ]
  },
  "hierarchies": [
    {
      "id": "hierarchy1",
      "name": "hierarchy1",
      "internalId": "hierarchy1_int",
      "alias": "hierarchy1_als",
      "description": "hierarchy1 desc",
      "codeListRelations": {
        "relations": [
          {
            "parent": {
              "codeListId": "71e94e4b43e146edb370461a",
              "codeListName": "IsoCountry",
              "termId": "aaa97c7034473568b09d65f7",
              "termName": "rds2"
            },
            "child": {
              "codeListId": "db73317aab6d239460fdac9f",
              "codeListName": "rds1_cl1_name",
              "codeListInternalId": "rds1_cl1_int",
              "termId": "fddde0de9f7740721d3ac264",
              "termName": "Country"
            }
          }
        ]
      },
      "stakeholderAssignments": {
        "stakeholders": [
          {
            "subject": {
              "name": "rdmUserGroup",
              "type": "USERGROUP"
            }
          }
        ]
      }
    }
  ]
}

To arrange an attribute in a specific order, place the attribute and its parameters in the desired location within the attributes list.

The following sample response shows the job ID and status of the import process:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 3436

{
   "jobId":"5247b0161e5a1c4fab80b746",
   "type":"MODEL_IMPORT",
   "status":"RUNNING",
   "createdBy":"userId",
   "createdDate":"2023-01-25T09:54:09.213+00:00"
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Import model for adding new assets and updating existing assets

Import model for adding new assets and updating existing assets

POST request

POST response

POST example