Description | Example | Return Message | Group(s)

ExportToExcel

HTTP Request Formats

POST api/ExportToExcel

To specify the schedule the command shall be sent to:

POST api/schedule/{scheduleName}/ExportToExcel

Description

The ExportToExcel REST API command saves the current Data view as an excel file.

Parameters

  • FilePathName: The parameter is a string of text in single quotes of the file path name. More information on the acceptable file path formats can be found here. Supported filename extensions are: XLS and XLSX.

Examples

Saves the current Data view as an Excel file with a file name "testfile" under the C:\MyFiles\Schedulefiles\directory

POST api/ExportGraphic

Body:

"C:\\MyFiles\\Schedulefiles\\testfile.xls"

Return Message

If activated, a standard response for a successful HTTP response shall appear.

Group Membership

This command belongs to the following group(s):

Scheduler

Version

12.3