Provider Exchange

View as Markdown

GetGET /api/2.0/marketplace-exchange/exchanges/{id}ListGET /api/2.0/marketplace-exchange/exchangesCreatePOST /api/2.0/marketplace-exchange/exchangesUpdatePUT /api/2.0/marketplace-exchange/exchanges/{id}DeleteDELETE /api/2.0/marketplace-exchange/exchanges/{id}Add Exchange For ListingPOST /api/2.0/marketplace-exchange/exchanges-for-listingList Exchanges For ListingGET /api/2.0/marketplace-exchange/exchanges-for-listingRemove Exchange For ListingDELETE /api/2.0/marketplace-exchange/exchanges-for-listing/{id}List Listings For ExchangeGET /api/2.0/marketplace-exchange/listings-for-exchange

Exchange object

idstringPublic Preview

namestringPublic Preview

commentstringPublic Preview

filtersarray of objectPublic Preview

Show child attributesHide child attributes

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

created_atint64Public Preview

created_bystringPublic Preview

updated_atint64Public Preview

updated_bystringPublic Preview

linked_listingsarray of objectPublic Preview

Show child attributesHide child attributes

idstringPublic Preview

exchange_idstringPublic Preview

exchange_namestringPublic Preview

listing_idstringPublic Preview

listing_namestringPublic Preview

created_atint64Public Preview

created_bystringPublic Preview

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": "string"
    }
  ],
  "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 Public Preview

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

Get an exchange.

API scopes: marketplace

Parameters

idstringpath

Response

exchangeobject

Show child attributesHide child attributes

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

Response

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

List Public Preview

GET /api/2.0/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 Public Preview

POST /api/2.0/marketplace-exchange/exchanges

Create an exchange

API scopes: marketplace

Request body

exchangeobject

Show child attributesHide child attributes

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

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 Public Preview

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

Update an exchange

API scopes: marketplace

Parameters

idstringpath

Request body

exchangeobject

Show child attributesHide child attributes

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

Response

exchangeobject

Show child attributesHide child attributes

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

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 Public Preview

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

This removes a listing from marketplace.

API scopes: marketplace

Parameters

idstringpath

View as Markdown

Response

{}

Add Exchange For Listing Public Preview

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

Associate an exchange with a listing

API scopes: marketplace

Request body

listing_idstring

exchange_idstring

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 Public Preview

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

List exchanges associated with a listing

API scopes: marketplace

Parameters

listing_idstringquery

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 Exchange For Listing Public Preview

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

Disassociate an exchange with a listing

API scopes: marketplace

Parameters

idstringpath

View as Markdown

Response

{}

List Listings For Exchange Public Preview

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

List listings associated with an exchange

API scopes: marketplace

Parameters

exchange_idstringquery

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"
}