User GuidesAPI ReferenceRelease NotesEnrichment APIs
Doc HomeHelp CenterLog In

The Operation JSON Object

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

This JSON object provides data and metadata about a processing job or operation. To check the status of an operation, use Get a list of all operations or Fetch an operation.

Field

Description

Type

id

The deployment-specific ID of the operation returned. Unique across the entire deployment of Tamr.

String

type

The type of operation submitted, for example, SPARK.

String

description

The description of the operation submitted, for example, "Train Mastering Model".

String

status

An object describing the state of the operation with:

  • state, such as PENDING, RUNNING, CANCELED, FAILED, or SUCCEEDED.
  • startTime
  • endTime
  • message, for example, "Pending job canceled by admin"

Status

created

Metadata about the creation of the operation:

  • username
  • time
  • version

Object

lastModified

Metadata about the most recent update of the operation:

  • username
  • time
  • version

Object

relativeId

The relative ID of the operation returned. Unique across the specific instance of Tamr.

To identify an operation in other API calls, you use the numeric value after operations/.

String

An example follows:

{
  "id": "10",
  "type": "SPARK",
  "description": "Publish clusters",
  "status": {
    "state": "SUCCEEDED",
    "startTime": "2019-02-27T15:43:02.478Z",
    "endTime": "2019-02-27T15:48:16.019Z",
    "message": ""
  },
  "created": {
    "username": "admin",
    "time": "2019-02-27T15:42:43.703Z",
    "version": "1757"
  },
  "lastModified": {
    "username": "system",
    "time": "2019-02-27T15:48:18.180Z",
    "version": "1857"
  },
  "relativeId": "operations/10"
}