Update a report while applying the specified operation(s)

put/reports/{reportId}

Creates or updates a report while applying the specified operation(s). The source report for the updates is denoted in the uri of the request. A new report can be generated by denoting a resultFolder or resultReportName in the body of the request. If neither of these are specified in the body, the source report is directly updated.

Request Samples

1

Response Samples

1{
2  "id": "operation123",
3  "version": 1,
4  "resultReportId": "3122a48c-e7d3-4922-9ed4-46e9d61a83e4",
5  "resultReportName": "ReportWithNewPage",
6  "resultReportUri": "/reports/reports/3122a48c-e7d3-4922-9ed4-46e9d61a83e4",
7  "resultFolderUri": "/folders/folders/@myFolder",
8  "operations": [
9    {
10      "name": "vi70",
11      "label": "My New Page",
12      "status": "Success"
13    }
14  ],
15  "status": "Success",
16  "links": [
17    {
18      "method": "GET",
19      "rel": "getReport",
20      "href": "/reportOperations/reports/3122a48c-e7d3-4922-9ed4-46e9d61a83e4",
21      "uri": "/reportOperations/reports/3122a48c-e7d3-4922-9ed4-46e9d61a83e4",
22      "type": "application/vnd.sas.report.operations.request+json"
23    }
24  ]
25}

Path Parameters

NameTypeRequiredDescription
reportId
string
true

The ID of an existing report.

Header Parameters

NameTypeRequiredDescription
If-Match
string
true

The value of the etag that was returned from a GET or previous PUT of this type. If provided, this MUST match exactly the current value of the etag of the object. This parameter is noted as required, but it can be substituted with a precondition value for the "If-Unmodified-Since" parameter. Either an "If-Match" value or an "If-Unmodified-Since" value must be supplied.

If-Unmodified-Since
string
false

A date to compare against the saved report, to assert the precondition for this request, that the request executes only if the report has been unmodified since this specified date.

Request Body

The request details identifying the operations to be performed on the report.

A request object is the root object contained in the body of requests for put and post endpoints. It specifies the destination of the resulting report as well as the operations to be performed on the report.

NameTypeRequiredDescription
id
string
false

The ID of the request, usually a UUID.

version
integer
false

This media type's schema version number.

resultFolder
string
false

The URI of the folder in which to save the resulting report. If not specified and a new report is being created, the default value of "/reports/reports/@myFolder" is used.

resultReportName
string
false

The name of the resulting report. If not specified and a new report is being created, the default value of "Report" is used along with a resultNameConflict policy of "rename".

resultNameConflict
string
false

The name conflict resolution strategy. If not specified, the default behavior of "abort" is used when updating a report and the default behavior of "rename" is used when creating a new report.

Allowed values:
abortrenamereplace
operations
array [anyOf]addDataOperationRequestupdateDataOperationRequestchangeDataOperationRequestapplyDataViewOperationRequestaddPageOperationRequestaddObjectOperationRequestupdateObjectOperationRequestsetParameterValueOperationRequest
false

This object defines a single operation to be performed on a report.

Responses

StatusMeaningDescription
200OK

The report was successfully updated.

HeadersSchema
201Created

The new report was successfully created.

HeadersSchema
400Bad Request

This is a bad request. The request is not properly formed or the body is missing required fields or the update has failed.

HeadersSchema
404Not Found

The source report does not exist or the result report folder does not exist.

HeadersSchema
409Conflict

A report with the same name already exists in the destination folder.

HeadersSchema
412Precondition Failed

The if-match etag value provided does not match the current version of the report or the report has been modified since the if-unmodified-since value provided.

HeadersSchema
428Precondition Required

Either an if-match etag value or an if-unmodified-since value is required in request header.

HeadersSchema