Get a collection of report states

get/reports/{reportId}/states

Internal-Use Only

Returns a collection of report states of the current user associated with a report with standard paging, filtering, and sorting options.

Request Samples

Response Samples

200
application/json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/states",
7      "uri": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/states",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/states?filter=and(eq(report.id,'8559a118-139b-46e4-adea-97198d9068f5'),eq(userId,'user1'))&sortBy=label&start=0&limit=20",
14      "uri": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/states?filter=and(eq(report.id,'8559a118-139b-46e4-adea-97198d9068f5'),eq(userId,'user1'))&sortBy=label&start=0&limit=20",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "POST",
19      "rel": "createReportState",
20      "href": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/states",
21      "uri": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/states",
22      "type": "application/vnd.sas.report.state.info",
23      "responseType": "application/vnd.sas.report.state.info"
24    }
25  ],
26  "name": "reportStates",
27  "accept": "application/vnd.sas.report.state.info",
28  "count": "1",
29  "items": [
30    {
31      "id": "cb237e1b-b11f-42fb-960c-a48a0c5b1688",
32      "label": "2020Timeline",
33      "userId": "user1",
34      "primary": "true",
35      "reportModifiedTimeStamp": "2018-03-02T19:33:41.124Z",
36      "creationTimeStamp": "2018-03-02T19:41:55.314Z",
37      "createdBy": "user1",
38      "modifiedTimeStamp": "2018-03-02T19:41:55.314Z",
39      "modifiedBy": "user5",
40      "links": [
41        {
42          "method": "GET",
43          "rel": "self",
44          "href": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74",
45          "uri": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74",
46          "type": "application/vnd.sas.report.state.info"
47        },
48        {
49          "method": "PUT",
50          "rel": "update",
51          "href": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74",
52          "uri": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74",
53          "type": "application/vnd.sas.report.state.info",
54          "responseType": "application/vnd.sas.report.state.info"
55        },
56        {
57          "method": "DELETE",
58          "rel": "delete",
59          "href": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74",
60          "uri": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74"
61        },
62        {
63          "method": "GET",
64          "rel": "content",
65          "href": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74/content",
66          "uri": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74/content",
67          "type": "application/vnd.sas.report.state"
68        },
69        {
70          "method": "PUT",
71          "rel": "updateContent",
72          "href": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74/content",
73          "uri": "/reports/reports/cb237e1b-b11f-42fb-960c-a48a0c5b1688/states/412f6f71-64eb-4840-a6a5-9a8e18fcad74/content",
74          "type": "application/vnd.sas.report.state",
75          "responseType": "application/vnd.sas.report.stat"
76        }
77      ]
78    }
79  ],
80  "version": "2"
81}

Path Parameters

Name	Type	Required	Description
reportId	string<object-id>	true	Report id for this operation.

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	The criteria for filtering the items. Report state attributes that can be used are `id`, `label`, `primary`, `createdBy`, `creationTimeStamp`, `modifiedBy`, and `modifiedTimeStamp`. See Filtering in REST APIs.
limit	integer	false	Maximum number of items to return. Default: 20
sortBy	string<sort-criteria>	false	The criteria for sorting the items. Report attributes that can be used are `id`, `label`, `primary`, `createdBy`, `creationTimeStamp`, `modifiedBy`, and `modifiedTimeStamp`. See Sorting in REST APIs.
start	integer	false	0-based offset of the first item to return. Default: 0

Header Parameters

Name	Type	Required	Description
Accept-Language	string	false	Optional header. If present, the locale it represents is used in processing, sorting, and filtering.

Responses

Status	Meaning	Description
200	OK	The report states in standard report state format.		Schema
400	Bad Request	Bad Request.		Schema