Description | Example | Return Message | Group(s)

ExportGraphic

HTTP Request Formats

POST api/ExportGraphic

To specify the schedule the command shall be sent to:

POST api/schedule/{scheduleName}/ExportGraphic

Description

The ExportGraphic REST API command saves the current Gantt view as an image file of the type specified by the extension in the filename.

Parameters

  • FilePathName: The parameter is a string of text in double quotes of the file path name. More information on the acceptable file path formats can be found here. Supported filename extensions are: BMP, EPS, GIS, JPG, PCX, PNG, TIF, VMF, and WMF.

Examples

Saves the current Gantt view as a jpeg image file with a filename "testfile" under the C:\MyFiles\Schedulefiles\directory

POST api/ExportGraphic

Body:

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


Return Message

If activated while graphics are on, a standard response for a successful HTTP response shall appear.

Graphics must not be disabled when this command runs, or this command will return an error message. Astro Scheduler Engine's graphics are on by default.

Group Membership

This command belongs to the following group(s):

Scheduler

Version

12.3