CSV output format for entity export

CSV Output Format for Entities Export describes the values displayed in the CSV columns for the exported entities.

ID Header

The value of the CSV column is the ID of an entity.

Type Header

The value of the CSV column is the entity type.

Attributes values headers

By default, CSV headers for attributes are constructed as follows:

The first header of the attribute values is the name of the attribute:

Attributes.<NameOfAttribute>..

All the following headers of the attribute values will fit into the pattern as follows:

Attributes.<NameOfAttribute> N

Where N is an index of an attribute value + 1 (the indexing of the attribute value begins with 0).

The value of the CSV column is an attribute’s value property.

Note: The values, such as: type, uri, ov values of attributes aren’t exported in a CSV file.

Example: Header defines the attribute values

Consider an HCP entity with three values for FirstName (the values for FirstName are specified in the entity's JSON).

Entities JSON

   {
    "uri": "entities/QWFU1nx",
    "type": "configuration/entityTypes/HCP",
    "attributes": {
        "FirstName": [
            {
                "value": "John"
            },
            {
                "value": "Johnathan"
            },
            {
                "value": "Johny"
            }
        ]
}

CSV: Entity

See Table 1: Attributes and IDs for the CSV output file of the entity.

Table 1. Attributes and IDs
ID	Type	Attributes.FirstName	Attributes.FirstName2	Attributes.FirstName3
QWFU1nx	HCP	John	Johnathan	Johny

Crosswalks headers

The CSV header for crosswalks is constructed as follows:

Crosswalks.<type>.<table_if_present>.ID

The value of the CSV column is the value property of the crosswalk.

Note: The values such as: uri, attributes, singleAttributeUpdateDates values of crosswalks aren't exported in a CSV file. The relationDate, createDate, updateDate, deleteDate values of the crosswalks are exported in CSV file only in the pivoted view of the crosswalks. For more information, see topic Generate pivoted view of crosswalks.

Example: Crosswalk headers

Crosswalk JSON

{
    "uri": "entities/029OP2m/crosswalks/HKqxTX6",
    "type": "configuration/sources/SDS",
    "value": "10000007",
    "table": "UserData",
    "reltioLoadDate": "2016-01-12T16:34:28.648+03:00",
    "createdBy": "creator",
    "createDate": "2014-04-30T04:01:00.000+04:00",
    "updatedBy": "updater",
    "updateDate": "2014-04-30T04:01:00.000+04:00",
    "attributes": [
        "entities/029OP2m/attributes/LastName/HKqsO80",
        "entities/029OP2m/attributes/FirstName/HKqsFbU"
    ],
    "singleAttributeUpdateDates": {}
}

CSV

See Table 2: Crosswalks for the crosswalk ID.

Table 2. Crosswalks
Crosswalks.SDS.UserData.ID
10000007

Reference entity or relation crosswalks headers

Apart from the values in the reference attributes, reference entity crosswalks and reference relation crosswalks are exported.

By default, the CSV header for reference entity or relation crosswalks is constructed as follows:

Attributes.<NameOfAttribute>.refEntityCrosswalk.<type>.<table_if_present>.ID

Attributes.<NameOfAttribute>.refRelationCrosswalk.<type>.<table_if_present>.ID

The value of the CSV column is the value property for the crosswalk.

Note: The values, such as: uri, type, attributeURIs values of refEntity or refRelation crosswalks aren’t exported in a CSV file. The reltioLoadDate, createDate, updateDate, and deleteDate values of crosswalks are exported in CSV file only in the pivoted view of crosswalks. For more information, see topic Generate pivoted view of crosswalks.

Example: Crosswalks headers for reference entity and reference relation

refEntity and refRelation JSON

"refEntity": {
    "type": "configuration/entityTypes/Location",
    "crosswalks": [
        {
            "uri": "entities/QWFU1nx/crosswalks/QWFU64D.1osyxD8Tl",
            "type": "configuration/sources/Reltio",
            "value": "QWFU64D",
            "createDate": "2021-07-07T12:55:03.355Z",
            "updateDate": "2021-07-07T12:55:03.355Z",
            "attributeURIs": [
                "entities/QWFU1nx/attributes/Address/IxCqL09/StateProvince/1osyxCiuD",
                "entities/QWFU1nx/attributes/Address/IxCqL09",
                "entities/QWFU1nx/attributes/Address/IxCqL09/Country/1osyxCnAT"
            ]
        }
    ],
    "objectURI": "entities/QWFU64D"
},
"refRelation": {
    "type": "configuration/relationTypes/HasAddress",
    "crosswalks": [
        {
            "uri": "entities/QWFU1nx/crosswalks/IxCqL09.1osyxDCk1",
            "type": "configuration/sources/Reltio",
            "value": "IxCqL09",
            "createDate": "2021-07-07T12:55:03.355Z",
            "updateDate": "2021-07-07T12:55:03.355Z"
        }
    ],
    "startRefPinned": false,
    "endRefPinned": false,
    "startRefIgnored": false,
    "endRefIgnored": false,
    "objectURI": "relations/IxCqL09"
}

CSV:

See Table 3: List of Crosswalks for Reference Entity and Reference Relation crosswalks.

Table 3. List of crosswalks
Attributes.Address.refEntityCrosswalk.Reltio.ID	Attributes.Address.refRelationCrosswalk.Reltio.ID
QWFU64D	IxCqL09

Headers: Analytics attributes

By default, the CSV headers for analytics attributes are constructed as follows:

The first header of the analytic attribute value is the name of the attribute AnalyticsAttributes.<NameOfAttribute>. All the following headers of the attribute values will fit into the pattern as follows:

AnalyticsAttributes.<NameOfAttribute>N

Where N is an index of an attribute value + 1 (attribute value indexing begins with 0).

The CSV column value is an analytics attribute’s value property.

Note: Type and URI values of attributes aren’t exported in a CSV file.

Example: Headers for analytics attributes

Consider an entity with analytics attributes.

CSV

See Table 4: Entities with Analytics Attributes for the CSV file of an entity with analytics attributes.

Table 4. Entities with analytics attributes
ID	Type	AnalyticsAttributes.DQ.score	Attributes.DQ.enabled
`QTNEU1no`	`HCP`	`42`	`1625734235046`

System attributes headers

updatedBy

The CSV column defines the value of the updatedBy property of an entity.

updatedDate

The CSV column defines the value of updatedTime property of an entity.

createdBy

The CSV column defines the value of createdBy property of an entity.

createdDate

The CSV column defines the value of createdTime property of an entity.

startDate

The CSV column value is a value of ‘activenessStartInternal property of an entity. If the value of activenessStartInternal is null, the CSV column value is the value of activeness.startDate property.

endDate

The CSV column value is a value of activenessEndInternal property of an entity. If the value of activenessEndInternal is null, the CSV column value is a value of activeness.endDate property. If the entity doesn't have endDate, then the value will be the maximum of delete dates of all the crosswalks.

Example

Consider two HCP entities with two values (the values for FirstName are specified in the entities's JSON file) for FirstName and the nested reference attribute Address.

Entities JSON

[{
    "uri": "entities/QWFU1nx",
    "type": "configuration/entityTypes/HCP",
    "createdBy": "user1",
    "createdTime": 1625662503355,
    "updatedBy": "user1",
    "updatedTime": 1625662503355,
    "activenessStartInternal": 1657724036,
    "activenessEndInternal": 1657724100,    
    "attributes": {
        "FirstName": [
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": true,
                "value": "John",
                "uri": "entities/QWFU1nx/attributes/FirstName/1osyxCRrB"
            },
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": false,
                "value": "Johny",
                "uri": "entities/QWFU1nx/attributes/FirstName/1osyxCaNh"
            },
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": false,
                "value": "Johnathan",
                "uri": "entities/QWFU1nx/attributes/FirstName/1osyxCW7R"
            }
        ],
        "Address": [
            {
                "label": "CA",
                "relationshipLabel": "",
                "value": {
                    "StateProvince": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/StateProvince",
                            "ov": true,
                            "value": "CA",
                            "uri": "entities/QWFU1nx/attributes/Address/IxCqL09/StateProvince/1osyxCiuD"
                        }
                    ],
                    "Country": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/Country",
                            "ov": true,
                            "value": "US",
                            "uri": "entities/QWFU1nx/attributes/Address/IxCqL09/Country/1osyxCnAT"
                        }
                    ]
                },
                "ov": true,
                "uri": "entities/QWFU1nx/attributes/Address/IxCqL09",
                "refEntity": {
                    "type": "configuration/entityTypes/Location",
                    "crosswalks": [
                        {
                            "uri": "entities/QWFU1nx/crosswalks/QWFU64D.1osyxD8Tl",
                            "type": "configuration/sources/Reltio",
                            "value": "QWFU64D",
                            "createDate": "2021-07-07T12:55:03.355Z",
                            "updateDate": "2021-07-07T12:55:03.355Z",
                            "attributeURIs": [
                                "entities/QWFU1nx/attributes/Address/IxCqL09/StateProvince/1osyxCiuD",
                                "entities/QWFU1nx/attributes/Address/IxCqL09",
                                "entities/QWFU1nx/attributes/Address/IxCqL09/Country/1osyxCnAT"
                            ]
                        }
                    ],
                    "objectURI": "entities/QWFU64D"
                },
                "refRelation": {
                    "type": "configuration/relationTypes/HasAddress",
                    "crosswalks": [
                        {
                            "uri": "entities/QWFU1nx/crosswalks/IxCqL09.1osyxDCk1",
                            "type": "configuration/sources/Reltio",
                            "value": "IxCqL09",
                            "createDate": "2021-07-07T12:55:03.355Z",
                            "updateDate": "2021-07-07T12:55:03.355Z"
                        }
                    ],
                    "startRefPinned": false,
                    "endRefPinned": false,
                    "startRefIgnored": false,
                    "endRefIgnored": false,
                    "objectURI": "relations/IxCqL09"
                },
                "startObjectCrosswalks": [
                    {
                        "type": "configuration/sources/Reltio",
                        "value": "QWFU1nx"
                    }
                ]
            },
            {
                "label": "CE",
                "relationshipLabel": "",
                "value": {
                    "StateProvince": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/StateProvince",
                            "ov": true,
                            "value": "CE",
                            "uri": "entities/QWFU1nx/attributes/Address/IxCqPGP/StateProvince/1osyxCzxF"
                        },
                        {
                            "type": "configuration/entityTypes/Location/attributes/StateProvince",
                            "ov": true,
                            "value": "CH",
                            "uri": "entities/QWFU1nx/attributes/Address/IxCqPGP/StateProvince/1osyxCvgz"
                        }
                    ],
                    "Country": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/Country",
                            "ov": true,
                            "value": "RU",
                            "uri": "entities/QWFU1nx/attributes/Address/IxCqPGP/Country/1osyxD4DV"
                        }
                    ]
                },
                "ov": true,
                "uri": "entities/QWFU1nx/attributes/Address/IxCqPGP",
                "refEntity": {
                    "type": "configuration/entityTypes/Location",
                    "crosswalks": [
                        {
                            "uri": "entities/QWFU1nx/crosswalks/QWFUAKT.1osyxDH0H",
                            "type": "configuration/sources/Reltio",
                            "value": "QWFUAKT",
                            "createDate": "2021-07-07T12:55:03.355Z",
                            "updateDate": "2021-07-07T12:55:03.355Z",
                            "attributeURIs": [
                                "entities/QWFU1nx/attributes/Address/IxCqPGP/StateProvince/1osyxCzxF",
                                "entities/QWFU1nx/attributes/Address/IxCqPGP/StateProvince/1osyxCvgz",
                                "entities/QWFU1nx/attributes/Address/IxCqPGP/Country/1osyxD4DV",
                                "entities/QWFU1nx/attributes/Address/IxCqPGP"
                            ]
                        }
                    ],
                    "objectURI": "entities/QWFUAKT"
                },
                "refRelation": {
                    "type": "configuration/relationTypes/HasAddress",
                    "crosswalks": [
                        {
                            "uri": "entities/QWFU1nx/crosswalks/IxCqPGP.1osyxDLGX",
                            "type": "configuration/sources/Reltio",
                            "value": "IxCqPGP",
                            "createDate": "2021-07-07T12:55:03.355Z",
                            "updateDate": "2021-07-07T12:55:03.355Z"
                        }
                    ],
                    "startRefPinned": false,
                    "endRefPinned": false,
                    "startRefIgnored": false,
                    "endRefIgnored": false,
                    "objectURI": "relations/IxCqPGP"
                },
                "startObjectCrosswalks": [
                    {
                        "type": "configuration/sources/Reltio",
                        "value": "QWFU1nx"
                    }
                ]
            }
        ]
    },
    "isFavorite": false,
    "crosswalks": [
        {
            "uri": "entities/QWFU1nx/crosswalks/1osyxDPWn",
            "type": "configuration/sources/Reltio",
            "value": "QWFU1nx",
            "reltioLoadDate": "2021-07-07T12:55:03.355Z",
            "createDate": "2021-07-07T12:55:03.355Z",
            "updateDate": "2021-07-07T12:55:03.355Z",
            "attributes": [
                "entities/QWFU1nx/attributes/FirstName/1osyxCaNh",
                "entities/QWFU1nx/attributes/FirstName/1osyxCRrB",
                "entities/QWFU1nx/attributes/FirstName/1osyxCW7R"
            ],
            "singleAttributeUpdateDates": {}
        }
    ],
    "analyticsAttributes": {},
    "label": "John",
    "secondaryLabel": "CA"
},
{
    "uri": "entities/8HW3W1A",
    "type": "configuration/entityTypes/HCP",
    "createdBy": "user1",
    "createdTime": 1625663458840,
    "updatedBy": "user1",
    "updatedTime": 1625663458840,
    "activeness": {
        "startDate": 1657724200,
        "endDate": 1657724300,        
    },    
    "attributes": {
        "FirstName": [
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": true,
                "value": "Mary",
                "uri": "entities/8HW3W1A/attributes/FirstName/nHoBJcQK"
            },
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": false,
                "value": "Marya",
                "uri": "entities/8HW3W1A/attributes/FirstName/nHoBJgga"
            }
        ],
        "Address": [
            {
                "label": "CH",
                "relationshipLabel": "",
                "value": {
                    "StateProvince": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/StateProvince",
                            "ov": true,
                            "value": "CH",
                            "uri": "entities/8HW3W1A/attributes/Address/6gApiyG/StateProvince/nHoBJpD6"
                        }
                    ],
                    "Country": [
                        {
                            "type": "configuration/entityTypes/Location/attributes/Country",
                            "ov": true,
                            "value": "UK",
                            "uri": "entities/8HW3W1A/attributes/Address/6gApiyG/Country/nHoBJtTM"
                        }
                    ]
                },
                "ov": true,
                "uri": "entities/8HW3W1A/attributes/Address/6gApiyG",
                "refEntity": {
                    "type": "configuration/entityTypes/Location",
                    "crosswalks": [
                        {
                            "uri": "entities/8HW3W1A/crosswalks/8HW3aHQ.nHoBJxjc",
                            "type": "configuration/sources/Reltio",
                            "value": "8HW3aHQ",
                            "createDate": "2021-07-07T13:10:58.840Z",
                            "updateDate": "2021-07-07T13:10:58.840Z",
                            "attributeURIs": [
                                "entities/8HW3W1A/attributes/Address/6gApiyG/Country/nHoBJtTM",
                                "entities/8HW3W1A/attributes/Address/6gApiyG/StateProvince/nHoBJpD6",
                                "entities/8HW3W1A/attributes/Address/6gApiyG"
                            ]
                        }
                    ],
                    "objectURI": "entities/8HW3aHQ"
                },
                "refRelation": {
                    "type": "configuration/relationTypes/HasAddress",
                    "crosswalks": [
                        {
                            "uri": "entities/8HW3W1A/crosswalks/6gApiyG.nHoBK1zs",
                            "type": "configuration/sources/Reltio",
                            "value": "6gApiyG",
                            "createDate": "2021-07-07T13:10:58.840Z",
                            "updateDate": "2021-07-07T13:10:58.840Z"
                        }
                    ],
                    "startRefPinned": false,
                    "endRefPinned": false,
                    "startRefIgnored": false,
                    "endRefIgnored": false,
                    "objectURI": "relations/6gApiyG"
                },
                "startObjectCrosswalks": [
                    {
                        "type": "configuration/sources/Reltio",
                        "value": "8HW3W1A"
                    }
                ]
            }
        ]
    },
    "isFavorite": false,
    "crosswalks": [
        {
            "uri": "entities/8HW3W1A/crosswalks/nHoBK6G8",
            "type": "configuration/sources/Reltio",
            "value": "8HW3W1A",
            "reltioLoadDate": "2021-07-07T13:10:58.840Z",
            "createDate": "2021-07-07T13:10:58.840Z",
            "updateDate": "2021-07-07T13:10:58.840Z",
            "attributes": [
                "entities/8HW3W1A/attributes/FirstName/nHoBJcQK",
                "entities/8HW3W1A/attributes/FirstName/nHoBJgga"
            ],
            "singleAttributeUpdateDates": {}
        }
    ],
    "analyticsAttributes": {},
    "label": "Mary",
    "secondaryLabel": "CH"
}
]

CSV

See Table 5: Exported CSV File for the exported CSV file for the entities.

Table 5. Exported CSV file
ID	Type	Attributes.FirstName	Attributes.FirstName2	Attributes.FirstName3	Attributes.Address.Country	Attributes.Address.StateProvince	Attributes.Address.refEntityCrosswalk.Reltio.ID	Attributes.Address.refRelationCrosswalk.Reltio.ID	Attributes.Address2.Country	Attributes.Address2.StateProvince	Attributes.Address2.StateProvince2	Attributes.Address2.refEntityCrosswalk.Reltio.ID	Attributes.Address2.refRelationCrosswalk.Reltio.ID	Crosswalks.Reltio.ID	updatedBy	updateDate	createdBy	createDate	StartDate	endDate
QWFU1nx	HCP	John	Johnathan	Johny	US	CA	QWFU64D	IxCqL09	RU	CH	CE	QWFUAKT	IxCqPGP	QWFU1nx	user1	1625662503355	user1	1625662503355	1657724036	1657724100
8HW3W1A	HCP	Mary	Marya		UK	CH	8HW3aHQ	6gApiyG						8HW3W1A	user1	1625663458840	user1	1625663458840	1657724200	1657724300

Important:

The CSV column separator is a comma (,) and it isn’t configurable.
A column is present in the CSV output file only if there is at least one value that is not null. The value “” is an empty string value, but not a missing value.
The order of the columns isn’t guaranteed and can’t be configured.
headerFormat body parameter, headersStyle, exploded, and slicedByCrosswalks query parameters of entities export request influence on the headings.
For more information, see topic Parameters for CSV Headers in the Entities or Relations Export File.

See Table 6: Differences between JSON Properties and CSV Formats to find out the differences between JSON and CSV formats.

Table 6. Differences between JSON properties and CSV formats
JSON property	CSV Header
`uri` For example, the value is `entities` / `DmpJuOD`.	`ID` For example, the value is `DmpJuOD`
`type` value is a complete URI of `type`. For example, the value is `configuration` / `entityTypes` / `HCP`.	`type` For example, the value is HCP.
`createdTime`	The CSV header is `createdDate`.
`updatedTime`	The CSV Header is `updatedDate`.

Unify and manage your data