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