Export - Initiate the export process of an existing report

Initiates the export process of an existing report

post
Authorizations
Query parameters
versionstringOptional

The requested API version

Default: 1.0
Header parameters
embedfast-user-idstringOptional

Optional User Id

embedfast-user-emailstringOptional

Optional User Email

Body

Class for export file.

reportIdstring · uuidRequired

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportId property.

exportTypestring · min: 1Required

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ExportType property.

isPaginatedbooleanRequired

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the paginated property.

filterstring | nullableOptional
bookmarkStatestring | nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the BookmarkState property.

pageNamestring | nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the PageName property.

visualNamestring | nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the VisualName property.

Responses
200
Indicates successfull initialization of export process
post
POST /export HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "exportType": "text",
  "isPaginated": true,
  "filter": "text",
  "bookmarkState": "text",
  "pageName": "text",
  "visualName": "text",
  "reportParameter": [
    {
      "name": "text",
      "value": "text"
    }
  ]
}
{
  "id": "text",
  "createdDateTime": "2025-06-27T17:19:43.928Z",
  "lastActionDateTime": "2025-06-27T17:19:43.928Z",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "reportName": "text",
  "status": 0,
  "percentComplete": 1,
  "resourceLocation": "text",
  "resourceFileExtension": "text",
  "expirationTime": "2025-06-27T17:19:43.928Z"
}

Last updated