Update Iteration Exports

put

https://example.com/test/api/web/report-tasks/{ReportTaskId}/iterations/{IterationId}/exports/{ExportId}

api/web/report-tasks/{ReportTaskId}/iterations/{IterationId}/exports/{ExportId}

Updates an existing export for the iteration.

Path Params

ReportTaskId

int32

required

≥ 1

The ID of the report task the iteration belongs to (ReportTaskId >= 1)

IterationId

int32

required

≥ 1

The ID of the iteration the export belongs to (IterationId >= 1)

ExportId

int32

required

≥ 1

The ID of the export to update (ExportId >= 1)

Body Params

The model containing the updated details of the export.

Export configuration for a report task

LayoutFileId

int32 | null

The unique database ID of the layout file that the export will use.

FileMode

string

enum

Allowed:

RepositoryId

int32 | null

The read only unique database ID of the repository that the export will use.

FileName

string | null

The name for the export file.

ZipEnabled

boolean

Definies if the result should be zipped.

ZipPasswordValue

string | null

The password for the zipped file. Write-only in practice: reads return
the masked value SkySparc.Web.Backend.API.Models.WebAccess.ReportTaskExportModel.DUMMY_PASSWORD when a password is set.
On update, sending the masked value back leaves the stored password
unchanged, sending an empty value clears it, and sending any other
value replaces it. On create the masked value is rejected.

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