Skip to content

REST-based Tagging

Audience: System Administrators

Content Summary: When implemented, this standard REST interface can tag new data sources automatically.

This page lists the REST endpoints and provides examples of responses.

Tag Info Endpoint

Method Path Description
GET <Tag Info Endpoint> Returns all tags to be synced into Immuta.

Response:

{"Root.Child1": {"id": 100}, "Root.Child2.GrandChild": {"id": 200}}

Data Source Info Endpoint

Method Path Description
POST <Data Source Info Endpoint> Takes a payload containing catalogMetadata, handlerInfo, and data source info (key will just be dataSource).

The catalogMetadata object must contain a field id that will uniquely identify the data source, but the object can also contain any other needed information.

Response:

{
  "catalogMetadata": {
    "name": "Test1",
    "id": 10,
  },
  "description": "A good description",
  "tags": {
    "Root.Child1": {"id": 100},
    "Root.Child2.GrandChild": {"id": 200}
  },
  "table": "a",
  "schema": "b",
  "dictionary": {
    "aColName": {
      "catalogMetadata": {"id": 50},
      "description": "This column will hold some good data",
      "tags": {
        "Root.Child2.GrandChild": {"id": 200},
        "OtherRoot.Child1": {"id": 300},
        "New.Tag": {"id": 400}
      }
    }
  }
}
Method Path Description
GET <Data Source Link URL> Returns a valid webpage that displays information about the data source.

The URL can be formatted as /dataSource/page/{id}; any information inside curly braces in the URL will be looked up in the catalogMetadata. Dot-separated paths are accepted, so /dataSource/page/{aKey.subKey} would return the info stored at catalogMetadata.aKey.subKey.

Method Path Description
GET <Column Link URL> Returns a valid webpage that displays information about the column.

This endpoint accepts the same URL format as the data source link URL.