Export - Initiates the export process of a report

Initiates the export process of an existing report.

POST/export

Authorization

Bearer

Query parameters

Header parameters

Body

application/jsontext/jsonapplication/*+json

reportId*string (uuid)

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.

exportType*string

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.

isPaginated*boolean

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.

filternullable string

bookmarkStatenullable string

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.

pageNamenullable string

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.

visualNamenullable string

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.

reportParameternullable array of object

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 ReportParameter property.

Response

200400401404405500

Success: Export process successfully initiated for the report.

Body

text/plainapplication/jsontext/json

idnullable string

createdDateTimenullable string (date-time)

lastActionDateTimenullable string (date-time)

reportIdnullable string (uuid)

reportNamenullable string

statusenum

01234

percentCompletenullable integer (int32)

resourceLocationnullable string

resourceFileExtensionnullable string

expirationTimenullable string (date-time)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/export', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "reportId": "a2b04a90-7320-4e76-8a90-8cbdd603d134",
      "exportType": "pdf",
      "isPaginated": true,
      "filter": "TableName/ColumnName eq 'Value' and TableName/AnotherColumn gt 10",
      "bookmarkState": "string",
      "pageName": "string",
      "visualName": "string    ",
      "reportParameter": [
        {
          "name": "Parameter1",
          "value": "Value1"
        },
        {
          "name": "Parameter2",
          "value": "Value2"
        }
      ]
    }),
});
const data = await response.json();

Response

200400401404500

{
  "id": "text",
  "createdDateTime": "2025-01-30T13:13:02.467Z",
  "lastActionDateTime": "2025-01-30T13:13:02.467Z",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "reportName": "text",
  "status": 0,
  "percentComplete": 0,
  "resourceLocation": "text",
  "resourceFileExtension": "text",
  "expirationTime": "2025-01-30T13:13:02.467Z"
}