Assets

The Assets API allows you to search, retrieve, and update data assets within your Decube organization. Use these endpoints to automate asset discovery, manage metadata, and integrate asset information into your data workflows and applications.

Search Assets

post

Search assets with optional filters for type, parent, classifications, owners, and custom attributes. Returns up to 10000 paginated results matching the specified criteria.

Body

querystring · nullableOptional

Search term to match against

search_typestring · enumOptional

Type of search to perform. For exact searches, this is matched exactly against the name field. For fuzzy searches, this is matched approximately against relevant fields.

Default: exactPossible values:

asset_typestring · enum · nullableOptional

Filter results to specific asset types only

Possible values:

classificationsstring[] · nullableOptional

Filter assets with any of the specified policy tags

data_ownersstring[] · nullableOptional

Filter assets owned by any of the specified data owners by email

business_ownersstring[] · nullableOptional

Filter assets owned by any of the specified business owners by email

show_deletedbooleanOptional

Include deleted assets in the results

Default: false

pageinteger · min: 1Optional

Page number of the results, page * page_size must not exceed 10000

Default: 1

page_sizeinteger · min: 1 · max: 1000Optional

Number of results per page, page * page_size must not exceed 10000

Default: 10

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post/assets/search

POST /api/v1/data/assets/search HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 317

{
  "query": "text",
  "search_type": "exact",
  "asset_type": "source",
  "parent": {
    "id": 1,
    "type": "source"
  },
  "classifications": [
    "text"
  ],
  "data_owners": [
    "text"
  ],
  "business_owners": [
    "text"
  ],
  "custom_attributes": [
    {
      "config_id": 1,
      "operator": "AND",
      "type": "text",
      "condition": "text",
      "value": true
    }
  ],
  "show_deleted": false,
  "page": 1,
  "page_size": 10
}

{
  "data": [
    {
      "asset": {
        "id": 1,
        "name": "text",
        "type": "source"
      },
      "parents": [
        {
          "id": 1,
          "name": "text",
          "type": "source"
        }
      ],
      "attrs": {
        "source_type": "bigquery",
        "data_owners": [
          {
            "email": "text",
            "id": "text"
          }
        ],
        "business_owners": [
          {
            "email": "text",
            "id": "text"
          }
        ],
        "description": "text",
        "linked_terms": [
          {
            "id": 1,
            "type": "source"
          }
        ],
        "custom_attributes": [
          {
            "id": 1,
            "type": "text",
            "value": 1
          }
        ]
      }
    }
  ]
}

Get Asset

get

Get a specific asset by ID and type. Returns the asset details along with its parent hierarchy and attributes.

Query parameters

asset_idinteger · min: 1Required

Unique identifier of the specific asset

asset_typestring · enumRequired

Type of the specific asset

Possible values:

Responses

200

Successful Response

application/json

attrsany ofRequired

or

or

or

or

or

or

or

object · DataTaskAttributesOptional

or

or

or

or

422

Validation Error

application/json

get/assets

GET /api/v1/data/assets?asset_id=1&asset_type=source HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

{
  "asset": {
    "id": 1,
    "name": "text",
    "type": "source"
  },
  "parents": [
    {
      "id": 1,
      "name": "text",
      "type": "source"
    }
  ],
  "attrs": {
    "source_type": "bigquery",
    "data_owners": [
      {
        "email": "text",
        "id": "text"
      }
    ],
    "business_owners": [
      {
        "email": "text",
        "id": "text"
      }
    ],
    "description": "text",
    "linked_terms": [
      {
        "id": 1,
        "type": "source"
      }
    ],
    "custom_attributes": [
      {
        "id": 1,
        "type": "text",
        "value": 1
      }
    ]
  }
}

Update Asset

patch

Update modifiable attributes for various asset types.

Body

or

or

or

or

or

or

or

or

or

or

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

patch/assets

PATCH /api/v1/data/assets HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "asset_id": 1,
  "asset_type": "text",
  "data_owners": [
    "text"
  ],
  "business_owners": [
    "text"
  ],
  "description": "text",
  "linked_terms": [
    {
      "type": "text",
      "id": 1
    }
  ],
  "custom_attributes": [
    {
      "type": "text",
      "id": 1,
      "value": 1
    }
  ]
}

No content