Get a collection of rows by the filter criteria

post/tables/{tableId}/rows

Returns a collection of rows when a application/vnd.sas.data.row.set.criteria resource is provided in the body of the request. Standard paging options are provided. Sorting is provider dependent, but the default sort order is ascending by row order (i.e. index). If the provider has naturally unordered row data, it must allow for pagination in a consistent manner.

Request Samples

1

Response Samples

1{
2  "version": 1,
3  "cells": [
4    "Acura",
5    "MDX",
6    "SUV",
7    "$46,945",
8    "17",
9    "23"
10  ],
11  "links": [
12    {
13      "method": "GET",
14      "rel": "up",
15      "href": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~CARS/rows",
16      "uri": "/rowSets/tables/cas~fs~cas-shared-default~fs~MYCASLIB~fs~CARS/rows",
17      "type": "application/vnd.sas.collection",
18      "itemType": "application/vnd.sas.data.row"
19    }
20  ]
21}

Path Parameters

NameTypeRequiredDescription
tableId
string
true

The ID of the table. Its format is 'providerIdfssourceIdfslibraryNamefstableName'. 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 list of available libraries.
  • tableName: name of the table. Use GET /dataTables/dataSources/{dataSourceId}/tables to see the list of available tables in a library. An example tableId for cas is 'casfscas-shared-defaultfsmodelsfscars'. An example tableId for Compute is 'Computefs97751fe6-8313-487f-865a-f941c8a75f8ffscat-compfscars'.

Query Parameters

NameTypeRequiredDescription
excludeItemLinks
boolean
false

Excludes the links from this collection's items. Defaults to true.

includeIndex
boolean
false

Includes the row index as the first item in the row data. Defaults to false.

limit
integer<int32>
false

Pagination parameter, which specifies how many items to return.

Default:
10
preserveSession
boolean
false

This parameter has effect only if the sessionId query parameter is not specified. If set to true, and no sessionId is provided, the session created by the data service provider is not destroyed. All returned links, except the "self" link, will have the sessionId query parameter added to their respective URIs. Also, they will 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 deleted after the request is complete. Defaults to false.

sessionId
string
false

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

sortBy
string<sort-criteria>
false

The sorting criteria for the returned rows of data. The rows sorted by any valid column name. The default sort order is ascending by row order (i.e. index). Examples:

  • Sort ascending by column with id COLUMN_A: /rowSets/tables/{tableId}/rows?sortBy=COLUMN_A:ascending
  • Sort descending by column with id COLUMN_A: /rowSets/tables/{tableId}/rows?sortBy=COLUMN_A:descending
start
integer<int32>
false

Pagination parameter, which specifies the starting index.

Default:
0

Request Body

The WHERE clause to pass through to the underlying data service. This parameter acts as a filter on the provided data.

The WHERE clause to pass through to the underlying data service. This acts as a filter on the provided data. example: Make='Honda'.

Responses

StatusMeaningDescription
201Created

Created. The requested row has both been created.

HeadersSchema
400Bad Request

The request was invalid. The error might occur in one of the following scenarios:

  • A negative start value is provided.
  • A negative limit value is provided.
  • A non-existent column is specified in the sortBy parameter.
  • A non-existent resource member is specified in the excludeItemFields parameter.
Schema
404Not Found

No resource exists at the requested path. The table could not be found at the requested path.

Schema