/rdm-service/external/v3/model/export
Field
| Type
| Description
|
---|---|---|
referenceDataSetIds
| Array
| Comma-separated list of IDs of reference data sets to export. If you don't specify IDs, all reference data sets are exported.
You can find the ID of assets in
Reference 360 or use REST APIs to retrieve the IDs. For more information, see
Asset IDs.
|
hierarchyIds
| Array
| Comma-separated list of IDs of hierarchies to export. If you don't specify IDs, all hierarchies are exported.
You can find the ID of assets in
Reference 360 or use REST APIs to retrieve the IDs. For more information, see
Asset IDs.
|
Field
| Type
| Description
|
---|---|---|
version
| String
| Version of the export file.
|
referenceDataSets
| -
| Includes details about the reference data set.
|
id
| String
| ID 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
| 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 .
|
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 to 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 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
| 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.
|
businessIdDef
| -
| Optional. Includes the details of the business IDs configured for the code values.
|
type
| String
| Format in which the business IDs are generated. Values are
NUMERIC or
ALPHANUMERIC.
|
prefix
| String
| Characters added to the beginning of business IDs. Values are
NUMERIC or
ALPHANUMERIC.
|
length
| Number
| Total length of the business IDs.
|
offset
| String
| Starting value for the business IDs that Reference 360 generates. Applicable for numeric business IDs.
|
label
| String
| Display name for the business ID field.
|
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 crosswalks. For more information, see
Asset IDs.
|
description
| String
| Description of the asset.
|
status
| String
| Status of the asset.
|
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.
|
key
| String
| ID of the system reference data value.
|
label
| String
| Label for the system reference data value.
|
hierarchies
| -
| Includes details about the hierarchies.
|
codeListRelations
| -
| Code list relations defined by the hierarchies.
|
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v3/model/export HTTP/1.1 Content-Type: application/json Accept: application/json IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX { "referenceDataSetIds":[ "fddde0de9f7740721d3ac264", "aaa97c7034473568b09d65f7" ], "hierarchyIds":[ "hierarchy1" ] }
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 6076 { "version": "3.9", "referenceDataSets": [ { "id": "645ab8251c45ce8e99b99daf", "name": "Country", "description": "desc", "hierarchical": false, "levels": 1, "defaultList": "a7d999842c11b52a53865bbe", "codeValueFields": [ { "name": "Name", "labels": [ { "language": "en", "value": "Name" } ], "origin": "TERM", "datatype": "String", "mandatory": true }, { "name": "Code", "labels": [ { "language": "en", "value": "Code" } ], "origin": "TERM", "datatype": "String", "mandatory": true } ], "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 }, { "name": "Code", "labels": [ { "language": "en", "value": "Code" } ], "origin": "TERM", "datatype": "String", "mandatory": true }, { "name": "fieldDef", "origin": "TERM", "datatype": "Reference", "mandatory": false, "relatedTermId": "645ab8251c45ce8e99b99daf", "displayColumns": [ "name" ] } ], "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 }, { "name": "Code", "labels": [ { "language": "en", "value": "Code" } ], "origin": "TERM", "datatype": "String", "mandatory": true } ], "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", "description": "desc", "hierarchical": false, "codeValueFields": [ { "name": "Name", "labels": [ { "language": "en", "value": "Name" } ], "origin": "TERM", "datatype": "String", "mandatory": true }, { "name": "Code", "labels": [ { "language": "en", "value": "Code" } ], "origin": "TERM", "datatype": "String", "mandatory": true } ], "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" } }, "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, "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 }, { "name": "Code", "labels": [ { "language": "en", "value": "Code" } ], "origin": "TERM", "datatype": "String", "mandatory": true } ], "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", "description": "description", "status": "status", "sourceCodelistId": "72b0c8aee6ffc2bbbffb97b5", "targetCodelistId": "b4e6823f84eed45eda84b2c1", "assetStakeholders": { "stakeholders": [ {} ] } } ], "enums": { "application": [ { "key": "CRM", "label": "CRM" } ] }, "hierarchies": [ { "id": "4cde04c990465a2efa8a7e8b", "name": "hierarchy1", "description": "hierarchy1 desc", "codeListRelations": { "relations": [ { "parent": { "codeListId": "72b0c8aee6ffc2bbbffb97b5", "codeListName": "IsoCountry", "termId": "64089cd1d1cb171040bc679c", "termName": "rds2" }, "child": { "codeListId": "d36800d6fcf20b4b91a20f0e", "codeListName": "rds1_cl1_name", "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" } ] } } ] } } ] }