Get an auto-generated business description

get/instances/{instanceId}/businessDescription
Internal-Use Only

Given an instance ID for a dataset generate a description for that dataset. The dataset must have a subtype such as CAStable or SASTable. Date formats will default to en-US if the Accept-Language header is not specified or a non-supported language.

Request Samples

1

Response Samples

1This dataset contains information about health. This dataset contains information about the following entities: individual.
2This dataset contains information from multiple city and state locations.
3The most important columns are date.
4The storage format is ORC.
5The frequency of observations is yearly. The data was collected on 4/19/22.
6The data contains outliers and has values that could be considered private.
7

Path Parameters

NameTypeRequiredDescription
instanceId
string
true

The ID of the Instance

Query Parameters

NameTypeRequiredDescription
region
string
false

The region code to use for formatting dates in the description

suppressMostImportantColumns
boolean
false

Set to true to suppress the "most important columns" aspect of the description. Defaults to false.

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired item representation for the response. The default is text/plain.

Allowed values:
text/plaintext/html

Responses

StatusMeaningDescription
200OKOK.HeadersSchema
400Bad RequestBad request (the request is not well-formed).Schema
401UnauthorizedNot authenticated.Schema
403ForbiddenThe user does not have permission to complete this request.Schema
404Not FoundThe specified resource was not found.Schema
406Not AcceptableNot Acceptable. Include an Accept header with a supported value on the request.Schema