Reference 360

Back Next

Create a subset ID for code values in a hierarchical code list

Creates a subset ID for code values in a hierarchical code list.

POST request

To create a subset ID for code values in a hierarchical code list, submit a POST request with the following URI:

/rdm-service/external/v1/codelists/{codelistId}/codevalues/subset

Use the following parameters in the request body to specify the code value hierarchy:

Field	Type	Description
type	String	Type of the code values subset. Value must be ANCESTORS_AND_DESCENDANTS .
ancestors	-	The ancestors of the code value that you want to export.
depth	Number	Optional. The levels of ancestors of the code value that you want to export.
include	Boolean	The flag to indicate inclusion of ancestors of the code value.
descendants	-	The descendants of the code value that you want to export.
depth	Number	Optional. The levels of descendants of the code value that you want to export.
include	Boolean	The flag to indicate inclusion of descendants of the code value that you want to export.
startNode	-	The starting node of the code value that you want to export.
code	String	The code field of the starting node of the code value that you want to export.
cursorSettings	-	Includes details about the cursor settings.
repeatHeaders	Boolean	Optional. Indicates whether to populate headers in the CSV response. Value is true or false . Default is false .
addLabelsForReferenceAttribute	Boolean	Optional. Displays values for reference and dependent attributes based on the display attributes of reference and dependent code lists, respectively.
delimiter	String	Optional. Delimiter used to separate values. Value must be ASTERISK , CIRCUMFLEX , COLON , COMMA , PIPE , SECTION , SEMICOLON , SPACE , or TAB . Default is COMMA .
codepage	String	Optional. Code page used for the export file. Value can be UTF8 or MS_WINDOWS . Default is UTF8 .
decimalSeparator	String	Optional. Decimal separator used for numbers. Value must be COMMA or DOT . Default is DOT .
thousandSeparator	String	Optional. Grouping separator used for numbers. Value can be COMMA , DOT , SPACE , SINGLEQUOTE or NONE . Default is NONE .
filename	String	File name for the exported file. Value must end with the .csv file extension.
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. Default is ISO .
columns	Array	Optional. Attribute columns that you want to export. If you don't specify attribute columns, the export includes all the attribute columns.
fieldName	String	Optional. Name of attribute column to include in the exported file.
codeListId	String	ID of the code list.
noOfRecordsPerPage	Number	Optional. Number of records to display on each page. The maximum value is 10000 . Default is 10000 .

POST response

The response contains the subset ID of the code value hierarchy in a hierarchical code list.

POST example

To create a subset ID for code value hierarchy in a hierarchical code list, you might use the following request:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/5d352cbb8de0392f8c0710d3/codevalues/subset HTTP/1.1
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
   "type":"ANCESTORS_AND_DESCENDANTS",
   "ancestors":{
      "include":true,
      "depth":2
   },
   "descendants":{
      "include":true,
      "depth":2
   },
   "startNode":{
      "code":"desiredCodeValueName"
   },
   "cursorSettings":{
      "filename":"codeValueHierarchyExportFile.csv",
      "repeatHeaders":true,
      "delimiter":"COMMA",
      "decimalSeparator":"COMMA",
      "thousandSeparator":"DOT",
      "dateFormat":"DE",
      "addLabelsForReferenceAttribute":true,
      "codepage":"UTF8",
      "columns":[
         {
            "fieldName":"columnName",
            "codeListId":"5d352cbb8de0392f8c0710d3"
         }
      ],
      "noOfRecordsPerPage":10000
   }
}

The following sample response shows the subset ID for a code value hierarchy in a hierarchical code list:

HTTP/1.1 201 Created
Location: /subset/71253be5deb0e7d4974935e0/cursor
Content-Type: application/json
Content-Length: 39

{
  "id" : "71253be5deb0e7d4974935e0"
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Create a subset ID for code values in a hierarchical code list

Create a subset ID for code values in a hierarchical code list

POST request

POST response

POST example