Get the headers for an auto-generated business description

head/instances/{instanceId}/businessDescription

Given an instance ID for a dataset, get the headers for 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

1Not Available

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
200OK

OK.

Headers
400Bad Request

Bad request (the request is not well-formed).

Schema
401Unauthorized

Not authenticated.

Schema
403Forbidden

The user does not have permission to complete this request.

Schema
404Not Found

The specified resource was not found.

Schema
406Not Acceptable

Not Acceptable. Include an Accept header with a supported value on the request.

Schema