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

Import code values

Import code values

Imports code values with optional custom headers into a code list.
Validation checks are not performed when you import code values.

POST request

To import code values into a code list, submit a POST request with the following URI:
/rdm-service/external/v2/import
The request contains form-data with the following parameters:
file
Specify a CSV file that contains the code value attributes. The columns specified depend on your data model. The CSV must contain one or two header rows, followed by the data rows. If the occurrence of header row is one in the import CSV file, you must set the repeatHeaders field to false.
You can provide a single header row in the CSV file because it no longer requires two header rows.
For example, you might have the following code values:
CountryName,CountryCode CountryName,CountryCode Afghanistan,AFG Aland Islands,ALA Albania,ALB Algeria,DZA American Samoa,ASM
You can provide additional information about a code value. For example, you might want to assign a code value to the Approved status. In the
status.key
column for the code value, enter the key value for the system reference data value that you want to assign. For more information about your configured system reference data values, see Get system reference data values.
If an import file doesn't contain business IDs,
Reference 360
automatically generates them based on the business ID configuration in a code list.
importSettings
Specify the file-specific configuration and container details.
The
importSettings
parameter includes the following attributes:
Field
Type
Description
headerLinePresent
Boolean
Indicates whether the header line is present. Value is
true
or
false
. Default is
true
.
nestedFieldSeparator
String
Separator used to separate a nested field. Value is
SEMICOLON
or
DOT
. Default is
DOT
.
headerLineNumber
String
Line number from which the header line starts. Default is
1
.
delimiter
String
Delimiter used to separate values. Value must be
COMMA
,
SEMICOLON
,
SPACE
, or
TAB
.
textQualifier
String
Symbol used to indicate where a text begins and ends. Value must be
DOUBLE_QUOTE
,
SINGLE_QUOTE
, or
NO_QUOTE
.
codepage
String
Code page used for the import file. Value must be
UTF8
or
MS_WINDOWS
.
dateFormat
String
Format used for dates. Use one of the following formats:
  • DE
    . For dd.mm.yyyy format.
  • ISO
    . For yyyy-mm-dd format.
  • US
    . For mm/dd/yyyy format.
containerType
String
Type of asset that contains code values. Value must be
codelist
.
containerId
String
The ID of the code list to which you want to import code values.
You can find the ID of assets in
Reference 360
or use REST APIs to retrieve the IDs. For more information, see Asset IDs.
startingRow
String
Line number from which to start importing data. By default, all rows are imported.
repeatHeaders
Boolean
Optional. Indicates whether the file has two headers. Value is
true
or
false
. Default is
true
.
mappings
Object
Optional. Maps the column headers in the CSV file with the target attributes of code lists in the key-value format.
  • You can map the user-defined column name to source field name if required.
  • You can either choose to ignore the mapping or map all the columns in an import CSV file.
The key represents the header in the CSV file, and the value represents the field names in Reference 360.
For example, if the business ID column in the input CSV is labeled as
sequence
, the following mapping represents the mapping for the business ID column:
"sequence" : "businessID"
If mappings aren't specified in the import settings,
Reference 360
selects the
businessID
column by default.
approvalOptions
-
Includes details about the approval parameters.
priority
String
Optional. Defines the priority of the approval request. Value can be
LOW
,
MEDIUM
,
HIGH
, or
CRITICAL
.
dueDate
String
Use the following format:
yyyy-MM-dd
.
Comments
String
Comments that the requester adds to explain the changes.

POST response

The response contains the details of the import job.
The response contains the following attributes:
Field
Type
Description
jobId
String
ID of the job.
state
String
Status of the job. Values are
CREATED
,
INPROGRESS
,
COMPLETED
,
SUSPENDED
,
FAILED
,
STOPPED
,
QUEUED
or
WARNING
.
startTime
Number
Time, in milliseconds, when the job started.
numOfRecordsProcessed
Number
Number of records processed.
numOfRecordsFailed
Number
Number of records that failed to be imported.
numOfRecordsSucceeded
Number
Number of records successfully imported.

POST example

To import code values, you might use the following request:
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/import HTTP/1.1 Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm Content-Disposition: form-data; name=file; filename=import-code-values.csv { "headerLinePresent":true, "nestedFieldSeparator":".", "headerLineNumber":1, "delimiter":"COMMA", "textQualifier":"DOUBLE_QUOTE", "codepage":"UTF8", "dateFormat":"ISO", "containerType":"CODELIST", "containerId":"c31851709a749e2d53188ec0", "startingRow":3, "repeatHeaders":false, "mappings":{ "CL_Name":"Name", "CL_Code":"Code", "CL_Description":"Description" "Business_ID":"Business ID" }, "approvalOptions":{ "priority":"LOW", "dueDate":"2024-12-30", "comments":"Please approve the request" } } --6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
The CSV file might contain the following header rows and data rows:
CL_Name,CL_Code,Business_ID Afghanistan,AFG,RDM001 Aland Islands,ALA,RDM002 Albania,ALB,RDM003 Algeria,DZA,RDM004 American Samoa,ASM,RDM005
The following sample response shows the status of the import job:
{ "jobId":"32121c139c84a8edc8696c0c", "state":"INPROGRESS", "startTime":1631086520325, "numOfRecordsProcessed":100, "numOfRecordsFailed":25, "numOfRecordsSucceeded":75 }

0 COMMENTS

We’d like to hear from you!
Panos Kastanidis - July 17, 2024

The importSettings JSON from the example above is basically wrong.
Using this approach will end up in an error saying that some important form field or parameter is missing.

What is workign for me is this one:

{
    "headerLinePresent":true,
    "nestedFileSeparator":".",
    "headerLineNumber":1,
    "delimiter":"SEMICOLON",
    "textQualifier":"DOUBLE_QUOTE",
    "codepage":"UTF8",
    "dateFormat":"ISO",
    "containerType":"CODELIST",
    "containerId":"6696421bb5b8210005d17d01",
    "startingRow":0,
    "repeatHeaders":false,
    "mappings":{
      "CL_Name":"Name",
      "CL_Code":"Code",
      "CL_Description":"Description"
   },
   "approvalOptions":{
      "priority":"LOW",
      "dueDate":"2024-12-30",
      "comments":"Please approve the request"
   }
}

Would be good if the documentation can be adjusted to provide the correct improt settings for this API endpoint.

BR, Panos

Informatica Documentation Team - July 19, 2024

Hi Panos Kastanidis,

We want to let you know that the updates are in progress, and we plan to complete them as soon as possible.

Regards,

Informatica Documentation Team


Informatica Documentation Team - August 19, 2024

Hi Panos Kastanidis,

We're glad to let you know that we updated the sample JSON code based on your feedback. Please check.

Regards,

Informatica Documentation Team