Create Layout File

post

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

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

Creates a new attachment file specification for a mail/export layout.

Path Params

ReportId

int32

required

≥ 1

The report ID.

LayoutId

int32

required

≥ 1

The layout ID.

Body Params

The layout file model.

Specification for a mail layout attachment file.

Name

string | null

The name of the attachment file. This is both the mnemonic name
displayed for the specification, and the name given to the file
when the attachment is generated.

Sheets

string | null

A comma-separated list of worksheets to include in the attachment.
(E.g. "Sheet1,Sheet2").
The sheets listed are extracted from the report result workbook
and included in the attachment. The reserved word "all" includes
all sheets in the attachment.

Type

string

enum

Defines different kind of files.

Allowed:

IsPreview

boolean

Indicates whether this file is used as preview in the report logs
view.

CsvColumnSeparator

string | null

Defines a character that, if the file is a CSV file, is used as
custom column separator in place of the system-specified separator.

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