NEnexla
Data Maps

Create a Static Data Map

Creates a new static data map in the authenticated user's account. Dynamic data maps can only be created by creating a Destination (Sink) of the type data_map.

For statically assigned data maps, you can choose to add data rows to the data map by either of the following methods:

  1. Send data map entries with this request. In this case, the rows of data are sent as a data_map array of objects.
  2. Send data map entries as a separate call to add/update entries.

You must include map_primary_key to specify which map attribute should be used for data matching.

post/data_maps

Request

Request body

namestring required
descriptionstring
map_primary_keystring

Key name which should be used as the primary key for looking up rows in this data map.

data_defaultsobject

The default values to use for any key if the key is not present in the corresponding row.

emit_data_defaultboolean

This property defines whether a lookup query should return values with applicable default values for missing properties in the row.

tagsstring[]
data_mapobject[]

Enter an array of data map entries if you wish to seed this data map with some rows of data while creating the data map.

You can also update data map rows by calling the endpoint for updating entries.

Example request

{
  "map_primary_key": "id"
}

Response

Success

idinteger
namestring
descriptionstring
publicboolean
managedboolean
data_typestring
data_formatstring nullable
data_sink_idstring nullable
emit_data_defaultboolean
use_versioningboolean
map_primary_keystring
data_defaultsobject
updated_atstring date-time
created_atstring date-time
access_rolesstring[]

This property reflects all the permissions the user/team/organization has to this resource.

  1. collaborator: The user/team/organization can view the resource but not make any modifications to it.
  2. operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
  3. administrator: The user/team/organization has complete administrative rights to this resource.
  4. owner: This user created the resource and so has complete administrative rights to it.
data_set_idinteger
map_entry_countinteger
map_entry_schemaobject
tagsstring[]

Example response

{
  "data_type": "string",
  "map_primary_key": "id",
  "updated_at": "2021-07-26T21:29:58.000Z",
  "created_at": "2021-07-26T21:29:58.000Z",
  "map_entry_count": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.