Reference 360 SaaS
- Reference 360 SaaS
- All Products
/rdm-service/external/v3/model/import?isDeltaImport=true&isDeltaUpdateIgnore=true
/rdm-service/external/v3/model/import?isDeltaImport=true&isDeltaUpdateIgnore=false
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 .
|
Field
| Type
| Description
|
|---|---|---|
version
| String
| Version of the export file. Ensure
that the version of the export file is the same as or higher than the
version in the previously imported model. Otherwise, the import fails. |
referenceDataSets
| -
| Includes details about the reference data set.
|
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.
|
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.
|
dictionaries | - | Includes the details of dictionaries configured for the code
list. |
dictionaryConfigurationId | String | Identifier of the dictionary. |
name | String | Name of the dictionary. |
description | String | Description of the dictionary. |
location | String | The project or folder within which the dictionary is
located. |
dataSourceConfiguration | String | Code list attributes that are added as columns in the
dictionary. |
crosswalks
| -
| Details about the crosswalk.
|
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.
|
key
| String
| ID of the system reference data value.
|
label
| String
| Label for the system reference data value.
|
dictionaries | - | Includes the details of dictionary configured for the crosswalk.
|
dictionaryConfigurationId | String | Identifier of the dictionary. |
name | String | Name of the dictionary. |
description | String | Description of the dictionary. |
location | String | The project or folder within which the dictionary is
located. |
dataSourceConfiguration | String | Value mappings of the crosswalk added as columns in the
dictionary. |
hierarchies
| -
| Includes details about the hierarchies.
|
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.
|
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 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":"4.0", "referenceDataSets":[ { "id":"645ab8251c45ce8e99b99daf", "name":"Country", "internalId":"country_int", "alias":"country_als", "description":"desc", "hierarchical":false, "levels":1, "defaultList":"a7d999842c11b52a53865bbe", "codeValueFields":[ { "name":"Name", "labels":[ { "language":"en", "value":"Name" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 } ], "assetStakeholders":{ "stakeholders":[ { } ] } }, { "id":"64089cd1d1cb171040bc679c", "name":"rds2", "description":"desc", "hierarchical":false, "levels":1, "defaultList":"b8f577b04efe19d099fde755", "codeValueFields":[ { "name":"Name", "labels":[ { "language":"en", "value":"Name" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 }, { "name":"fieldDef", "origin":"TERM", "datatype":"Reference", "mandatory":false, "relatedTermId":"645ab8251c45ce8e99b99daf", "displayColumns":[ "name" ], "position":0 } ], "dependencyDef":{ "termId":"645ab8251c45ce8e99b99daf", "displayColumns":[ "name" ] }, "assetStakeholders":{ "stakeholders":[ { } ] } } ], "codeLists":[ { "id":"b4e6823f84eed45eda84b2c1", "termId":"64089cd1d1cb171040bc679c", "name":"SapCountry", "description":"desc", "hierarchical":false, "codeValueFields":[ { "name":"Name", "labels":[ { "language":"en", "value":"Name" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 } ], "assetWorkflowConfiguration":{ "assetApiWorkFlowEnabled":false, "assetWorkFlowTasks":[ { "taskName":"TestTaskSendback", "taskAction":{ "approve":"REQUIRED", "reject":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup2" } ] } }, { "taskName":"TestTaskReject", "taskAction":{ "approve":"OPTIONAL", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup1" } ] } }, { "taskName":"TestTakApprove", "taskAction":{ "approve":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup" } ] } } ] }, "rdsName":"rds2", "dqValidationInfo":{ "enabled":false }, "assetStakeholders":{ "stakeholders":[ { } ] } }, { "id":"d36800d6fcf20b4b91a20f0e", "termId":"645ab8251c45ce8e99b99daf", "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":0 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 } ], "businessIdDef":{ "type":"ALPHANUMERIC", "prefix":"RDM", "length":10, "label":"modelExportBusinessId" }, "assetWorkflowConfiguration":{ "assetApiWorkFlowEnabled":false, "assetWorkFlowTasks":[ { "taskName":"TestTaskSendback", "taskAction":{ "approve":"REQUIRED", "reject":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup2" } ] } }, { "taskName":"TestTaskReject", "taskAction":{ "approve":"OPTIONAL", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup1" } ] } }, { "taskName":"TestTakApprove", "taskAction":{ "approve":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup" } ] } } ] }, "rdsName":"Country", "dqRulesFrsLocation":{ "5sciIEK0QBKftMdqHqTCeT":{ "name":"RuleSpecName", "project":"Default", "folder":"ExampleFolder" } }, "dictionaries":{ "entries":[ { "dictionaryConfigurationId":"5fe35898fe9c74f150c6ef0d_b3c4d798_533b7e98-acd9-4018-9835-dc47ff5d7e65", "details":{ "name":"modelExportCodeListDictionary", "description":"modelExportCodeListDictionaryDesc" }, "frsReference":{ "name":"modelExportCodeListDictionary", "location":{ "name":"reference360", "type":"Project", "path":[ { "frsName":"reference360", "frsType":"Project" } ] } }, "dataSourceConfiguration":{ "sourceAttributeReferences":[ { "attributeName":"Name" }, { "attributeName":"Code" } ] } } ] }, "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, "executeRuleForEmptyFields":false } ] } ], "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, "ruleInputFields":[ { "accessPath":{ "eclass":"http://informatica.com/mdm/v2/Core#//AccessPath", "pathElements":[ { "$ref":"//@field[name='Name']" } ] }, "ruleFieldName":"value", "downgradeTrustScorePercentage":100 } ], "ruleOutputFields":[ ] } ], "eClass":"http://informatica.com/mdm/v1/DQI#//DQRuleValidationConfig" }, "enabled":false }, "assetStakeholders":{ "stakeholders":[ { } ] } }, { "id":"72b0c8aee6ffc2bbbffb97b5", "termId":"64089cd1d1cb171040bc679c", "name":"IsoCountry", "description":"desc", "hierarchical":false, "codeValueFields":[ { "name":"Name", "labels":[ { "language":"en", "value":"Name" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true, "position":0 } ], "assetWorkflowConfiguration":{ "assetApiWorkFlowEnabled":false, "assetWorkFlowTasks":[ { "taskName":"TestTaskSendback", "taskAction":{ "approve":"REQUIRED", "reject":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup2" } ] } }, { "taskName":"TestTaskReject", "taskAction":{ "approve":"OPTIONAL", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup1" } ] } }, { "taskName":"TestTakApprove", "taskAction":{ "approve":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup" } ] } } ] }, "rdsName":"rds2", "dqValidationInfo":{ "enabled":false }, "assetStakeholders":{ "stakeholders":[ { } ] } } ], "crosswalks":[ { "id":"368254d346efa33958e38575", "internalId":"cw_int", "alias":"cw_als", "description":"description", "status":"status", "sourceCodelistId":"72b0c8aee6ffc2bbbffb97b5", "targetCodelistId":"b4e6823f84eed45eda84b2c1", "dictionaries":{ "entries":[ { "dictionaryConfigurationId":"5fe35898fe9c74f150c6ef0d_b3c4d798-b514-4d4d-a909-ca0b148343fd", "details":{ "name":"modelExportCrosswalkDictionary", "description":"modelExportCodeListDictionaryDesc" }, "frsReference":{ "name":"modelExportCrosswalkDictionary", "location":{ "name":"reference360", "type":"Project", "path":[ { "frsName":"reference360", "frsType":"Project" } ] } }, "dataSourceConfiguration":{ "sourceAttributeReferences":[ { "attributeName":"Code", "sourceAttributeAssetIdentity":{ "id":"72b0c8aee6ffc2bbbffb97b5", "assetType":"CODELIST" } }, { "attributeName":"Code", "sourceAttributeAssetIdentity":{ "id":"b4e6823f84eed45eda84b2c1", "assetType":"CODELIST" } } ] } } ] }, "assetStakeholders":{ "stakeholders":[ { } ] } } ], "enums":{ "application":[ { "key":"CRM", "label":"CRM" } ] }, "hierarchies":[ { "id":"4cde04c990465a2efa8a7e8b", "name":"hierarchy1", "internalId":"hierarchy1_int", "alias":"hierarchy1_als", "description":"hierarchy1 desc", "codeListRelations":{ "relations":[ { "parent":{ "codeListId":"72b0c8aee6ffc2bbbffb97b5", "codeListName":"IsoCountry", "termId":"64089cd1d1cb171040bc679c", "termName":"rds2" }, "child":{ "codeListId":"d36800d6fcf20b4b91a20f0e", "codeListName":"rds1_cl1_name", "codeListInternalId":"rds1_cl1_int", "termId":"645ab8251c45ce8e99b99daf", "termName":"Country" } } ] }, "stakeholderAssignments":{ "stakeholders":[ { "subject":{ "name":"rdmUserGroup", "type":"USERGROUP" } } ] }, "assetWorkflowConfiguration":{ "assetApiWorkFlowEnabled":false, "assetWorkFlowTasks":[ { "taskName":"TestTaskSendback", "taskType":"REVIEW", "taskAction":{ "approve":"REQUIRED", "reject":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup2" } ] } }, { "taskName":"TestTaskReject", "taskType":"REVIEW", "taskAction":{ "approve":"OPTIONAL", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup1" } ] } }, { "taskName":"TestTakApprove", "taskType":"FINAL", "taskAction":{ "approve":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "userGroups":[ { "name":"testgroup" } ] } } ] } } ] }
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" }