Consumer Fulfillment

View as Markdown

List all listing fulfillmentsGET /api/2.1/marketplace-consumer/listings/{listing_id}/fulfillmentsGet listing content metadataGET /api/2.1/marketplace-consumer/listings/{listing_id}/content

ListingFulfillment object

listing_idstringPublic Preview

fulfillment_typestringPublic Preview

Values:

• REQUEST_ACCESS
• INSTALL

share_infoobjectPublic Preview

Show child attributesHide child attributes

namestringPublic Preview

typestringPublic Preview

Values:

• SAMPLE
• FULL

repo_infoobjectPublic Preview

Show child attributesHide child attributes

git_repo_urlstringPublic Preview

the git repo url e.g. https://github.com/databrickslabs/dolly.git

recipient_typestringPublic Preview

Values:

• DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS
• DELTA_SHARING_RECIPIENT_TYPE_OPEN

View as Markdown

The ListingFulfillment object

{
  "listing_id": "string",
  "fulfillment_type": "REQUEST_ACCESS",
  "share_info": {
    "name": "string",
    "type": "SAMPLE"
  },
  "repo_info": {
    "git_repo_url": "string"
  },
  "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS"
}

List all listing fulfillments Public Preview

GET /api/2.1/marketplace-consumer/listings/{listing_id}/fulfillments

Get all listings fulfillments associated with a listing. A fulfillment is a potential installation. Standard installations contain metadata about the attached share or git repo. Only one of these fields will be present. Personalized installations contain metadata about the attached share or git repo, as well as the Delta Sharing recipient type.

API scopes: marketplace

Parameters

listing_idstringRequiredpath

page_tokenstringquery

page_sizeint32query

Response

Returns a list of ListingFulfillment objects.

View as Markdown

Response

{
  "fulfillments": [
    {
      "listing_id": "string",
      "fulfillment_type": "REQUEST_ACCESS",
      "share_info": {},
      "repo_info": {},
      "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS"
    }
  ],
  "next_page_token": "string"
}

Get listing content metadata Public Preview

GET /api/2.1/marketplace-consumer/listings/{listing_id}/content

Get a high level preview of the metadata of listing installable content.

API scopes: marketplace

Parameters

listing_idstringRequiredpath

page_tokenstringquery

page_sizeint32query

Response

shared_data_objectsarray of object

Show child attributesHide child attributes

namestring

Name of the shared object

data_object_typestring

The type of the data object. Could be one of: TABLE, SCHEMA, NOTEBOOK_FILE, MODEL, VOLUME

next_page_tokenstring

View as Markdown

Response

{
  "shared_data_objects": [
    {
      "name": "string",
      "data_object_type": "string"
    }
  ],
  "next_page_token": "string"
}