Get report content elements

get/reports/{reportId}/content/elements
Internal-Use Only

Returns the collection of elements.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/content/elements",
7      "uri": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5/content/elements",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.report.content.element"
10    },
11    {
12      "method": "GET",
13      "rel": "up",
14      "href": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5",
15      "uri": "/reports/reports/8559a118-139b-46e4-adea-97198d9068f5",
16      "type": "application/vnd.sas.report"
17    }
18  ],
19  "name": "reportContentElements",
20  "accept": "application/vnd.sas.report.content.element",
21  "count": "3",
22  "items": [
23    {
24      "name": "vi6",
25      "label": "Migration Timeline",
26      "type": "Section",
27      "version": 1
28    },
29    {
30      "name": "vi357",
31      "label": "EG Project Status",
32      "type": "HiddenSection",
33      "version": 1
34    },
35    {
36      "name": "ve27",
37      "label": "Import details for EG projects",
38      "type": "Table",
39      "version": 1
40    }
41  ],
42  "version": 2
43}

Path Parameters

NameTypeRequiredDescription
reportId
string<object-id>
true

Report id for this operation.

Query Parameters

NameTypeRequiredDescription
characteristics
string
false

A '|' (bar) separated list of characteristics of elements to return. A characteristic is a set of attributes of an element. An element has only one type but it can have many characteristics. If no characteristic is specified, then all elements are returned. Valid values are visualElement, dataSource, and visualElementsBySection

Header Parameters

NameTypeRequiredDescription
Accept-Item
string
false

Optional header. If omitted, items of application/vnd.sas.report.content.element+json type are returned.

Allowed values:
application/vnd.sas.report.content.element+jsonapplication/vnd.sas.report.content.element+json;version=1application/vnd.sas.report.content.element+json;version=2
Default:
application/vnd.sas.report.content.element+json;version=2
Accept-Language
string
false

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

Responses

StatusMeaningDescription
200OKA collection of report content elements. Paging and sorting are not supported.HeadersSchema
404Not FoundThe report or report content does not exist.Schema