Get data assets by a list of DARNs

GET

data-assets

bulk

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

{
  "data": [
    {
      "darn": "<string>",
      "status": "success",
      "data": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dataAssetResourceName": "<string>",
        "domain": "<string>",
        "path": "<string>",
        "type": "postgres",
        "updatedAt": "2023-11-07T05:31:56Z",
        "contractId": "<string>"
      },
      "errorMessage": "<string>"
    }
  ],
  "totalCount": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

darns

string[]

required

List of Data Asset Resource Names to fetch

Minimum array length: 1

limit

integer

default:1000

Maximum number of results to return (default is 1000)

Required range: 1 <= x <= 1000

offset

integer

default:0

Number of results to skip (default is 0)

Required range: x >= 0

Response

Data assets with status information for each DARN

data

object[]

required

Show child attributes

data.darn

string

required

The Data Asset Resource Name that was requested

data.status

enum<string>

required

The status of fetching this particular asset

Available options:

success,

not_found,

error

data.data

object

The asset data (only present when status is 'success')

Show child attributes

data.data.id

string<uuid>

required

The unique identifier for the data asset.

data.data.dataAssetResourceName

string

required

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

data.data.domain

string

required

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

data.data.path

string

required

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

data.data.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

data.data.updatedAt

string<date-time>

required

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

data.data.contractId

string

The contract ID associated with the data asset.

data.errorMessage

string

Error message (only present when status is 'error' or 'not_found')

totalCount

integer

required

Total number of results available

limit

integer

required

Maximum number of results per page

offset

integer

required

Number of results skipped

Get data assets countGet data assets count

⌘I

Get data assets by a list of DARNs

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

{
  "data": [
    {
      "darn": "<string>",
      "status": "success",
      "data": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dataAssetResourceName": "<string>",
        "domain": "<string>",
        "path": "<string>",
        "type": "postgres",
        "updatedAt": "2023-11-07T05:31:56Z",
        "contractId": "<string>"
      },
      "errorMessage": "<string>"
    }
  ],
  "totalCount": 123,
  "limit": 123,
  "offset": 123
}

Introduction

Gable

Get data assets by a list of DARNs

Authorizations

Query Parameters

Response