Reference 360

Back Next

Update cursor settings of the subset of code values

Updates the cursor settings of the subset of code values.

PUT request

To update the cursor settings of the subset of code values, submit a PUT request with the following URI:

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

When you update the cursor setting, the page is reset to zero. The export API exports the subset of code values from the starting page.

Field	Type	Description
filename	String	File name for the exported file. Value must end with the .csv file extension.
repeatHeaders	Boolean	Optional. Indicates whether to populate headers in the CSV response. Value is true or false . Default is false .
delimiter	String	Optional. Delimiter used to separate values. Value must be ASTERISK , CIRCUMFLEX , COLON , COMMA , PIPE , SECTION , SEMICOLON , SPACE or TAB . Default is COMMA .
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 must be COMMA , DOT , SPACE , SINGLEQUOTE or NONE . Default is NONE .
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 .
addLabelsForReferenceAttribute	Boolean	Optional. Displays values for reference and dependent attributes based on the display attributes of reference and dependent code lists, respectively.
codepage	String	Optional. Code page used for the export file. Value must be UTF8 or MS_WINDOWS . Default is UTF8 .
columns	Array	Optional. Attribute columns you want to export. If you do not 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 .

PUT response

A 204 no content response is returned.

PUT example

To update the cursor settings of the subset of code values, you might use the following request:

PUT https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/5d352cbb8de0392f8c0710d3/codevalues/subset/71253be5deb0e7d4974935e0/cursor HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 391

{
   "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 no content response:

HTTP/1.1 204 No Content

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Update cursor settings of the subset of code values

Update cursor settings of the subset of code values

PUT request

PUT response

PUT example