Skip to main content
PUT
Update a saved report view.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Path Parameters

reportDefinitionId
string
required

The opaque report-definition identifier that owns the saved view.

view
string
required

The opaque saved-view identifier returned when the view was created.

Body

The body containing the replacement Name, client payload, and nullable IncludeInScheduledExport value.

Client-supplied content for a saved report view.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ReportViewCreation, Derivitec.Web.Core
name
string | null

Name of the saved view.

Example:

"\n Example saved view\n "

payload
string | null

Client-supplied saved-view payload; its internal format is not established by this contract.

include_in_scheduled_export
boolean | null

Nullable flag that records whether the saved view is included in scheduled export.

Example:

false

Response

Returns the updated saved view, with business or access failures in the response envelope.

Response returned after updating a saved report view.

$type
enum<string>
required
Available options:
Derivitec.Core.Mediators.ReportView.UpdateReportViewResponse, Derivitec.Core.Mediators
view
object

Saved view associated with a report definition.

is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.