Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /ariel/databases/{database_name}

SUMMARY Retrieve the columns that are defined for a specific Ariel database.

Retrieve the columns that are defined for the specified Ariel database. This is the set of columns that can be explicitly named in the column list of a SELECT query.

Table 1: GET /ariel/databases/{database_name} resource details:

GET /ariel/databases/{database_name} resource details

MIME Type

application/json

Table 2: GET /ariel/databases/{database_name} request parameter details:

GET /ariel/databases/{database_name} request parameter details

Parameter Type Optionality Data Type MIME Type Description

database_name

path

Required

String

text/plain

Required. The name of the Ariel database that contains the columns that you want to retrieve.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Table 3: GET /ariel/databases/{database_name} response codes:

GET /ariel/databases/{database_name} response codes

HTTP Response Code Unique Code Description

200

The database columns were retrieved.

404

1002

The database does not exist.

Response Description

A list of columns that are defined for the specified database. Multiple properties of each column are returned. For example, the column name or an indication that the column is indexable.

Response Sample