Get a column

get/dataSources/{dataSourceId}/tables/{tableId}/columns/{columnId}
Internal-Use Only

Returns information about a single column based on its unique name.

Request Samples

1

Response Samples

1{
2  "name": "MSRP",
3  "type": "double",
4  "index": 3,
5  "rawLength": 8,
6  "formattedLength": 8,
7  "version": 2,
8  "format": {
9    "name": "DOLLAR",
10    "length": 8,
11    "decimals": 0
12  },
13  "informat": {
14    "length": 0,
15    "decimals": 0
16  },
17  "links": [
18    {
19      "method": "GET",
20      "rel": "self",
21      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/MSRP",
22      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/MSRP",
23      "type": "application/vnd.sas.data.column"
24    },
25    {
26      "method": "GET",
27      "rel": "alternate",
28      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/MSRP",
29      "uri": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns/MSRP",
30      "type": "application/vnd.sas.data.column.summary"
31    },
32    {
33      "method": "GET",
34      "rel": "up",
35      "href": "/dataTables/dataSources/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns",
36      "uri": "/dataTables/dataTableProviders/cas~cas-shared-default~fs~MYCASLIB/tables/AIRLINES/columns",
37      "type": "application/vnd.sas.collection",
38      "itemType": "application/vnd.sas.data.column"
39    }
40  ]
41}

Path Parameters

NameTypeRequiredDescription
columnId
string
true

The URL encoded (i.e. Percent encoded) form of the column's name.

dataSourceId
string
true

The name of the data source. Its format is providerIdfssourceIdfslibraryName. The format is a tilda encoded form composed of the following: providerId: name of the provider. Examples: cas, Compute Use GET /dataSources/providers to see the list of available providers. sourceId: refers to server id in case of cas and computeContextId in case of compute. An example sourceId for cas is cas-shared-default. An example sourceId for Compute is 97751fe6-8313-487f-865a-f941c8a75f8f (SAS Studio Compute Context). Use GET /dataSources/providers/{providerId}/sources to see the list of available sources. libraryName: name of the library. Use GET /dataSources/providers/{providerId}/sources/{sourceId}/children to see the the list of available libraries. An example dataSourceId for cas is casfscas-shared-defaultfsmodels. An example dataSourceId for Compute is Computefs97751fe6-8313-487f-865a-f941c8a75f8ffssashelp.

tableId
string
true

The URL encoded (i.e. Percent encoded) form of the table's name.

Query Parameters

NameTypeRequiredDescription
preserveSession
boolean
false

This has effect only when the sessionId query parameter is not specified. If this is set to true, no sessionId is provided, the session created by the data service provider is not be terminated. All returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId. If set to false, or not specified, the session is be terminated after the request is complete. The default is false.

sessionId
string
false

The unique identifier of the session used to access the data service provider's backing service. When this is not specified, the data service provider creates a temporary session, and then terminates it after the request is complete. If this is specified, all returned links, except the "self" link, have the sessionId query parameter added to their respective URIs. Also, they contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
404Not FoundOne of the following resources does not exist: <ul> <li>The data source</li> <li>The table</li> <li>The column</li> </ul> Schema