Update the state of a list's rows

put/lists/{listId}/contents/state

Internal-Use Only

Updates the state of a list's rows synchronously via a JSON request body.

Optionally, you can update the expiry of the selected rows. When rows are deployed using this parameter, their expiries are also updated, even if the rows were already deployed.

The expiry value of a row is represented as a UNIX timestamp, which is the number of seconds since the UNIX epoch (January 1, 1970).

If the value for the 'exactExpiry' property is 'true', the value provided is taken to be a UNIX timestamp and is used directly. Otherwise, it is used as an offset, which is the number of seconds after now that the rows should expire.

A request body to update the state of rows in a list must contain a collection of data record objects with keys that match the column definitions.

The desired state (developing or deployed) must be specified in the body of the request.

Request Samples

application/vnd.sas.collection+json
1

Response Samples

200
application/vnd.sas.listdata.list+json
1{
2  "id": "3659ea38-2618-4474-aeac-0bf6cfd3c322",
3  "version": 1,
4  "creationTimeStamp": "2022-03-01T20:18:32Z",
5  "modifiedTimeStamp": "2022-03-01T20:18:32Z",
6  "createdBy": "appUser1",
7  "modifiedBy": "appUser1",
8  "name": "list-a",
9  "description": "The A-list users",
10  "state": "developing",
11  "columns": [
12    {
13      "name": "userId",
14      "dataType": "string",
15      "position": 1,
16      "isKey": true,
17      "keyPosition": 1
18    },
19    {
20      "name": "firstName",
21      "dataType": "string",
22      "position": 2,
23      "isKey": false,
24      "keyPosition": 0
25    },
26    {
27      "name": "lastName",
28      "dataType": "string",
29      "position": 3,
30      "isKey": false,
31      "keyPosition": 0
32    },
33    {
34      "name": "salary",
35      "dataType": "number",
36      "position": 4,
37      "isKey": false,
38      "keyPosition": 0,
39      "dataMask": {
40        "name": "MaskStart",
41        "regex": ".(....$)|.",
42        "replace": "*$1",
43        "example": "****1234"
44      }
45    }
46  ],
47  "label": "corporate marketing",
48  "links": [
49    {
50      "href": "...",
51      "method": "...",
52      "rel": "...",
53      "uri": "..."
54    }
55  ]
56}

Path Parameters

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

Request Body

Name	Type	Required	Description
items	array [object]	false

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
409	Conflict	The request could not be completed due to a conflict with an existing resource.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema