Get a list's contents

get/lists/{listId}/contents

Internal-Use Only

Returns a collection of the list's contents.

The operation supports filtering of the contents based on values for columns that are marked as key columns (for example, 'isKey' set to 'true'). Only the following filtering functions are supported:

the functions startsWith, endsWith, contains, and eq.
the logical function and(e1,e2,\[,..,eN\]) for grouping filters. This function cannot be nested or specified more than once within a filter string. The logical function or() is not supported.
a single function per key column. The example and(startWith(key1,"ABC"),endsWith(key1,"123")) is not supported.
filtering is not permitted on a key column if it has a data mask.

See Filtering in REST APIs for more information about filtering collections.

If a list includes data masking for any column, the value for that column is redacted.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "name": "listContents",
3  "version": 2,
4  "accept": "application/json",
5  "start": 0,
6  "limit": 10,
7  "count": 2,
8  "items": [
9    {
10      "x": "1",
11      "y": "1"
12    },
13    {
14      "x": "2",
15      "y": "2"
16    }
17  ],
18  "links": [
19    {
20      "href": "...",
21      "method": "...",
22      "rel": "...",
23      "uri": "..."
24    }
25  ]
26}

Path Parameters

Name	Type	Required	Description
listId	string	true	A universally unique identifier for a list.

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	The filter criteria for returned items. See Filtering in REST APIs.
limit	integer	false	The maximum number of items to return. The default value is '20'. Examples: 100
start	integer	false	A zero-based offset of the first item to return. The default value is '0'. Examples: 0

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
403	Forbidden	The user did not have the necessary permissions.		Schema
404	Not Found	No item exists at the requested path.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema