Rest Interface Guide

Charting

The charting capabilities of the API includes the following REST calls:

getChart

Function

Create new chart.

Description

This request draws a chart for the given asset using the specified template.

Type

GET

URL Format

...charts/{assetId} or .../chartsbypath/[asset path]

Java API

Method Name

Class Name

getChart

com.quark.qpp.service.facadeClass ChartingFacade

Parameters

Name

Type

Description

assetId

string

The AssetID.

majorversion=[x]

string

Major version of the asset. (Optional)

minorversion=[x]

string

Minor version of the asset. (Optional)

templateuri=[x]

string

Uri for the template file.

outputformat=[image, json, html]

string

Image output format. (Optional)

Returns

Returns a stream of the successfully created chart.

Examples

URL:

http://serverName:serverPortt/rest/service/charts/408?templateuri= qpp://assets/409&outputformat=html

Result:

The file stream of the successfully created chart.

getChartBasedOnUri

Function

Create new chart By URI.

Description

This request draws a chart for the given data specified in the URI using the specified template.

Type

GET

URL Format

...charts/

Java API

Method Name

Class Name

getChartBasedOnURI

com.quark.qpp.service.facadeClass ChartingFacade

Parameters

Name

Type

Description

uri=[x]

string

The URI for the source asset.

majorversion=[x]

string

Major version of the asset. (Optional)

minorversion=[x]

string

Minor version of the asset. (Optional)

templateuri=[x]

string

Uri for the template file.

outputformat=[image, json, html]

string

Image output format. (Optional)File, ClassPath, Http, Qpp are the supported URIs.

Returns

Returns a stream of the successfully created chart.

Examples

URL:

http://serverName:serverPort/rest/service/charts?uri=qpp://assets/408&templateuri= qpp://assets/409&outputformat=htm

Result:

The file stream of the successfully created chart.

getChartBasedOnStream

Function

Create new chart By Stream

Description

This request draws a chart for the given data input stream using the specified template. Include the file in the request body or as file part.

Type

GET

URL Format

.../charts/

Java API

Method Name

Class Name

getChartBasedOnStream

com.quark.qpp.service.facadeClass ChartingFacade

Parameters

Name

Type

Description

majorversion=[x]

string

Major version of the asset. (Optional)

minorversion=[x]

string

Minor version of the asset. (Optional)

templateuri=[x]

string

Uri for the template file.

outputformat=[image, json, html]

string

Image output format. (Optional)File, ClassPath, Http, Qpp are the supported URIs

Returns

Returns a stream of the successfully created chart.

Examples

URL:

http://serverName:serverPort/rest/service/charts?templateuri=qpp://assets/409&outputformat=html

Result:

The file stream of the successfully created chart.