Reference 360

Back Next

Export hierarchies to JSON format (v4)

Exports a hierarchy to the JSON format based on the internal ID or alias.

POST request

To export a hierarchy based on the internal ID or alias, submit a POST request with the following URI:

/rdm-service/external/v4/export

In the request header, you must specify the

attribute to

application/json

Use the following parameters in the request body to specify the hierarchy to export:

Field	Type	Description
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_HYPHEN . For mm-dd-yyyy format. US_SLASH . For mm/dd/yyyy format.
containerType	String	Type of asset that contains code values. Value must be hierarchy .
containerKey	String	Internal ID or alias of a code list.
excludeParentId	Boolean	Optional. Indicates whether to include the parent ID of code values in the CSV file. Value is true or false .
includeAssetName	Boolean	Optional. Indicates whether to include the Name field of code lists in the JSON file. Value can be true or false . Default is false .

POST response

The response is in JSON format.

POST example

To export a hierarchy based on the internal ID or alias, you might use the following request:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v4/export HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
Content-Length: 163
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
  "delimiter": "SEMICOLON",
  "textQualifier": "DOUBLE_QUOTE",
  "startingRow": "0",
  "codepage": "UTF8",
  "dateFormat": "ISO",
  "filename": "export.json",
  "containerType": "hierarchy",
  "containerKey": "color_hierarchy",
  "includeAssetName": "false"
}

The following sample response shows the exported data in JSON format:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1114
{
    "content": [
        {
            "Code": "B",
            "children": [
                {
                    "Code": "Black",
                    "codeListDetails": {
                        "id": "66d975cba667801d60523bef"
                    },
                    "fields": {
                        "Code": "Black",
                        "Name": "Black"
                    }
                },
                {
                    "Code": "Blue",
                    "codeListDetails": {
                        "id": "66d975cba667801d60523bef"
                    },
                    "fields": {
                        "Code": "Blue",
                        "Name": "Blue"
                    }
                }
            ],
            "codeListDetails": {
                "id": "673ec36b545db931eb1b9b8b",
                "internalId": "ent_alphabet",
                "alias": "enterprise_alpha"
            },
            "fields": {
                "Code": "B",
                "Name": "B"
            }
        }
    ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Export hierarchies to JSON format (v4)

Export hierarchies to JSON format (v4)

POST request

POST response

POST example