Get a collection of reports

get/reports
Internal-Use Only

Returns a collection of reports with standard paging, filtering, and sorting options.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/reports/reports",
7      "uri": "/reports/reports",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/reports/reports?sortBy=name&start=0&limit=20",
14      "uri": "/reports/reports?sortBy=name&start=0&limit=20",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "POST",
19      "rel": "createReport",
20      "href": "/reports/reports",
21      "uri": "/reports/reports",
22      "type": "application/vnd.sas.report",
23      "responseType": "application/vnd.sas.report"
24    }
25  ],
26  "name": "reports",
27  "accept": "application/vnd.sas.report",
28  "start": 0,
29  "count": 2,
30  "items": [
31    {
32      "id": "f8b66d4b-d67a-4e4e-a66d-b6f06b1820bf",
33      "name": "Sample Report",
34      "createdBy": "user1",
35      "creationTimeStamp": "2020-12-09T13:22:11.394000Z",
36      "modifiedBy": "user1",
37      "modifiedTimeStamp": "2020-12-09T13:27:20.437000Z",
38      "links": [
39        {
40          "method": "GET",
41          "rel": "self",
42          "href": "/reports/reports/f8b66d4b-d67a-4e4e-a66d-b6f06b1820bf",
43          "uri": "/reports/reports/f8b66d4b-d67a-4e4e-a66d-b6f06b1820bf",
44          "type": "application/vnd.sas.report"
45        },
46        {
47          "method": "PUT",
48          "rel": "updateContent",
49          "href": "/reports/reports/f8b66d4b-d67a-4e4e-a66d-b6f06b1820bf/content",
50          "uri": "/reports/reports/f8b66d4b-d67a-4e4e-a66d-b6f06b1820bf/content",
51          "type": "application/vnd.sas.report.content",
52          "responseType": "application/vnd.sas.report.content"
53        }
54      ]
55    },
56    {
57      "id": "6b0fdf5c-c091-455c-8ee7-6c9ff60b3565",
58      "name": "Sample Report 2",
59      "createdBy": "user2",
60      "creationTimeStamp": "2020-12-10T13:22:11.394000Z",
61      "modifiedBy": "user2",
62      "modifiedTimeStamp": "2020-12-10T13:27:20.437000Z",
63      "links": [
64        {
65          "method": "GET",
66          "rel": "self",
67          "href": "/reports/reports/6b0fdf5c-c091-455c-8ee7-6c9ff60b3565",
68          "uri": "/reports/reports/6b0fdf5c-c091-455c-8ee7-6c9ff60b3565",
69          "type": "application/vnd.sas.report"
70        },
71        {
72          "method": "PUT",
73          "rel": "updateContent",
74          "href": "/reports/reports/6b0fdf5c-c091-455c-8ee7-6c9ff60b3565/content",
75          "uri": "/reports/reports/6b0fdf5c-c091-455c-8ee7-6c9ff60b3565/content",
76          "type": "application/vnd.sas.report.content",
77          "responseType": "application/vnd.sas.report.content"
78        }
79      ]
80    }
81  ],
82  "limit": 20,
83  "version": 2
84}

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

The criteria for filtering. Report attributes that can be used are id, name, description, 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. Report attributes that can be used are id, name, description, 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

NameTypeRequiredDescription
Accept-Item
string
false

Optional, media type of collection item.

Allowed values:
application/vnd.sas.summary+jsonapplication/vnd.sas.report+json
Default:
application/vnd.sas.summary+json
Accept-Language
string
false

Optional header. If present, the locale it represents is used in processing, sorting, and filtering.

Responses

StatusMeaningDescription
200OKThe reports in resource summary format.Schema
404Not FoundReports collection not found, possibly due to incorrect URI or media type.Schema