Exchange

View as Markdown

Get an exchangeGET /api/2.0/marketplace-exchange/exchanges/{id}List exchangesGET /api/2.0/marketplace-exchange/exchangesCreate an exchangePOST /api/2.0/marketplace-exchange/exchangesUpdate exchangePUT /api/2.0/marketplace-exchange/exchanges/{id}Delete an exchangeDELETE /api/2.0/marketplace-exchange/exchanges/{id}Add an exchange for listingPOST /api/2.0/marketplace-exchange/exchanges-for-listingList exchanges for listingGET /api/2.0/marketplace-exchange/exchanges-for-listingRemove an exchange for listingDELETE /api/2.0/marketplace-exchange/exchanges-for-listing/{id}List listings for exchangeGET /api/2.0/marketplace-exchange/listings-for-exchangeList 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}

Exchange object

idstring

namestring

commentstring

filtersarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

filter_valuestring

namestring

created_atint64

created_bystring

updated_atint64

updated_bystring

filter_typestring

Values:

• GLOBAL_METASTORE_ID

created_atint64

created_bystring

updated_atint64

updated_bystring

linked_listingsarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

View as Markdown

The Exchange object

{
  "id": "string",
  "name": "string",
  "comment": "string",
  "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"
    }
  ],
  "created_at": 0,
  "created_by": "string",
  "updated_at": 0,
  "updated_by": "string",
  "linked_listings": [
    {
      "id": "string",
      "exchange_id": "string",
      "exchange_name": "string",
      "listing_id": "string",
      "listing_name": "string",
      "created_at": 0,
      "created_by": "string"
    }
  ]
}

Get an exchange GA

GET /api/2.0/marketplace-exchange/exchanges/{id}

1 more path

GET /api/2.1/marketplace-exchange/exchanges/{id}

Get an exchange.

API scopes: marketplace

Parameters

idstringRequiredpath

Response

exchangeobject

Show child attributesHide child attributes

idstring

namestringRequired

commentstring

filtersarray of object

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

created_atint64

created_bystring

updated_atint64

updated_bystring

linked_listingsarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

View as Markdown

Response

{
  "exchange": {
    "id": "string",
    "name": "string",
    "comment": "string",
    "filters": [
      {}
    ],
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "linked_listings": [
      {}
    ]
  }
}

List exchanges GA

GET /api/2.0/marketplace-exchange/exchanges

1 more path

GET /api/2.1/marketplace-exchange/exchanges

List exchanges visible to provider

API scopes: marketplace

Parameters

page_tokenstringquery

page_sizeint32query

Response

Returns a list of Exchange objects.

View as Markdown

Response

{
  "exchanges": [
    {
      "id": "string",
      "name": "string",
      "comment": "string",
      "filters": [
        {}
      ],
      "created_at": 0,
      "created_by": "string",
      "updated_at": 0,
      "updated_by": "string",
      "linked_listings": [
        {}
      ]
    }
  ],
  "next_page_token": "string"
}

Create an exchange GA

POST /api/2.0/marketplace-exchange/exchanges

1 more path

POST /api/2.1/marketplace-exchange/exchanges

Create an exchange

API scopes: marketplace

Request body

exchangeobjectRequired

Show child attributesHide child attributes

idstring

namestringRequired

commentstring

filtersarray of object

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

created_atint64

created_bystring

updated_atint64

updated_bystring

linked_listingsarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

Response

exchange_idstring

View as Markdown

Request

{
  "exchange": {
    "id": "string",
    "name": "string",
    "comment": "string",
    "filters": [
      {}
    ],
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "linked_listings": [
      {}
    ]
  }
}

Response

{
  "exchange_id": "string"
}

Update exchange GA

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

1 more path

PUT /api/2.1/marketplace-exchange/exchanges/{id}

Update an exchange

API scopes: marketplace

Parameters

idstringRequiredpath

Request body

exchangeobjectRequired

Show child attributesHide child attributes

idstring

namestringRequired

commentstring

filtersarray of object

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

created_atint64

created_bystring

updated_atint64

updated_bystring

linked_listingsarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

Response

exchangeobject

Show child attributesHide child attributes

idstring

namestringRequired

commentstring

filtersarray of object

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

created_atint64

created_bystring

updated_atint64

updated_bystring

linked_listingsarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

View as Markdown

Request

{
  "exchange": {
    "id": "string",
    "name": "string",
    "comment": "string",
    "filters": [
      {}
    ],
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "linked_listings": [
      {}
    ]
  }
}

Response

{
  "exchange": {
    "id": "string",
    "name": "string",
    "comment": "string",
    "filters": [
      {}
    ],
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "linked_listings": [
      {}
    ]
  }
}

Delete an exchange GA

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

1 more path

DELETE /api/2.1/marketplace-exchange/exchanges/{id}

This removes a listing from marketplace.

API scopes: marketplace

Parameters

idstringRequiredpath

View as Markdown

Response

{}

Add an exchange for listing GA

POST /api/2.0/marketplace-exchange/exchanges-for-listing

1 more path

POST /api/2.1/marketplace-exchange/exchanges-for-listing

Associate an exchange with a listing

API scopes: marketplace

Request body

listing_idstringRequired

exchange_idstringRequired

Response

exchange_for_listingobject

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

View as Markdown

Request

{
  "listing_id": "string",
  "exchange_id": "string"
}

Response

{
  "exchange_for_listing": {
    "id": "string",
    "exchange_id": "string",
    "exchange_name": "string",
    "listing_id": "string",
    "listing_name": "string",
    "created_at": 0,
    "created_by": "string"
  }
}

List exchanges for listing GA

GET /api/2.0/marketplace-exchange/exchanges-for-listing

1 more path

GET /api/2.1/marketplace-exchange/exchanges-for-listing

List exchanges associated with a listing

API scopes: marketplace

Parameters

listing_idstringRequiredquery

page_tokenstringquery

page_sizeint32query

Response

exchange_listingarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

next_page_tokenstring

View as Markdown

Response

{
  "exchange_listing": [
    {
      "id": "string",
      "exchange_id": "string",
      "exchange_name": "string",
      "listing_id": "string",
      "listing_name": "string",
      "created_at": 0,
      "created_by": "string"
    }
  ],
  "next_page_token": "string"
}

Remove an exchange for listing GA

DELETE /api/2.0/marketplace-exchange/exchanges-for-listing/{id}

1 more path

DELETE /api/2.1/marketplace-exchange/exchanges-for-listing/{id}

Disassociate an exchange with a listing

API scopes: marketplace

Parameters

idstringRequiredpath

View as Markdown

Response

{}

List listings for exchange GA

GET /api/2.0/marketplace-exchange/listings-for-exchange

1 more path

GET /api/2.1/marketplace-exchange/listings-for-exchange

List listings associated with an exchange

API scopes: marketplace

Parameters

exchange_idstringRequiredquery

page_tokenstringquery

page_sizeint32query

Response

exchange_listingsarray of object

Show child attributesHide child attributes

idstring

exchange_idstring

exchange_namestring

listing_idstring

listing_namestring

created_atint64

created_bystring

next_page_tokenstring

View as Markdown

Response

{
  "exchange_listings": [
    {
      "id": "string",
      "exchange_id": "string",
      "exchange_name": "string",
      "listing_id": "string",
      "listing_name": "string",
      "created_at": 0,
      "created_by": "string"
    }
  ],
  "next_page_token": "string"
}

List exchange filters GA

GET /api/2.0/marketplace-exchange/filters

1 more path

GET /api/2.1/marketplace-exchange/filters

List exchange filter

API scopes: marketplace

Parameters

exchange_idstringRequiredquery

page_tokenstringquery

page_sizeint32query

Response

filtersarray of object

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

next_page_tokenstring

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 GA

POST /api/2.0/marketplace-exchange/filters

1 more path

POST /api/2.1/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 GA

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

1 more path

PUT /api/2.1/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 GA

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

1 more path

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

Delete an exchange filter

API scopes: marketplace

Parameters

idstringRequiredpath

View as Markdown

Response

{}