Change theme of submitted report

post/rethemedReports/{themeName}
Internal-Use Only

Change the theme of the report in the body of the request using the specified themeName. Return a transform containing the rethemed report. Optionally, get the input report from a persistent report resource, specified in the input transform. Also optionally, save the modified report as a persistent resource. If the input report is a persistent report, optionally replace it with the modified version. This operation has been enhanced in Version 2 to facilitate a single-step CLI operation to change the themes of existing reports.

Request Samples

1

Response Samples

1{
2 "id": "208c4b83-6b35-4382-86ad-8714d3966bdf",
3 "creationTimeStamp": "2023-11-15T21:30:24.753Z",
4 "createdBy": "guides",
5 "modifiedTimeStamp": "2023-11-15T21:30:24.772Z",
6 "modifiedBy": "guides",
7 "errorMessages": [],
8 "dataSources": [],
9 "substitutionParameters": [],
10 "links": [
11 {
12 "method": "POST",
13 "rel": "createDataMappedReport",
14 "type": "application/vnd.sas.report.transform",
15 "responseType": "application/vnd.sas.report.transform",
16 "title": "Change Data Source",
17 "href": "/reportTransforms/dataMappedReports"
18 },
19 {
20 "method": "POST",
21 "rel": "extractTranslationWorksheet",
22 "type": "application/vnd.sas.report.transform",
23 "responseType": "text/plain",
24 "title": "Extract a localization worksheet from the report",
25 "href": "/reportTransforms/translationWorksheets/{translationLocale}"
26 },
27 {
28 "method": "PUT",
29 "rel": "updateTranslationWorksheet",
30 "type": "text/plain",
31 "title": "Update the localization in the report",
32 "href": "/reportTransforms/translationWorksheets/{reportId}/{translationLocale}"
33 },
34 {
35 "method": "POST",
36 "rel": "createTranslatedReport",
37 "type": "application/vnd.sas.report.transform",
38 "responseType": "application/vnd.sas.report.transform",
39 "title": "Translate Report",
40 "href": "/reportTransforms/translatedReports/{translationLocale}"
41 },
42 {
43 "method": "POST",
44 "rel": "createConvertedReport",
45 "type": "application/vnd.sas.report.transform",
46 "responseType": "application/vnd.sas.report.transform",
47 "title": "Convert to XML or JSON",
48 "href": "/reportTransforms/convertedReports"
49 },
50 {
51 "method": "POST",
52 "rel": "createEvaluatedReport",
53 "type": "application/vnd.sas.report.transform",
54 "responseType": "application/vnd.sas.report.transform",
55 "title": "Semantically Evaluate",
56 "href": "/reportTransforms/evaluatedReports"
57 },
58 {
59 "method": "POST",
60 "rel": "createParameterizedReport",
61 "type": "application/vnd.sas.report.transform",
62 "responseType": "application/vnd.sas.report.transform",
63 "title": "Substitute Parameter Values",
64 "href": "/reportTransforms/parameterizedReports"
65 }
66 ],
67 "reportContent": {
68 "@element": "SASReport",
69 "xmlns": "http://www.sas.com/sasreportmodel/bird-4.36.0",
70 "label": "CL",
71 "dateCreated": "2023-11-15T14:38:04Z",
72 "createdApplicationName": "SAS Visual Analytics 2020",
73 "dateModified": "2023-11-15T14:38:04Z",
74 "lastModifiedApplicationName": "SAS Visual Analytics 2020",
75 "createdVersion": "4.36.0",
76 "createdLocale": "en_US",
77 "nextUniqueNameIndex": 29,
78 "results": [],
79 "dataDefinitions": [
80 {
81 "@element": "ParentDataDefinition",
82 "name": "dd21",
83 "source": "ds7",
84 "businessItems": [
85 {
86 "@element": "RelationalDataItem",
87 "name": "bi24",
88 "base": "bi10"
89 },
90 {
91 "@element": "RelationalDataItem",
92 "name": "bi25",
93 "base": "bi17"
94 }
95 ],
96 "relationalQueryList": [],
97 "multidimensionalQueryList": [],
98 "childQueryRelationshipType": "independent",
99 "dataDefinitionList": [
100 {
101 "@element": "DataDefinition",
102 "name": "dd22",
103 "type": "multidimensional",
104 "source": "ds7",
105 "businessItems": [],
106 "relationalQueryList": [],
107 "multidimensionalQueryList": [
108 {
109 "@element": "MultidimensionalQuery",
110 "columnSortItems": [
111 {
112 "@element": "MeasureSortItem",
113 "sortDirection": "descending",
114 "sortLevelList": [],
115 "reference": "bi25",
116 "sortMemberList": []
117 },
118 {
119 "@element": "SortItem",
120 "sortDirection": "ascending",
121 "sortLevelList": [],
122 "reference": "bi24"
123 }
124 ],
125 "detail": false,
126 "axes": [
127 {
128 "@element": "Query_Axis",
129 "type": "column",
130 "itemList": [
131 "bi24"
132 ]
133 },
134 {
135 "@element": "Query_Axis",
136 "type": "row",
137 "itemList": [
138 "bi25"
139 ]
140 }
141 ]
142 }
143 ],
144 "resultDefinitions": [
145 {
146 "@element": "ResultDefinition",
147 "name": "dd23",
148 "purpose": "primary",
149 "maxRowsBehavior": "truncate",
150 "relationalQueryList": [],
151 "multidimensionalQueryList": [],
152 "maxRowsLookup": "graphDefault"
153 }
154 ]
155 }
156 ],
157 "status": "executable"
158 }
159 ],
160 "dataSources": [
161 {
162 "@element": "DataSource",
163 "name": "ds7",
164 "label": "CARS",
165 "type": "relational",
166 "casResource": {
167 "@element": "CasResource",
168 "server": "cas-shared-default",
169 "library": "Public",
170 "table": "CARS",
171 "locale": "en_US"
172 },
173 "businessItemFolder": {
174 "@element": "BusinessItemFolder",
175 "items": [
176 {
177 "@element": "DataItem",
178 "name": "bi8",
179 "xref": "car",
180 "geoInfos": []
181 },
182 {
183 "@element": "DataItem",
184 "name": "bi9",
185 "xref": "color",
186 "geoInfos": []
187 },
188 {
189 "@element": "DataItem",
190 "name": "bi10",
191 "xref": "dealer",
192 "geoInfos": []
193 },
194 {
195 "@element": "DataItem",
196 "name": "bi11",
197 "xref": "dest",
198 "geoInfos": []
199 },
200 {
201 "@element": "DataItem",
202 "name": "bi12",
203 "xref": "dte",
204 "geoInfos": []
205 },
206 {
207 "@element": "DataItem",
208 "name": "bi13",
209 "xref": "returns",
210 "geoInfos": []
211 },
212 {
213 "@element": "DataItem",
214 "name": "bi14",
215 "xref": "sales",
216 "geoInfos": []
217 },
218 {
219 "@element": "DataItem",
220 "name": "bi15",
221 "xref": "type",
222 "geoInfos": []
223 },
224 {
225 "@element": "DataItem",
226 "name": "bi16",
227 "xref": "wght",
228 "geoInfos": []
229 },
230 {
231 "@element": "DataSource_PredefinedDataItem",
232 "name": "bi17",
233 "label": "Frequency",
234 "usage": "quantitative",
235 "format": "COMMA12.",
236 "calculation": "totalCount",
237 "geoInfos": []
238 },
239 {
240 "@element": "DataSource_PredefinedDataItem",
241 "name": "bi18",
242 "label": "Frequency Percent",
243 "usage": "quantitative",
244 "format": "PERCENT20.2",
245 "calculation": "totalCountPercent",
246 "geoInfos": []
247 }
248 ]
249 }
250 }
251 ],
252 "visualElements": [
253 {
254 "@element": "Graph",
255 "name": "ve20",
256 "labelAttribute": "Bar - dealer 1",
257 "graphType": "bar",
258 "dataList": [
259 "dd21"
260 ],
261 "applyDynamicBrushes": "yes",
262 "title": {
263 "@element": "Title",
264 "auto": true,
265 "elements": [],
266 "paragraphList": [
267 {
268 "@element": "P",
269 "elements": [
270 {
271 "@element": "DynamicSpan",
272 "elements": [],
273 "dynamicSpanKey": "bird.autotitle.template.oneOfTwo.fmt.txt",
274 "substitutions": [
275 {
276 "@element": "Substitution",
277 "valueType": "label",
278 "itemsList": [
279 "bi17"
280 ]
281 },
282 {
283 "@element": "Substitution",
284 "valueType": "label",
285 "itemsList": [
286 "bi10"
287 ]
288 }
289 ]
290 }
291 ]
292 }
293 ]
294 },
295 "gtml": "<StatGraph border=\"false\" opaque=\"false\" includeMissingDiscrete=\"true\" selectionMode=\"multiple\" missingValueDisplay=\"autolabel\">\r\n <PadAttrs top=\"0px\" bottom=\"0px\" left=\"0px\" right=\"0px\"/>\r\n <Meta>\r\n <DynVars>\r\n <DynVar name=\"CATEGORY\" description=\"CATEGORY_VAR\" required=\"true\" assignedType=\"character\" type=\"character\">\r\n <DefaultValues>\r\n <Value>dd23.bi24</Value>\r\n </DefaultValues>\r\n </DynVar>\r\n <DynVar name=\"RESPONSE\" description=\"MEASURE_VAR\" required=\"true\" assignedType=\"numeric\" type=\"numeric\" multiplesAllowed=\"true\">\r\n <DefaultValues>\r\n <Value>dd23.bi25</Value>\r\n </DefaultValues>\r\n </DynVar>\r\n <DynVar name=\"GROUP\" description=\"SUBGROUP_VAR\" required=\"false\" type=\"character\"/>\r\n <DynVar name=\"COLUMN\" description=\"HORIZONTAL_SERIES_VAR\" required=\"false\" type=\"character\" multiplesAllowed=\"true\"/>\r\n <DynVar name=\"ROW\" description=\"VERTICAL_SERIES_VAR\" required=\"false\" type=\"character\" multiplesAllowed=\"true\"/>\r\n <DynVar name=\"TIP\" description=\"TIP_VAR\" required=\"false\" assignedType=\"numeric\" type=\"any\" multiplesAllowed=\"true\">\r\n <DefaultValues>\r\n <Value>dd23.bi24</Value>\r\n <Value>dd23.bi25</Value>\r\n </DefaultValues>\r\n </DynVar>\r\n <DynVar name=\"KEY_FRAME\" description=\"ANIMATION\" required=\"false\" type=\"time\" multiplesAllowed=\"false\"/>\r\n <DynVar name=\"HIDDEN\" description=\"HIDDEN_VAR\" required=\"false\" type=\"character\" multiplesAllowed=\"true\"/>\r\n </DynVars>\r\n <DataNameMap>\r\n <Entry model=\"LayoutDataMatrix\" data=\"dd23\"/>\r\n </DataNameMap>\r\n </Meta>\r\n <LayoutDataMatrix name=\"LayoutDataMatrix\" cellHeightMin=\"1px\" cellWidthMin=\"1px\" includeMissingClass=\"true\" rowVars=\"ROW\" columnVars=\"COLUMN\">\r\n <LayoutPrototypeOverlay2D>\r\n <BarChartParm name=\"BarChart\" tipListPolicy=\"replace\" _stmt=\"barchart\" compactLabelFormats=\"true\" groupDisplay=\"cluster\" orient=\"horizontal\" baselineIntercept=\"0\" stat=\"none\" tip=\"TIP\" category=\"CATEGORY\" responseVars=\"RESPONSE\" group=\"GROUP\"/>\r\n <XAxisOpts name=\"categoryAxis\">\r\n <DiscreteOpts sortOrder=\"data\"/>\r\n <LinearOpts>\r\n <TickValueFormatOpts extractScale=\"true\"/>\r\n </LinearOpts>\r\n </XAxisOpts>\r\n <YAxisOpts reverse=\"true\">\r\n <DiscreteOpts tickValueFitPolicy=\"staggertruncatedrop\" sortOrder=\"data\" tickValueAppearance=\"auto\"/>\r\n <LinearOpts>\r\n <TickValueFormatOpts extractScale=\"true\"/>\r\n </LinearOpts>\r\n </YAxisOpts>\r\n </LayoutPrototypeOverlay2D>\r\n </LayoutDataMatrix>\r\n <LayoutGlobalLegend legendTitlePosition=\"top\" allowCollapsed=\"true\">\r\n <AutoLegend>\r\n <GraphNames>\r\n <Value>BarChart</Value>\r\n </GraphNames>\r\n </AutoLegend>\r\n </LayoutGlobalLegend>\r\n <Animation keyFrameSortOrder=\"ascending_unformatted\" keyFrame=\"KEY_FRAME\"/>\r\n <OverviewAxis maxPlotSize=\"60px\" minPlotSize=\"35px\" visible=\"off\" axis=\"categoryAxis\"/>\r\n</StatGraph>\r\n",
296 "supplementalVisualList": [
297 "ve26"
298 ],
299 "resultDefinitionList": [
300 "dd23"
301 ],
302 "sourceInteractionVariableList": [
303 "bi24"
304 ],
305 "editorProperties": [
306 {
307 "@element": "Editor_Property",
308 "value": "true",
309 "key": "isAutoLabel"
310 },
311 {
312 "@element": "Editor_Property",
313 "value": "bi25",
314 "key": "autoFrequencyQueryDataItemName"
315 }
316 ]
317 },
318 {
319 "@element": "Table",
320 "labels": [],
321 "dataList": [
322 "dd21"
323 ],
324 "columns": {
325 "@element": "Table_Columns",
326 "columns": [
327 {
328 "@element": "Table_Column",
329 "variable": "bi24"
330 },
331 {
332 "@element": "Table_Column",
333 "variable": "bi25"
334 }
335 ]
336 },
337 "name": "ve26",
338 "applyDynamicBrushes": "yes",
339 "columnSizing": "autoFill",
340 "resultDefinitionList": [
341 "dd23"
342 ],
343 "sourceInteractionVariableList": [
344 "bi24"
345 ]
346 }
347 ],
348 "promptDefinitions": [],
349 "view": {
350 "@element": "View",
351 "header": {
352 "@element": "Header",
353 "mediaContainerList": [
354 {
355 "@element": "MediaContainer",
356 "target": "mt2",
357 "layout": {
358 "@element": "ResponsiveLayout",
359 "orientation": "horizontal",
360 "overflow": "fit",
361 "weights": [
362 {
363 "@element": "Weights",
364 "mediaTarget": "mt5",
365 "unit": "percent",
366 "values": [
367 {
368 "@element": "Weight",
369 "value": "100%"
370 }
371 ]
372 },
373 {
374 "@element": "Weights",
375 "mediaTarget": "mt4",
376 "unit": "percent",
377 "values": [
378 {
379 "@element": "Weight",
380 "value": "100%"
381 }
382 ]
383 },
384 {
385 "@element": "Weights",
386 "mediaTarget": "mt3",
387 "unit": "percent",
388 "values": [
389 {
390 "@element": "Weight",
391 "value": "100%"
392 }
393 ]
394 }
395 ]
396 },
397 "containedElementList": []
398 }
399 ]
400 },
401 "sections": [
402 {
403 "@element": "Section",
404 "name": "vi6",
405 "label": "Page 1",
406 "header": {
407 "@element": "Header",
408 "mediaContainerList": [
409 {
410 "@element": "MediaContainer",
411 "target": "mt2",
412 "layout": {
413 "@element": "ResponsiveLayout",
414 "orientation": "horizontal",
415 "overflow": "fit",
416 "weights": [
417 {
418 "@element": "Weights",
419 "mediaTarget": "mt5",
420 "unit": "percent",
421 "values": [
422 {
423 "@element": "Weight",
424 "value": "100%"
425 }
426 ]
427 },
428 {
429 "@element": "Weights",
430 "mediaTarget": "mt4",
431 "unit": "percent",
432 "values": [
433 {
434 "@element": "Weight",
435 "value": "100%"
436 }
437 ]
438 },
439 {
440 "@element": "Weights",
441 "mediaTarget": "mt3",
442 "unit": "percent",
443 "values": [
444 {
445 "@element": "Weight",
446 "value": "100%"
447 }
448 ]
449 }
450 ]
451 },
452 "containedElementList": []
453 }
454 ]
455 },
456 "body": {
457 "@element": "Body",
458 "mediaContainerList": [
459 {
460 "@element": "MediaContainer",
461 "target": "mt2",
462 "layout": {
463 "@element": "ResponsiveLayout",
464 "orientation": "vertical",
465 "overflow": "fit",
466 "weights": [
467 {
468 "@element": "Weights",
469 "mediaTarget": "mt5",
470 "unit": "percent",
471 "values": [
472 {
473 "@element": "Weight",
474 "value": "100%"
475 }
476 ]
477 },
478 {
479 "@element": "Weights",
480 "mediaTarget": "mt4",
481 "unit": "percent",
482 "values": [
483 {
484 "@element": "Weight",
485 "value": "100%"
486 }
487 ]
488 },
489 {
490 "@element": "Weights",
491 "mediaTarget": "mt3",
492 "unit": "percent",
493 "values": [
494 {
495 "@element": "Weight",
496 "value": "100%"
497 }
498 ]
499 }
500 ]
501 },
502 "containedElementList": [
503 {
504 "@element": "Visual",
505 "name": "vi19",
506 "ref": "ve20",
507 "responsiveConstraint": {
508 "@element": "ResponsiveConstraint",
509 "widthConstraint": {
510 "@element": "Responsive_WidthConstraint",
511 "widths": [
512 {
513 "@element": "Width",
514 "mediaTarget": "mt3",
515 "preferredSizeBehavior": "ignore",
516 "flexibility": "flexible"
517 }
518 ]
519 },
520 "heightConstraint": {
521 "@element": "Responsive_HeightConstraint",
522 "heights": [
523 {
524 "@element": "Height",
525 "mediaTarget": "mt3",
526 "preferredSizeBehavior": "ignore",
527 "flexibility": "flexible"
528 }
529 ]
530 }
531 }
532 }
533 ]
534 }
535 ]
536 }
537 }
538 ]
539 },
540 "actions": [],
541 "interactions": [],
542 "mediaSchemes": [
543 {
544 "@element": "MediaScheme",
545 "name": "ms1",
546 "baseStylesheetResource": {
547 "@element": "BaseStylesheetResource",
548 "theme": "highcontrast2020"
549 },
550 "stylesheet": {
551 "@element": "Stylesheet",
552 "styles": {}
553 }
554 }
555 ],
556 "mediaTargets": [
557 {
558 "@element": "MediaTarget",
559 "name": "mt2",
560 "windowSize": "default",
561 "scheme": "ms1"
562 },
563 {
564 "@element": "MediaTarget",
565 "name": "mt3",
566 "windowSize": "small",
567 "scheme": "ms1"
568 },
569 {
570 "@element": "MediaTarget",
571 "name": "mt4",
572 "windowSize": "medium",
573 "scheme": "ms1"
574 },
575 {
576 "@element": "MediaTarget",
577 "name": "mt5",
578 "windowSize": "large",
579 "scheme": "ms1"
580 }
581 ],
582 "properties": [
583 {
584 "@element": "Property",
585 "key": "displayDataSource",
586 "value": "ds7"
587 }
588 ],
589 "reportParts": [],
590 "groupings": [],
591 "customSorts": [],
592 "dataSourceMappings": [],
593 "exportProperties": [
594 {
595 "@element": "Export",
596 "destination": "pdf",
597 "exportPropertyList": [
598 {
599 "@element": "Export_Property",
600 "key": "showCoverPage",
601 "value": "true",
602 "content": ""
603 },
604 {
605 "@element": "Export_Property",
606 "key": "showPageNumbers",
607 "value": "true",
608 "content": ""
609 }
610 ]
611 }
612 ],
613 "history": {
614 "@element": "History",
615 "versions": [
616 {
617 "@element": "Version",
618 "versionKey": "4.36.0",
619 "lastDate": "2023-11-15T14:38:04Z"
620 }
621 ],
622 "editors": [
623 {
624 "@element": "Editor",
625 "applicationName": "VA",
626 "revisions": [
627 {
628 "@element": "Revision",
629 "editorVersion": "2020",
630 "lastDate": "2023-11-15T14:38:04.615Z"
631 }
632 ]
633 }
634 ]
635 },
636 "sasReportState": {
637 "@element": "SASReportState",
638 "view": {
639 "@element": "View_State",
640 "sections": []
641 }
642 },
643 "features": [],
644 "implicitInteractions": [
645 "reportPrompt",
646 "sectionPrompt",
647 "sectionLink"
648 ]
649 }
650}

Path Parameters

NameTypeRequiredDescription
themeName
string
true

The name of the new theme.

Query Parameters

NameTypeRequiredDescription
replaceSavedReport
boolean
false

Specifies that the input report resource specified by the inputReportUri property of the request transform should be modified in place with the new theme. (Added in Version 2)

Default:
false
returnContent
boolean
false

Determines whether the transformed report is embedded in the response transform. If false, the report is not returned. If true, the report is returned. (Added in Version 2)

Default:
true
saveResult
boolean
false

Determines whether the transformed report is saved to the repository. If true, the report is saved. The response transform contains links to retrieve the resulting report. Assumes that resultReportName and resultParentFolderUri in the request transform can be used for the location of the resulting report.

Default:
false
useSavedReport
boolean
false

Specifies whether to find the input report as a permanent resource. If true, the input transform must provide the reference to the input report. If false, the input report is in the transform in the request body. (Added in Version 2)

Default:
false
validate
boolean
false

Determine whether to validate the report content against the schema. Validation errors do not necessarily halt processing.

Default:
true

Request Body

The input transform and the report to retheme.

The tranform is the primary payload in this service, for both requests and responses. Depending on the operation, some fields are required. For example, if the report to transform is a saved report, the inputReportUri field is required. Otherwise, the input report is in the body of request (in the transform) and reportContent is required.

NameTypeRequiredDescription
id
string<identifier>
false

Identifier for this instance. Usually a GUID, but does not need to be globally unique.

version
number
false

This media type's schema version number. This representation is version 1.

creationTimeStamp
string<date-time>
false

The date and time the transform was generated.

createdBy
string
false

User name or identity of service that created the transform object.

modifiedTimeStamp
string<date-time>
false

The date and time the transform was modified.

modifiedBy
string
false

User name or identity of service that modified the transform object last. Optional.

inputReportUri
string<uri>
false

The persisted report from which the transform should create the result.

resultReportName
string<uri>
false

On input, this specifies the human-readable name for the resulting report when the result is saved. It is not used on a response transform.

resultParentFolderUri
string<uri>
false

An identifier (URI) for the parent folder in which to save the result report. If omitted, the default is the user's personal folder.

resultReport
Report
false

The representation of a report. This representation is version 1.

dataSources
array [object]
false

An array of data source objects, some of which are matched to CAS tables, some to the data sources in the report.

schemaValidationStatus
string
false

A value indicating the status returned by schema validation.

Allowed values:
schemaValidschemaInvalid
evaluationStatus
string
false

Success or failure designation.

Allowed values:
evaluationValidevaluationInvalid
evaluation
array [string]
false

Text generated during semantic evaluation of the source.

messages
array [object]
false

Localized messages generated in the process of creating the transformed report.

errorMessages
array [object]
false

Error messages generated in the process of creating the transformed report with associated codes.

substitutionParameters
array [object]
false
reportContent
SasReport
false

A report content that is the equivalent of the application/vnd.sas.report.content media type. The report content is defined by a non-public XML Schema. The structure shown here is an abbreviation showing only a few of the descriptive attributes of the object.

links
array [Link]
false

Link objects, as described in SAS standards documentation.

Responses

StatusMeaningDescription
201CreatedRethemed version of the report generated and returned.HeadersSchema
400Bad RequestThe request was invalid. Some error in the request resulted in failure to perform the action. See the error codes table for further details.HeadersSchema
406Not AcceptableThe media type is incorrect.HeadersSchema