POST api/GanttChartExporter
Generates and returns the bytes of a PNG based Gantt Chart image for the specified input project data using the specified settings. Exported project size is limited to 1024 tasks, timeline duration is limited to 366 days, and image resolution is limited to 384 dots per inch. Alternatively, to obtain image bytes directly, post form with similar input parameters to GanttChartExporter.aspx.
Request Information
URI Parameters
None.
Body Parameters
GetImageBytesInputName | Description | Type | Additional information |
---|---|---|---|
TimelineStart |
The start date and time of the exported chart. |
date |
None. |
TimelineFinish |
The end date and time of the exported chart. |
date |
None. |
Resolution |
The resolution to export image at. |
decimal number |
None. |
ProjectXml |
Input project data. |
string |
None. |
LicenseXml |
DlhSoft license XML content to use (required in production). |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "TimelineStart": "2025-03-14T12:58:09.3656139+00:00", "TimelineFinish": "2025-03-14T12:58:09.3656139+00:00", "Resolution": 3.1, "ProjectXml": "sample string 4", "LicenseXml": "sample string 5" }
application/xml, text/xml
Sample:
<GanttChartExporterService.GetImageBytesInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProjectManagementServices"> <LicenseXml>sample string 5</LicenseXml> <ProjectXml>sample string 4</ProjectXml> <Resolution>3.1</Resolution> <TimelineFinish>2025-03-14T12:58:09.3656139+00:00</TimelineFinish> <TimelineStart>2025-03-14T12:58:09.3656139+00:00</TimelineStart> </GanttChartExporterService.GetImageBytesInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetImageBytesOutputName | Description | Type | Additional information |
---|---|---|---|
ImageBytes |
The exported PNG image bytes. |
Collection of byte |
None. |
ProjectXml |
Output project data. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ImageBytes": "QEA=", "ProjectXml": "sample string 1" }
application/xml, text/xml
Sample:
<GanttChartExporterService.GetImageBytesOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProjectManagementServices"> <ProjectXml>sample string 1</ProjectXml> <ImageBytes>QEA=</ImageBytes> </GanttChartExporterService.GetImageBytesOutput>