Update Layout

put

https://example.com/test/api/web/reports/{ReportId}/layouts/{LayoutId}

api/web/reports/{ReportId}/layouts/{LayoutId}

Updates an existing mail/export layout for a specific report.

This is a full replacement of the layout's own fields: 'Name', 'Subject' and
'SendCondition' are written exactly as supplied, so omitting 'SendCondition'
(or sending null) clears it and the mail is then sent on every execution.
To preserve a send condition, read the layout first and echo the value back.
'UseAsDefault' is the exception, because it is a property of the report rather
than of this layout - setting it true unsets every sibling layout. It is
therefore tri-state: true makes this layout the default, false clears the flag
on this layout only, and omitting it leaves the report's current default
assignment untouched.

Path Params

ReportId

int32

required

≥ 1

The report ID.

LayoutId

int32

required

≥ 1

The layout ID.

Body Params

The layout model.

Model of report layout. It is a template describing what various
emails/exports, including attachments/files, can be generated from the report
when it is executed. What emails/exports are actually generated, and what
files are actually exported is determined when running the report,
e.g. by the scheduled task, by selecting one or several of the available layouts.

Name

string | null

The display name of the layout.

Subject

string | null

The email Subject text.

SendCondition

string | null

^[^!]+![^!\d]{1,3}\d{1,7}$

Gets or sets the mail send condition cell on the form Sheet!Cell
(e.g. Sheet1!A1). If the cell evaluates to True, after
executing the report the email is sent.

UseAsDefault

boolean | null

Indicates whether this layout is used as the default layout.
When creating or updating a layout, true makes this layout the
default and unsets the default flag on the other layouts of the report,
while false clears the flag on this layout only. Omitting the
property (null) means "not specified" and leaves the current
default assignment untouched.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK