NEnexla
Data Maps

Update Data Map Metadata

Updates a data map in the authenticated user's account.

This endpoint is suitable for updating the metadata of a data map. We recommend using the data map entries update and delete endpoints to update data map rows.

put/data_maps/{data_map_id}

Request

Path parameters

data_map_idinteger required

The unique ID of the data map that needs to be updated.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Request body

namestring
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[]

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.