data_management

2024.09

2024.03

Viya_35

2025.08

2025.09

2025.10

2025.03

2025.11

2025.07

The Row Sets API provides a common way to reference rows of rectangular data that are available in the SAS ecosystem. The URLs for this API are the only canonical form of storing data references for SAS Viya.

Row Sets

Returns header information and the status.

The request succeeded. The service is available.

Check the availability of the service

A list of links to top level resources available from the root of the API.

Error

A link to a related operation or resource.

Link

Row Collection

A paginated collection of rows and the columns in the cells of the row.

Row Set

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


WHERE Clause

This is an example of an error that could be returned for bad requests.

This is an example of an error that could be returned for resource not found.

rows

Pagination parameter, which specifies how many items to return.

limit

Pagination parameter, which specifies the starting index.

start

The ID of the table. Its format is 'providerId~fs~sourceId~fs~libraryName~fs~tableName'.
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 'cas~fs~cas-shared-default~fs~models~fs~cars'.
An example tableId for Compute is 'Compute~fs~97751fe6-8313-487f-865a-f941c8a75f8f~fs~cat-comp~fs~cars'.


tableId

The version number of the API representation. This is version 1.

Messages that provide additional details about the cause of the error.

A message that describes how to resolve the error.

The version number of the error representation. This representation is version 2.

application/vnd.sas.error

If this is a link to a container, `itemType` is the media type or link type for the items in the container.

The relationship of the link to the resource.

The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type for the link.

The cells for this row. Values can be number, integer, null, boolean, or string.

A space-separated list of link types of the items in this collection.

The number of results returned in the collection.

The name of the collection "rows" in the context of the request.

The 0-based index of the result candidates to start returning.

The number of columns in the collection. Can be omitted if the count is not known.

The level of detail of the columns array member. This value is set by the columnDetail query parameter. The value defaults to summary when none is provided.

The number of columns to return in each page. Defaults to 25. Omitted if the includeColumns query parameter is set.

The index of the first column in the columns member, 0-based. Defaults to 0. Omitted if the includeColumns query parameter is set.

The rows' corresponding columns. The type of items in this array is determined by the columnDetail query parameter's value, which can be one of the following:
- summary - The default if no value is specified. Contains application/vnd.sas.data.column.summary objects.
- detail - Contains application/vnd.sas.data.column objects.
- names - Contains the column names as JSON strings.


The actual number of rows returned in the collection.

The results of this query as an array containing arrays of heterogeneous data.

The 0-based index of the rows candidates to start returning.

SAS Developers

Returns a collection of links to the top-level collections that are surfaced through this API.

Returns a paginated collection of rows and their cell's corresponding columns. Standard paging options are provided. Sorting and
filtering options are 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.


Formats the cells of data. Defaults to true.

format

The sorting criteria for the returned rows of data. The rows can be sorted by any valid column name.
The default sort order is ascending by row order (i.e. index).
Example:
- Sort ascending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:ascending
- Sort descending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:descending


sortBy

Includes the row index as the first item in the row data. The default value is "false".

includeColumns

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


where

The desired column representation.
The columnDetail options yield the following in the columns member:
- summary - application/vnd.sas.data.column.summary
- detail - application/vnd.sas.data.column
- names - the column name as a string
If no value is specified, the default value is 'summary'.


columnDetail

The starting index of the first column in a page. The default value is "0".

columnStart

Maximum number of cells per row and columns to return in this page of results. The number of returned columns might be less if the collection has been exhausted. Defaults to 25.

columnLimit

The sorting criteria for returned columns and cells of data. The columns can be sorted by any valid column name.
The default sort order is ascending by column index. Some sample sorts:
Examples:
- Sort descending by column index descending: /rowSets/tables/{tableId}/rowSet?columnSortBy=index:descending
- Sort ascending by column name ascending: /rowSets/tables/{tableId}/rowSet?columnSortBy=name:ascending


columnSortBy

The unique identifier of the session used to access the data service provider''s backing service.
When this parameter is not specified, the data service provider creates a temporary session.
Then deletes the session 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 will contain an additional session link to the application/vnd.sas.data.session resource that corresponds to the provided sessionId.


sessionId

This parameter has effect only if the sessionId query parameter is not specified.
If this is 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 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 deleted after the request is complete.
The default setting is "false".


preserveSession

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 or includeColumns parameter.
- An invalid value is specified in a parameter (such as columnDetail=doesNotExist).


No resource exists at the requested path. The table that is associated with these rows does not exist.

Returns a paginated collection of rows and their cell's corresponding columns. Standard paging options are provided. Sorting and
filtering options are 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 pagination in a consistent manner.


Whether or not to format the cells of data. Defaults to true.

The sorting criteria for returned rows of data. The rows can be sorted by any valid column name.
The default sort order is ascending by row order (i.e. index). Some sample sorts:
Examples:
- Sort ascending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:ascending
- Sort descending by column with name COLUMN_A: /rowSets/tables/{tableId}/rowSet?sortBy=COLUMN_A:descending


The desired column representation. The columnDetail options listed below yield the following in the columns member.
- summary - application/vnd.sas.data.column.summary
- detail - application/vnd.sas.data.column
- names - the column name as a string
If no value is specified, the default value is 'summary'.


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 will create a temporary session, and then destroy it after the request is complete.
If this is specified 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.


This parameter has effect only if the sessionId query parameter is not specified.
If this is 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 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 will be destroyed after the request is complete. Defaults to false.


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

The request was invalid. An invalid request was made 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 or includeColumns parameter.
- An invalid value is specified in a parameter (such as columnDetail=doesNotExist).


Returns a collection of rows. Standard paging options are provided.
Sorting and filtering options are provider dependent, but the default
sort order is ascending by row order (for example, index). If the
provider has naturally unordered row data, it must allow for pagination
in a consistent manner.


Use this parameter to format the cells of data. Defaults to true.

The sorting criteria for the returned rows of data. The rows can be 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


Use this parameter to include the row index as the first item in the row data. Defaults to false.

includeIndex

Use this parameter to exclude the links from this collection's items. Defaults to true.

excludeItemLinks

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


The unique identifier of the session used to access the data service
provider's backing service. When this parameter is not specified,
the data service provider will create a temporary session and then
delete it after the request is complete. If this parameter is
specified, 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.


This string has effect only if the sessionId query parameter is not
specified. If this is set to true, and no sessionId is provided, the
session created by the data service provider will not be 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
will be destroyed after the request is complete. Defaults to false.


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.


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.


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


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

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

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.


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.


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


Created. The requested row has both been created.

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

Get a collection of rows by the filter criteria

Check the availability of the service

Request Samples

Response Samples

Responses