Reference 360

Back Next

Import code values

Imports code values 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/v1/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 start with two header rows, followed by the data rows.; For example, you might have the following code values:
Name,Code Name,Code 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.
importSettings: Specify the file specific configuration and container details.; The
importSettings
parameter includes the following attributes:

Field
Type
Description

delimiter
String
Delimiter used to separate values. Value must be
ASTERISK
,
CIRCUMFLEX
,
COLON
,
COMMA
,
PIPE
,
SECTION
,
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 export file. Value must be
UTF8
.

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.

Field	Type	Description
delimiter	String	Delimiter used to separate values. Value must be ASTERISK , CIRCUMFLEX , COLON , COMMA , PIPE , SECTION , 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 export file. Value must be UTF8 .
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.

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/v1/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

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=importSettings
Content-Type: application/json;charset=UTF-8

{ 
  "delimiter":"COMMA",
  "textQualifier":"DOUBLE_QUOTE",
  "codepage":"UTF8",
  "dateFormat":"ISO",
  "containerType":"CODELIST",
  "containerId":"9ab3201990a54dcdc86f54cf",
  "startingRow":null
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

The CSV file might contain the following header rows and data rows:

Name,Code
Name,Code
Afghanistan,AFG
Aland Islands,ALA
Albania,ALB
Algeria,DZA
American Samoa,ASM

The following sample response shows the status of the import job:

{ 
  "jobId":"dd1b2018cb47cef99f8d0f42",
  "state":"INPROGRESS",
  "startTime":1561367377428,
  "numOfRecordsProcessed":100,
  "numOfRecordsFailed":25,
  "numOfRecordsSucceeded":75
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Import code values

Import code values

POST request

POST response

POST example