User GuidesAPI ReferenceRelease NotesEnrichment APIs
Doc HomeSupportLog In

The Project JSON Object

The JSON key:value pairs that describe projects in call responses.

This JSON object provides data and metadata about a project:

Key

Value Description

Type

id

The deployment-specific ID for the project. Unique across the Tamr Core deployment.

Example:
unify://unified-data/v1/projects/5

To identify a project in other API calls, you use the numeric value after projects/.

String

name

The user-defined display name of the project. Must be unique.

String

description

Optional. The user-defined description of the project.

String

type

The user-specified project type. The type can be:

  • SCHEMA_MAPPING_RECOMMENDATIONS
  • DEDUP (for a mastering project)
  • GOLDEN_RECORDS
  • CATEGORIZATION

Project Type

unifiedDatasetName

The user-defined name for the project's unified dataset.

String

created

Metadata about the creation of the project:

  • username
  • time
  • version

Object

lastModified

Metadata about the most recent update of the project:

  • username
  • time
  • version

Object

relativeId

The ID of the project stripped of the instance name.

To identify a project in other API calls, you use the numeric value after projects/.

String

externalId

A case-insensitive ID which must be unique across all projects. It can be specified at creation or will be set by default.

String

An example follows:

{
    "id": "unify://unified-data/v1/projects/1",
    "name": "Example Mastering Project",
    "description": "Example Mastering Project",
    "type": "DEDUP",
    "unifiedDatasetName": "Example_Mastering_Project_Unified_Dataset",
    "created": {
      "username": "admin",
      "time": "2019-02-07T13:50:07.035Z",
      "version": "21"
    },
    "lastModified": {
      "username": "admin",
      "time": "2019-02-07T13:50:07.035Z",
      "version": "21"
    },
    "relativeId": "projects/1",
    "externalId": "Example Mastering Project"
  }

See List all projects.