Provider Exchange Filter

View as Markdown

List exchange filtersGET /api/2.0/marketplace-exchange/filtersCreate a new exchange filterPOST /api/2.0/marketplace-exchange/filtersUpdate exchange filterPUT /api/2.0/marketplace-exchange/filters/{id}Delete an exchange filterDELETE /api/2.0/marketplace-exchange/filters/{id}

ExchangeFilter object

idstringPublic Preview

exchange_idstringPublic Preview

filter_valuestringPublic Preview

namestringPublic Preview

created_atint64Public Preview

created_bystringPublic Preview

updated_atint64Public Preview

updated_bystringPublic Preview

filter_typestringPublic Preview

Values:

• GLOBAL_METASTORE_ID

View as Markdown

The ExchangeFilter object

{
  "id": "string",
  "exchange_id": "string",
  "filter_value": "string",
  "name": "string",
  "created_at": 0,
  "created_by": "string",
  "updated_at": 0,
  "updated_by": "string",
  "filter_type": "GLOBAL_METASTORE_ID"
}

List exchange filters Public Preview

GET /api/2.0/marketplace-exchange/filters

List exchange filter

API scopes: marketplace

Parameters

exchange_idstringRequiredquery

page_tokenstringquery

page_sizeint32query

Response

Returns a list of ExchangeFilter objects.

View as Markdown

Response

{
  "filters": [
    {
      "id": "string",
      "exchange_id": "string",
      "filter_value": "string",
      "name": "string",
      "created_at": 0,
      "created_by": "string",
      "updated_at": 0,
      "updated_by": "string",
      "filter_type": "GLOBAL_METASTORE_ID"
    }
  ],
  "next_page_token": "string"
}

Create a new exchange filter Public Preview

POST /api/2.0/marketplace-exchange/filters

Add an exchange filter.

API scopes: marketplace

Request body

filterobjectRequired

Show child attributesHide child attributes

idstring

exchange_idstringRequired

filter_valuestringRequired

namestring

created_atint64

created_bystring

updated_atint64

updated_bystring

filter_typestringRequired

Values:

• GLOBAL_METASTORE_ID

Response

filter_idstring

View as Markdown

Request

{
  "filter": {
    "id": "string",
    "exchange_id": "string",
    "filter_value": "string",
    "name": "string",
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "filter_type": "GLOBAL_METASTORE_ID"
  }
}

Response

{
  "filter_id": "string"
}

Update exchange filter Public Preview

PUT /api/2.0/marketplace-exchange/filters/{id}

Update an exchange filter.

API scopes: marketplace

Parameters

idstringRequiredpath

Request body

filterobjectRequired

Show child attributesHide child attributes

idstring

exchange_idstringRequired

filter_valuestringRequired

namestring

created_atint64

created_bystring

updated_atint64

updated_bystring

filter_typestringRequired

Values:

• GLOBAL_METASTORE_ID

Response

filterobject

Show child attributesHide child attributes

idstring

exchange_idstringRequired

filter_valuestringRequired

namestring

created_atint64

created_bystring

updated_atint64

updated_bystring

filter_typestringRequired

Values:

• GLOBAL_METASTORE_ID

View as Markdown

Request

{
  "filter": {
    "id": "string",
    "exchange_id": "string",
    "filter_value": "string",
    "name": "string",
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "filter_type": "GLOBAL_METASTORE_ID"
  }
}

Response

{
  "filter": {
    "id": "string",
    "exchange_id": "string",
    "filter_value": "string",
    "name": "string",
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "filter_type": "GLOBAL_METASTORE_ID"
  }
}

Delete an exchange filter Public Preview

DELETE /api/2.0/marketplace-exchange/filters/{id}

Delete an exchange filter

API scopes: marketplace

Parameters

idstringRequiredpath

View as Markdown

Response

{}