Store and return report state content

put/reports/{reportId}/states/{stateId}/content
Internal-Use Only

Saves and returns the report state content. An ETag is not required for the initial save, but required for all subsequent saves. See Conditional Operations. A different response code is returned depending on whether the request is for the initial save or a subsequent save.

Request Samples

1

Response Samples

1{
2 "@element": "SASReport",
3 "xmlns": "http://www.sas.com/sasreportmodel/bird-4.3.0",
4 "label": "Small Report State",
5 "dateCreated": "2020-10-24T01:33:24Z",
6 "dateModified": "2020-11-04T03:20:00Z",
7 "view": {
8 "@element": "View",
9 "sections": [
10 {
11 "@element": "Section",
12 "name": "vi1",
13 "label": "Section1",
14 "body": {
15 "@element": "Body",
16 "mediaContainerList": [
17 {
18 "@element": "MediaContainer",
19 "target": "mt111",
20 "layout": {
21 "@element": "ResponsiveLayout"
22 }
23 }
24 ]
25 },
26 "mediaSchemes": [
27 {
28 "@element": "MediaScheme",
29 "name": "ms201"
30 }
31 ],
32 "mediaTargets": [
33 {
34 "@element": "MediaTarget",
35 "name": "mt111",
36 "scheme\"": "ms201"
37 }
38 ]
39 }
40 ]
41 }
42}

Path Parameters

NameTypeRequiredDescription
reportId
string<object-id>
true

Report id for this operation.

stateId
string<object-id>
true

Report state id to check.

Header Parameters

NameTypeRequiredDescription
If-Match
string
false

The ETag that was returned from a GET, POST, PUT, or HEAD of this resource. If the ETag does not match, the update will fail.

If-Unmodified-Since
string
false

The value of the modifiedTimeStamp of the resource. If the resource has been updated since this time, the update will fail.

Request Body

The report state content to be saved.

The representation of a report state content, which has the same schema as report content, in JSON format. Check Get Versions and GET /versions/@defaultVersion for the set of valid media types and versions as defined by Business Intelligence Report Definition. If not provided, for request the version equivalent to the report content schema is used and for response latest version is used. The lowest valid version is 3.

Example:
{"@element":"SASReport","xmlns":"http://www.sas.com/sasreportmodel/bird-4.3.0","label":"Small Report State","dateCreated":"2020-10-24T01:33:24Z","dateModified":"2020-11-04T03:20:00Z","view":{"@element":"View","sections":[{"@element":"Section","name":"vi1","label":"Section1","body":{"@element":"Body","mediaContainerList":[{"@element":"MediaContainer","target":"mt111","layout":{"@element":"ResponsiveLayout"}}]},"mediaSchemes":[{"@element":"MediaScheme","name":"ms201"}],"mediaTargets":[{"@element":"MediaTarget","name":"mt111","scheme\"":"ms201"}]}]}}

Responses

StatusMeaningDescription
200OKThe report state content was updated.HeadersSchema
201CreatedReport state content was created.HeadersSchema
400Bad RequestBad Request. The input report state content was not valid.Schema
404Not FoundReport state or report state content does not exist.Schema
412Precondition FailedThe ETag (If-Match) provided did not match the current version of the object, or the last modified date did not match.Schema
428Precondition RequiredThe ETag (If-Match), or the last modified date was not provided when updating the report state content.Schema