Table of Contents

Search

  1. Preface
  2. Introducing Reference 360
  3. Getting started with Reference 360
  4. Manage system reference data
  5. Manage reference data sets
  6. Manage code lists
  7. Manage code values
  8. Manage crosswalks
  9. Import data
  10. Manage hierarchies
  11. Manage attributes
  12. Manage workflows
  13. Manage jobs
  14. Reference 360 REST API
  15. Glossary

Reference 360

Reference 360

Export model

Export model

Exports the reference data sets and hierarchies.
When you create a crosswalk between code lists of different reference data sets, if you don't specify the IDs of the source and target reference data sets, the crosswalk export fails without a warning message.

POST request

To export the reference data sets and hierarchies, submit a POST request with the following URI:
/rdm-service/external/v3/model/export
The export model API might time out if the export process takes longer than 5 minutes.
Use the following attributes in the request body to specify the reference data sets and hierarchies to 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.

POST response

The response contains the exported assets.
The following table describes the attributes in the response:
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.
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 example

To export reference data sets and hierarchies, you might use the following request:
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" ] }
The following sample response shows the exported model of reference data sets and hierarchies:
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 6076 { "version":"3.6", "referenceDataSets":[ { "id":"fddde0de9f7740721d3ac264", "name":"Country", "description":"desc", "hierarchical":false, "levels":1, "defaultList":"be82a1de2bc0fbd095249478", "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":"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 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true }, { "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", "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":{ "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":"TestTaskApprove", "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 } ] } ], "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 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true } ], "assetWorkflowConfiguration":{ "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":"TestTaskApprove", "taskAction":{ "approve":"REQUIRED", "sendBack":"REQUIRED" }, "approvers":{ "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 }, { "name":"Code", "labels":[ { "language":"en", "value":"Code" } ], "origin":"TERM", "datatype":"String", "mandatory":true } ], "assetWorkflowConfiguration":{ "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":"c984c9006ec3b492c2395e1a", "description":"description", "status":"status", "sourceCodelistId":"71e94e4b43e146edb370461a", "targetCodelistId":"fb4c079c4d8376e03f72a73a", "assetStakeholders":{ "stakeholders":[ { } ] } } ], "enums":{ "application":[ { "key":"CRM", "label":"CRM" } ] }, "hierarchies":[ { "id":"hierarchy1", "name":"hierarchy1", "description":"hierarchy1 desc", "codeListRelations":{ "relations":[ { "parent":{ "codeListId":"71e94e4b43e146edb370461a", "codeListName":"IsoCountry", "termId":"aaa97c7034473568b09d65f7", "termName":"rds2" }, "child":{ "codeListId":"db73317aab6d239460fdac9f", "codeListName":"rds1_cl1_name", "termId":"fddde0de9f7740721d3ac264", "termName":"Country" } } ] }, "stakeholderAssignments":{ "stakeholders":[ { "subject":{ "name":"rdmUserGroup", "type":"USERGROUP" } } ] } } ] }
If the assets have references to any deleted enum entries, the export model API ignores the fields from the exported data.

0 COMMENTS

We’d like to hear from you!