Get a table

get/dataTables/dataSources/{dataTableProviderId}/tables/{tableName}
Internal-Use Only

Returns a specific table. Supports both loaded and unloaded tables.

Request Samples

1

Response Samples

1No example avaliable

Path Parameters

NameTypeRequiredDescription
dataTableProviderId
string
true

See Data Tables API documentation for details about dataTableProviderId. A sample value is cas~fs~serverName~fs~caslibName.

tableName
string
true

The name of the table.

Query Parameters

NameTypeRequiredDescription
loaded
boolean
false

Determines whether a loaded table is included in the results. Defaults to true. Note that a value of false does not imply that a source table should be included, only that a loaded table should be excluded.

scope
string
false

When a loaded table is included, determines which loaded table is returned. Valid values include: all - Includes tables in both session scope and global scope global - Includes tables only in a global scope Defaults to all.

sources
boolean
false

Determines whether a source table is included in the results. Defaults to true. Note that a value of false does not imply that a loaded table should be included, only that a source table should be excluded.

detailGroups
array [string]
false

A comma-separated list of detail groups to return in the representation. Some detail groups require more time to retrieve. This parameter allows opting-in to the following detail groups in cases where they are not already included: all - Include all detail groups unloaded Columns - Include column counts for unloaded tables. This information is retrieved if available from the source. unloadedRows - Include row counts for unloaded tables. This information is retrieved if available from the source. Row counts from HDFS are not provided.

Allowed values:
allunloadedColumnsunloadedRows

Responses

StatusMeaningDescription
200OKThe request succeeded. The list of tables was returned.
400Bad RequestThe request was invalid.Schema
404Not FoundThe requested CAS server or Caslib does not exist.
409ConflictThe request could not be completed due to a conflict with the current state of the resource. Details are included in the response body.