The Dataset JSON Object

This JSON object provides data and metadata about a dataset.

For information about the attributes in a dataset, see The Attribute JSON Object.

Key	Value Description	Type
id	The deployment-specific ID for the dataset. Unique across the Tamr Core deployment. Example: `unify://unified-data/v1/datasets/181` To identify a dataset in other API calls, you use the numeric value after `datasets/`.	String
name	The user-defined name of the dataset. Must be unique.	String
description	Optional. The description of the dataset.	String
version	A unique ID of the dataset at its current version, which changes with modifications or updates.	String
keyAttributeNames	The name(s) of the attribute(s) being used by Tamr Core as the primary key.	Array[String]
tags	A list of any tags associated with the dataset. Can be empty.	Array[String]
created	Metadata about the creation of the dataset: - username - time - version	Checkpoint
lastModified	Metadata about the most recent update of the dataset: - username - time - version	Checkpoint
externalDatasetConfig	Only returned for external datasets. Describes the storage provider and file path for the dataset.	External Dataset Config
relativeId	The ID of the dataset stripped of the instance name. To identify a dataset in other API calls, you use the numeric value after `datasets/`.	String
upstreamDatasetIds	A list of IDs of upstream datasets.	Array[String]
externalId	A case-insensitive ID that must be unique across all datasets. You can specify it at creation time. If not specified, Tamr Core sets it by default.	String

For example:

{
  "id": "unify://unified-data/v1/datasets/835",
  "name": "My Dataset",
  "description": "So much data in here!",
  "version": "521",
  "keyAttributeNames": [
    "F1"
  ],
  "tags": [],
  "created": {
    "username": "admin",
    "time": "2017-11-15T16:35:31.858Z",
    "version": "4703"
  },
  "lastModified": {
    "username": "admin",
    "time": "2017-11-15T16:35:31.910Z",
    "version": "4708"
  },
  "relativeId": "datasets/835",
  "upstreamDatasetIds": [
    "unify://unified-data/v1/datasets/181"
  ],
  "externalId": "My Dataset"
}

See List all datasets.