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

Get job details of an import model job

Get job details of an import model job

Retrieves job details of an import model job.

GET request

To get the job details of an import model job, submit a GET request with the following URI:
/rdm-service/external/v3/model/import/job/f27f4850bac7ee1fd6f9fa7a

GET response

The response contains the details of the import model job and the objects that were ignored during import.
The following table describes the attributes in the response:
Field
Type
Description
jobId
String
ID of the import model job.
status
String
Status of the import model job. Value can be
RUNNING
,
SUCCESS
,
FAILED
, or
CANCELLED
.
createdBy
String
Username of the user who triggered the import model job.
createdDate
String
Date when the user ran the import model job.
detail
-
Includes details about the import model job.
modelImportReport
-
Report for the import model job.
numImportedRds
Number
Number of imported reference data sets.
numImportedCodeList
Number
Number of imported code lists.
numImportedCrosswalk
Number
Number of imported crosswalks.
numImportedHierarchy
Number
Number of imported hierarchies.
ignoredRdsCount
Number
Number of ignored reference data sets.
ignoredCodeListCount
Number
Number of ignored code lists.
ignoredCrosswalkCount
Number
Number of ignored crosswalks.
ignoredHierarchyCount
Number
Number of ignored hierarchies.
importedEntities
-
Includes details about the imported entities.
type
String
Type of imported entity. Value can be
rds
,
codelist
,
crosswalk
, or
hierarchy
.
name
String
Name of the imported entity.
oldId
String
ID of the imported entity in the source organization.
newId
String
ID of the imported entity in the target organization.
ignoredEntities
-
Includes details about the ignored entities.
type
String
Type of ignored entity. Value can be
rds
,
codelist
,
crosswalk
, or
hierarchy
.
name
String
Name of the ignored entity.
oldId
String
ID of the ignored entity in the source organization.
newId
String
ID of the ignored entity in the target organization.
enumImportResult
-
Includes details about the enum entries.
newEntries
Number
Number of new entries imported.
updatedEntries
Number
Number of updated entries.
existingEntries
Number
Number of existing entries that were skipped.
stakeholderImportResult
-
Includes details about the stakeholder import result.
ignoredStakeholderEntries
-
Includes details about the ignored stakeholder entries with reason.
reason
String
The reason for ignoring stakeholder during import.
stakeholder
-
Includes details about the ignored stakeholder record.
subject
-
Includes details about the user group details of the ignored stakeholder record.
name
String
User name or user group name of the ignored stakeholder record.
type
String
User or user group of the ignored stakeholder record.
role
String
User or user group role of the ignored stakeholder record.
assetIdentity
-
Includes details of the asset to which the workflow configuration belongs.
id
String
Identifier of the asset.
assetName
String
Name of the asset.
assetType
String
Type of asset. Value can be
rds
,
codelist
,
crosswalk
, or
hierarchy
.
assetWorkflowConfigurationImportReport
-
Includes details about the imported workflow configuration.
assetWorkflowImportIgnoredTasks
-
Includes details of the workflow tasks ignored during import.
reason
String
The reason for ignoring workflow tasks during import.
taskName
String
Name of the workflow task.
notFoundUserGroups
Array
List of user groups that aren't found.
assetIdentity
-
Includes details of the asset to which the workflow configuration belongs.
id
String
Identifier of the asset.
assetName
String
Name of the asset.
assetType
String
Type of asset. Value can be
rds
,
codelist
,
crosswalk
, or
hierarchy
.
importIgnoredWorkflowTask
-
Includes details about the ignored workflow tasks.
taskName
String
Name of the workflow task.
taskAction
-
Includes details about the workflow task action.
approve
String
Action name of the workflow task.
sendBack
String
Action name of the workflow task.
reject
String
Action name of the workflow task.
approvers
-
Includes details about the workflow task approvers.
userGroups
-
Includes details about user groups of workflow task approvers.
name
String
Names of user groups of workflow task approvers.

GET example

To get the job details of an import model job, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v3/model/import/job/a335550eebe02c6d133898b9 HTTP/1.1 Content-Type: application/json Accept: application/json
The following sample response shows the job details of an import model job:
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 4117 { "jobId":"a335550eebe02c6d133898b9", "type":"IMPORT_MODEL", "status":"SUCCESS", "createdBy":"userId", "createdDate":"2023-01-25T09:54:08.087+00:00", "detail":{ "modelImportReport":{ "stakeholderImportResult":{ "ignoredStakeholderEntries":[ { "reason":"User or UserGroup does not exist to create stakeholder", "assetIdentity":{ "id":"fddde0de9f7740721d3ac264", "assetType":"REFERENCEDATASET", "assetName":"Country" }, "stakeholder":{ } }, { "reason":"User or UserGroup does not exist to create stakeholder", "assetIdentity":{ "id":"aaa97c7034473568b09d65f7", "assetType":"REFERENCEDATASET", "assetName":"rds2" }, "stakeholder":{ } }, { "reason":"User or UserGroup does not exist to create stakeholder", "assetIdentity":{ "id":"db73317aab6d239460fdac9f", "assetType":"CODELIST", "assetName":"rds1_cl1_name" }, "stakeholder":{ } }, { "reason":"User or UserGroup does not exist to create stakeholder", "assetIdentity":{ "id":"fb4c079c4d8376e03f72a73a", "assetType":"CODELIST", "assetName":"SapCountry" }, "stakeholder":{ } }, { "reason":"User or UserGroup does not exist to create stakeholder", "assetIdentity":{ "id":"71e94e4b43e146edb370461a", "assetType":"CODELIST", "assetName":"IsoCountry" }, "stakeholder":{ } }, { "reason":"User or UserGroup does not exist to create stakeholder", "assetIdentity":{ "id":"c984c9006ec3b492c2395e1a", "assetType":"CROSSWALK" }, "stakeholder":{ } }, { "reason":"The user group does not exists in the system to import as stakeholder assignment to Hierarchy hierarchy1", "assetIdentity":{ "id":"hierarchy1", "assetType":"HIERARCHY", "assetName":"hierarchy1" }, "stakeholder":{ "subject":{ "name":"rdmUserGroup", "type":"USERGROUP" } } } ] }, "assetWorkflowConfigurationImportReport":{ }, "dqRuleAssociationImportReport":{ }, "numImportedRds":1, "numImportedCodeList":3, "numImportedCrosswalk":1, "numImportedHierarchy":1, "importedEntities":[ { "type":"rds", "name":"rds2", "oldId":"aaa97c7034473568b09d65f7", "newId":"48a5e3416f1da3e67b7554c5" }, { "type":"codelist", "name":"rds1_cl1_name", "oldId":"db73317aab6d239460fdac9f", "newId":"7dc204fee7d65086c1bdfdaa" }, { "type":"codelist", "name":"SapCountry", "oldId":"fb4c079c4d8376e03f72a73a", "newId":"3a800b90e3fffb1f12b18502" }, { "type":"codelist", "name":"IsoCountry", "oldId":"71e94e4b43e146edb370461a", "newId":"c42bdf7689b6c35e25b22b29" }, { "type":"crosswalk", "name":"description", "oldId":"c984c9006ec3b492c2395e1a", "newId":"fe318acfc4a126b71f0ecba8" }, { "type":"hierarchy", "name":"hierarchy1", "oldId":"hierarchy1", "newId":"847f90ccde87d4674962366d" } ], "ignoredRdsCount":1, "ignoredCodeListCount":0, "ignoredCrosswalkCount":0, "ignoredHierarchyCount":0, "ignoredEntities":[ { "type":"rds", "name":"Country", "oldId":"fddde0de9f7740721d3ac264", "newId":"c77161ce50bce805c788d706" } ], "enumImportResult":{ "newEntries":2, "existingEntries":3, "updatedEntries":0 } } } }

0 COMMENTS

We’d like to hear from you!