Get a data asset by id

GET

data-asset

{id}

curl --request GET \
  --url https://{hostname}.gable.ai/v0/data-asset/{id} \
  --header 'X-API-KEY: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataAssetResourceName": "<string>",
  "domain": "<string>",
  "path": "<string>",
  "type": "postgres",
  "versionDetail": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dataAssetVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "nativeDataType": "<string>",
        "type": {},
        "displayType": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "order": 123,
        "parentFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "deletedAt": "2023-11-07T05:31:56Z",
        "piiCategory": "phone",
        "profile": {
          "sampledRecordsCount": 123,
          "nullable": true,
          "sampledFiles": [
            "<string>"
          ],
          "samplingParameters": {
            "rowSampleCount": 123,
            "recentFileCount": 123
          },
          "profileType": "boolean",
          "trueCount": 123,
          "falseCount": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "nullCount": 123,
          "sampledDate": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "violations": [
      {
        "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contractVersion": "<string>",
        "contractFieldName": "<string>",
        "entityType": "DATA_CONTRACT",
        "violationType": "MISSING_REQUIRED_PROPERTY",
        "dataAssetResourceName": "<string>",
        "expectedValue": "<string>",
        "actualValue": "<string>",
        "contractName": "<string>",
        "contractDomain": "<string>",
        "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventType": "VIOLATION",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prLink": "<string>"
      }
    ],
    "description": "<string>",
    "rawSchema": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contractId": "<string>",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string<uuid>

required

UUID of the data asset

Response

Data asset

string<uuid>

required

The unique identifier for the data asset.

dataAssetResourceName

string

required

The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'

domain

string

required

The domain to which the data asset belongs. Previously referred to as "namespace."

path

string

required

The name or path identifying the data asset. Previously referred to as "name."

type

enum<string>

required

The type of the source data asset, indicating its source or format (e.g., postgres, protobuf).

Available options:

postgres,

mysql,

mssql,

json_schema,

avro,

protobuf,

python,

pyspark,

typescript,

java,

s3,

dataframe,

kotlin,

swift,

php,

golang

versionDetail

object

required

The version details of the data asset.

Show child attributes

versionDetail.id

string<uuid>

required

The unique identifier for the version of the data asset.

versionDetail.dataAssetId

string<uuid>

required

The identifier of the parent data asset to which this version belongs.

versionDetail.fields

object[]

required

The fields of the data asset.

Show child attributes

versionDetail.fields.id

string<uuid>

required

The unique identifier for the data asset field.

versionDetail.fields.dataAssetVersionId

string<uuid>

required

The identifier of the data asset version this field belongs to.

versionDetail.fields.name

string

required

The name of the field.

versionDetail.fields.nativeDataType

string

required

The native data type of the field in the source system.

versionDetail.fields.type

object

required

A custom or specific attribute to represent the Gable type of the field.

versionDetail.fields.displayType

string

required

The display name of the field.

versionDetail.fields.createdAt

string<date-time>

required

The timestamp when the field was created.

versionDetail.fields.updatedAt

string<date-time>

required

The timestamp when the field was last updated.

versionDetail.fields.description

string

A brief description of the field.

versionDetail.fields.order

integer

The order or position of the field in the data asset.

versionDetail.fields.parentFieldId

string<uuid>

For nested fields, this is the ID of the parent field.

versionDetail.fields.deletedAt

string<date-time>

The timestamp when the field was marked as deleted.

versionDetail.fields.piiCategory

enum<string> | null

type of pii detected in the column name

Available options:

phone,

email,

credit_card,

address,

person,

birth_date,

gender,

nationality,

ssn,

zip_code,

po_box,

user_name,

password,

religion,

sexual_orientation,

drivers_license,

passport,

birth_certificate,

medicare,

concession_card,

fingerprint,

face_scan,

bank_details,

contact_details,

tax_file_number

versionDetail.fields.profile

object

generic data asset field profile Data asset field profile for boolean

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8

Show child attributes

versionDetail.fields.profile.sampledRecordsCount

integer

required

Number of samples

versionDetail.fields.profile.nullable

boolean

required

Whether the data is nullable

versionDetail.fields.profile.sampledFiles

string[]

required

List of sampled files

Minimum array length: 1

versionDetail.fields.profile.samplingParameters

object

required

The parameters used to sample the data

Show child attributes

versionDetail.fields.profile.samplingParameters.rowSampleCount

integer

required

Number of rows sampled per file

versionDetail.fields.profile.samplingParameters.recentFileCount

integer

Number of most recent files whose schemas are sampled per data asset

versionDetail.fields.profile.profileType

enum<string>

required

Available options:

boolean

versionDetail.fields.profile.trueCount

integer

required

Number of true values

versionDetail.fields.profile.falseCount

integer

required

Number of false values

versionDetail.fields.profile.id

string<uuid>

Unique identifier for the data asset field profile in UUID format

versionDetail.fields.profile.nullCount

integer

Number of nulls (only defined if nullable is true)

versionDetail.fields.profile.sampledDate

string<date-time>

The date the sample was taken

versionDetail.createdAt

string<date-time>

required

The timestamp when this version of the data asset was created.

versionDetail.updatedAt

string<date-time>

required

The timestamp when this version of the data asset was last updated.

versionDetail.violations

object[]

required

List of contract violations associated with the data asset version.

Show child attributes

versionDetail.violations.contractId

string<uuid>

required

Unique identifier for the contract in UUID format

versionDetail.violations.contractVersion

string

required

Version of the contract

versionDetail.violations.contractFieldName

string

required

Field of the contract where violation occured

versionDetail.violations.entityType

enum<string>

required

The type of entity that the changelog event is associated with.

Available options:

DATA_CONTRACT

versionDetail.violations.violationType

enum<string>

required

Type of violation

Available options:

MISSING_REQUIRED_PROPERTY,

INCOMPATIBLE_TYPE,

GREATER_THAN,

GREATER_THAN_OR_EQUAL_TO,

LESS_THAN,

LESS_THAN_OR_EQUAL_TO,

IS_NULL,

IS_NULL_THRESHOLD,

IS_NOT_EMPTY,

LENGTH,

LENGTH_GREATER_THAN,

LENGTH_GREATER_THAN_OR_EQUAL_TO,

LENGTH_LESS_THAN,

LENGTH_LESS_THAN_OR_EQUAL_TO,

MISSING_DATA_ASSET,

PII_DETECTED

versionDetail.violations.dataAssetResourceName

string

required

The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'

versionDetail.violations.expectedValue

string

required

Expected value of the field

versionDetail.violations.actualValue

string

required

actual value of the field

versionDetail.violations.contractName

string

Name of the contract

versionDetail.violations.contractDomain

string

Domain of the contract

versionDetail.violations.dataAssetFieldProfileId

string<uuid>

Unique identifier for the data asset field in UUID format

versionDetail.violations.eventType

enum<string>

The type of event that occurred

Available options:

VIOLATION

versionDetail.violations.userId

string<uuid>

Unique identifier for the user in UUID format

versionDetail.violations.prLink

string

Link to the pull request associated with the violation

versionDetail.description

string

A brief description of this particular version of the data asset.

versionDetail.rawSchema

string

The raw schema of the data asset from the source system. This can be the contents of a schema file or data from the information schema of a database. This is used to regenerate the schema of the data asset if needed.

versionDetail.deletedAt

string<date-time>

The timestamp when this version of the data asset was marked as deleted, if applicable.

createdAt

string<date-time>

required

The timestamp of when the data asset was initially created.

updatedAt

string<date-time>

required

The timestamp of the most recent update to the data asset.

contractId

string

The contract ID associated with the data asset.

deletedAt

string<date-time>

The timestamp indicating when the data asset was deleted, if applicable.

Delete a data asset by idDelete a data asset by id

⌘I

Get a data asset by id

curl --request GET \
  --url https://{hostname}.gable.ai/v0/data-asset/{id} \
  --header 'X-API-KEY: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataAssetResourceName": "<string>",
  "domain": "<string>",
  "path": "<string>",
  "type": "postgres",
  "versionDetail": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dataAssetVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "nativeDataType": "<string>",
        "type": {},
        "displayType": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "order": 123,
        "parentFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "deletedAt": "2023-11-07T05:31:56Z",
        "piiCategory": "phone",
        "profile": {
          "sampledRecordsCount": 123,
          "nullable": true,
          "sampledFiles": [
            "<string>"
          ],
          "samplingParameters": {
            "rowSampleCount": 123,
            "recentFileCount": 123
          },
          "profileType": "boolean",
          "trueCount": 123,
          "falseCount": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "nullCount": 123,
          "sampledDate": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "violations": [
      {
        "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contractVersion": "<string>",
        "contractFieldName": "<string>",
        "entityType": "DATA_CONTRACT",
        "violationType": "MISSING_REQUIRED_PROPERTY",
        "dataAssetResourceName": "<string>",
        "expectedValue": "<string>",
        "actualValue": "<string>",
        "contractName": "<string>",
        "contractDomain": "<string>",
        "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventType": "VIOLATION",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prLink": "<string>"
      }
    ],
    "description": "<string>",
    "rawSchema": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contractId": "<string>",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Introduction

Gable

Authorizations

Path Parameters

Response