Rest Interface Guide

Office

The Office capabilities of the API allow application developers to fetch metadata from Excel worksheets, fetch information about Excel Data objects (like named range, dynamic range, tables and chartes) defined in a worksheet and get and transform Excel Data. The Office capabilities includes the following REST calls:

getExcelChart

Function

Get a Microsoft Excel chart based on asset Id

Description

This request returns a Microsoft Excel Chart in the desired image format. Default image format is PNG.

Type

GET

URL Format

...ofice/excelchart/{assetId}

Java API

Method Name

Class Name

getExcelChart

com.quark.qpp.service.facade.OfficeFacade

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)

outputformat=[image, json, html]

string

Image output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/excelchart/48?outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

Function

Get a Microsoft Excel chart by path

Description

This request  returns a Microsoft Excel Chart in the desired image format. Default image format is PNG.

Type

GET

URL Format

...ofice/excelchartbypath/{assetPath}

Java API

Method Name

Class Name

getExcelChart

com.quark.qpp.service.facade.OfficeByPathFacade

Parameters

 

 

Name

Type

Description

assetPath

string

The AssetPath.

majorversion=[x]

string

Major version of the asset. (Optional)

minorversion=[x]

string

Minor version of the asset. (Optional)

outputformat=[image, json, html]

string

Image output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/excelchartbypath/Home/Chart1.xlsx?outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

getExcelChartBasedOnStream

Function

Get a Microsoft Excel chart based on stream

Description

This request  returns a Microsoft Excel Chart in the desired image format. Default image format is PNG.

Type

POST

URL Format

...ofice/excelchart

Java API

Method Name

Class Name

getExcelChartBasedOnStream

com.quark.qpp.service.facade.OfficeFacade

Parameters

 

 

Name

Type

Description

inputStream

string

The stream of the input file. (Mandatory)

outputformat=[image, json, html]

string

Image output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/excelchart? outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

getExcelChartBasedOnURI

Function

Get a Microsoft Excel chart based on URI

Description

This request  returns a Microsoft Excel Chart in the desired image format. Default image format is PNG.

Type

GET

URL Format

...ofice/excelchart

Java API

Method Name

Class Name

getExcelChartBasedOnURI

com.quark.qpp.service.facade.OfficeByPathFacade

Parameters

 

 

Name

Type

Description

uri

string

The URI of the Microsoft Excel chart

outputformat=[image, json, html]

string

Image output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/excelchart? uri=qpp://assetsbypath/Home/Chart1.xlsx&outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

getExcelTable

Function

Get a Microsoft Excel table based on asset Id

Description

This request returns a Microsoft Excel table in the desired output format. Default output format is Smart Table.

Type

GET

URL Format

...ofice/exceltable/{assetId}

Java API

Method Name

Class Name

getExcelTable

com.quark.qpp.service.facade.OfficeFacade

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)

outputformat

string

Output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/exceltable/48?outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

Function

Get a Microsoft Excel table by path

Description

This request  returns a Microsoft Excel table in the desired output format. Default output format is Smart Table.

Type

GET

URL Format

...ofice/exceltablebypath/{assetPath}

Java API

Method Name

Class Name

getExcelTable

com.quark.qpp.service.facade.OfficeByPathFacade

Parameters

 

 

Name

Type

Description

assetPath

string

The AssetPath.

majorversion=[x]

string

Major version of the asset. (Optional)

minorversion=[x]

string

Minor version of the asset. (Optional)

outputformat

string

Output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/exceltablebypath/Home/BudgetDetails.xlsx?outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

 

getExcelTableBasedOnStream

Function

Get a Microsoft Excel chtable art based on stream

Description

This request  returns a Microsoft Excel table in the desired output format. Default image format is PNG.

Type

GET

URL Format

...ofice/exceltable

Java API

Method Name

Class Name

getExcelTableBasedOnStream

com.quark.qpp.service.facade.OfficeByPathFacade

Parameters

 

 

Name

Type

Description

inputStream

string

The stream of the input file. (Mandatory)

outputformat

string

Output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required output format based on the given parameters.

Examples

URL

http://server:port/rest/service/office/exceltable? outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

getExcelTableBasedOnURI

Function

Get a Microsoft Excel table based on URI

Description

This request  returns a Microsoft Excel table in the desired image format. Default output format is Smart Table.

Type

GET

URL Format

...ofice/exceltable

Java API

Method Name

Class Name

getExcelTableBasedOnURI

com.quark.qpp.service.facade.OfficeByPathFacade

Parameters

 

 

Name

Type

Description

uri

string

The URI of the Microsoft Exceltable

outputformat

string

Output format. (Optional)

contentdisposition

string

Content disposition value to be set on the http response headers.

outputStream

string

Output stream onto which output is to be written (for local API invocatins).

Returns

Returns a stream of the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/exceltable?uri=qpp://assetsbypath/Home/BudgetDetails.xlsx&outputformat=image&imageformat=png

Results:

A filestream of required output format based on given parameters.

getExcelWorksheets

Function

Get all worksheets in Excel document.

Description

This request returns all worksheets defined in an Excel document.

Type

GET

URL Format

..office/excel/[assetId] OR .../ office/ excelbypath /{ coll name1}/{ coll name 2}/../{asset name}

Java API

Method Name

Class Name

getExcelWorksheets

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion=?

string

Major version to be fetched. (Optional)

minorversion=?

string

Minor version to be fetched. (Optional)

worksheets=?

string

Comma separated worksheet names of specific worksheets to be fetched. (Optional)

Returns

Returns all worksheets or required worksheets defined in an Excel document. Each worksheet encapsulates its metadata (such as worksheet index and name.) Each worksheet also provides information about tables, named ranges and charts defined in the worksheet.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel/10

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <worksheetInfoList>
    <worksheetInfo index="0">
      <name>Products</name>
      <chartInfoList>
        <chartInfo>
          <name>Chart 1</name>
        </chartInfo>
      </chartInfoList>
      <namedRangeInfoList>
        <namedRangeInfo>
          <name>Description</name>
        </namedRangeInfo>
        <namedRangeInfo>
          <name>DispatchRange</name>
        </namedRangeInfo>
      </namedRangeInfoList>
    </worksheetInfo>
    <worksheetInfo index="1">
      <name>Sales</name>
      <chartInfoList>
        <chartInfo>
          <name>Chart 1</name>
        </chartInfo>
      </chartInfoList>
      <tableInfoList>
        <tableInfo>
          <name>SalesTable</name>
        </tableInfo>
      </tableInfoList>
    </worksheetInfo>
  </worksheetInfoList>

URL:

http://servername:serverport/rest/service/office/excel/10? worksheets=sales,sheet3

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <worksheetInfoList>
    <worksheetInfo index="1">
      <name>Sales</name>
      <chartInfoList>
        <chartInfo>
          <name>Chart 1</name>
        </chartInfo>
      </chartInfoList>
      <tableInfoList>
        <tableInfo>
          <name>SalesTable</name>
        </tableInfo>
      </tableInfoList>
    </worksheetInfo>
    <worksheetInfo index="2">
      <name>Sheet3</name>
    </worksheetInfo>
  </worksheetInfoList>

getExcelWorksheetsBasedOnURI

Function

Get all worksheets based on URI of the Excel document.

Description

This request returns all worksheets defined in an Excel document.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getExcelWorksheetsBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

URI

string

Excel document uri.

worksheets

string

Comma separated worksheet names if specific worksheets are to be fetched. (Optional)

Returns

Returns all worksheets or required worksheets defined in an Excel document. Each worksheet encapsulates its metadata (such as worksheet index and name. Each worksheet also provides information about tables, named ranges and charts defined in the worksheet.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel? uri=file:C:\DATA\Documents\MyExcelSamples\DocSample.xlsx

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<worksheetInfoList>
    <worksheetInfo index="0">
        <name>Products</name>
        <chartInfoList>
            <chartInfo>
                <name>Chart 1</name>
            </chartInfo>
        </chartInfoList>
        <namedRangeInfoList>
            <namedRangeInfo>
                <name>Description</name>
            </namedRangeInfo>
            <namedRangeInfo>
                <name>DispatchRange</name>
            </namedRangeInfo>
        </namedRangeInfoList>
    </worksheetInfo>
    <worksheetInfo index="1">
        <name>Sales</name>
        <tableInfoList>
            <tableInfo>
                <name>SalesTable</name>
            </tableInfo>
        </tableInfoList>
    </worksheetInfo>
</worksheetInfoList>

getExcelWorksheetsBasedOnStreamContext

Function

Get all worksheets defined in an Excel document based on stream context.

Description

This request returns all worksheets defined in an Excel document.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getExcelWorksheetsBasedOnStreamContext

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

stream

string

Excel document in request.

worksheets

string

Comma separated worksheet names if specific worksheets are to be fetched. (Optional)

Returns

Returns all worksheets or required worksheets defined in an Excel document. Each worksheet encapsulates its metadata (such as worksheet index and name). Each worksheet also provides information about tables, named ranges and charts defined a worksheet.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel Stream the excel document as input.

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<worksheetInfoList>
    <worksheetInfo index="0">
        <name>Products</name>
        <chartInfoList>
            <chartInfo>
                <name>Chart 1</name>
            </chartInfo>
        </chartInfoList>
        <namedRangeInfoList>
            <namedRangeInfo>
                <name>Description</name>
            </namedRangeInfo>
            <namedRangeInfo>
                <name>DispatchRange</name>
            </namedRangeInfo>
        </namedRangeInfoList>
    </worksheetInfo>
    <worksheetInfo index="1">
        <name>Sales</name>
        <tableInfoList>
            <tableInfo>
                <name>SalesTable</name>
            </tableInfo>
        </tableInfoList>
    </worksheetInfo>
</worksheetInfoList>

getChart

Function

Get an Excel chart in image format.

Description

This request returns an Excel chart in image format.

Type

GET

URL Format

..office/excel/[assetId] OR .../ office/ excelbypath /{ coll name1}/{ coll name 2}/../{asset name}

Java API

Method Name

Class Name

getChart

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion=?

string

Major version of the asset. (Optional)

minorversion=?

string

Minor version of the asset. (Optional)

chart

string

Name of the Excel chart to be retrieved.

worksheet

string

The name of the worksheet where the chart is defined. By default the first chart in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

horizontalresolution

string

Image output horizontal resolution. (Optional)

verticalresolution

string

Image output vetical resolution. (Optional)

imageormat

string

Image output format. By default the image is returned in png format. (Optional)

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of chart is required. (Optional)

Returns

Returns an Excel chart in the image format.

Examples

URL:

http://serverName:serverPortt/rest/service/office/excel/36? chart=Chart1& horizontalresolution=100&verticalresolution=100&imageformat=png

Result:

getChartBasedOnURI

Function

Get Excel chart based on the URI of the Excel document.

Description

This request returns an Excel chart in the image format.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getChartBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

uri

string

URI of the Excel document.

chart

string

Name of the Excel chart to be retrieved.

worksheet

string

The name of the worksheet where the chart is defined. By default the first chart in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

horizontalresolution

string

Image output horizontal resolution. (Optional)

verticalresolution

string

Image output vetical resolution. (Optional)

imageormat

string

Image output format. By default the image is returned in png format. (Optional)

contentDisposition

string

Uused to set the content-disposition header value in the response. Set to "attachment" if downloading of chart is required. (Optional)

Returns

Returns an Excel chart in the image format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel?uri= classpath:SampleExcelFile.xlsx&worksheet=Products& chart=chart1&imageformat=png

Result:

getChartBasedOnStream

Function

Get a chart based on the input stream of an Excel document.

Description

This request returns an Excel chart in the image format. Include the file in the request body or as file part.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getChartBasedOnStream

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

chart

string

Name of the Excel chart to be retrieved.

worksheet

string

The name of the worksheet where the chart is defined. By default the first chart in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

horizontalresolution

string

Image output horizontal resolution. (Optional)

verticalresolution

string

Image output vetical resolution. (Optional)

imageformat

string

Image output format. By default the image is returned in png format. (Optional)

contentDisposition

string

Uused to set the content-disposition header value in the response. Set to "attachment" if downloading of chart is required. (Optional)

Returns

Returns an Excel chart in the image format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel?worksheet=Products& chart=chart1&imageformat=png

Result:

getTable

Function

Get an Excel table.

Description

This request r eturns an Excel table in the desired output format.

Type

GET

URL Format

..office/excel/[assetId] OR .../ office/ excelbypath /{ coll name1}/{ coll name 2}/../{asset name}

Java API

Method Name

Class Name

getTable

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion=?

string

Major version to be retrieved. (Optional)

minorversion=?

string

Minor version to be retrieved. (Optional)

table

string

Name of the table to be retrieved. (Optional)

worksheets=?

string

The name of the worksheet where the table is defined. By default the first table in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the table is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats . Default value is "smarttable" .

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of table is required. (Optional)

Returns

Returns an Excel table in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel/10? worksheet= Products&table=SalesDetails

Result:

<?xml version="1.0" encoding="utf-8"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="2">
        <colspec colnum="1" colname="1" colwidth="64px"/>
        <colspec colnum="2" colname="2" colwidth="131px"/>
        <tbody>
            <row>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Name</t>
                    </p>
                </entry>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Sales (in millions)</t>
                    </p>
                </entry>
            </row>
        </tbody>
    </tgroup>
</table>

getTableBasedOnURI

Function

Get an Excel table based on an Excel document URI.

Description

This request returns an Excel table in the desired output format.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getTableBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

uri

string

URI of the Excel document.

table

string

Name of the table to be retrieved. (Optional)

worksheets=?

string

The name of the worksheet where the chart is defined. By default the first chart in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the table is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats . Default value is "smarttable" .

contentDisposition

string

Uused to set the content-disposition header value in the response. Set to "attachment" if downloading of chart is required. (Optional)

Returns

Returns an Excel table in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel? uri = classpath:SampleExcelFile.xlsx&table = SalesDetails

Result:

<?xml version="1.0" encoding="utf-8"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type="smarttable">
    <tgroup cols="2">
        <colspec colnum="1" colname="1" colwidth="64px"/>
        <colspec colnum="2" colname="2" colwidth="131px"/>
        <tbody>
            <row>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Name</t>
                    </p>
                </entry>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Sales (in millions)</t>
                    </p>
                </entry>
            </row>
        </tbody>
    </tgroup>
</table>

getTableBasedOnStreamContext

Function

Get an Excel table based on stream context.

Description

This request r eturns an Excel table in the desired output format. Include the file in the request body or as file part.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getTableBasedOnStreamContext

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

table

string

Name of the table to be retrieved. (Optional)

worksheets=?

string

The name of the worksheet where the chart is defined. By default the first chart in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the table is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats . Default value is "smarttable".

contentDisposition

string

Uused to set the content-disposition header value in the response. Set to "attachment" if downloading of chart is required. (Optional)

Returns

Returns an Excel table in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel ? worksheet= Products&table = SalesInfo & stream the Excel file in input

Result:

<?xml version="1.0" encoding="utf-8"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="2">
        <colspec colnum="1" colname="1" colwidth="64px"/>
        <colspec colnum="2" colname="2" colwidth="131px"/>
        <tbody>
            <row>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Name</t>
                    </p>
                </entry>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Sales (in millions)</t>
                    </p>
                </entry>
            </row>
        </tbody>
    </tgroup>
</table>

getNamedRange

 

Function

Get an Excel Named Range.

Description

This request r eturns an Excel named range in the desired output format.

Type

GET

URL Format

..office/excel/[assetId] OR .../ office/ excelbypath /{ coll name1}/{ coll name 2}/../{asset name}

Java API

Method Name

Class Name

getNamedRange

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion=?

string

Major version to be retrieved. (Optional)

minorversion=?

string

Minor version to be retrieved. (Optional)

namedrange

string

Name of the Excel named range to be retrieved.

worksheets=?

string

The name of the worksheet where the named ranged is defined. By default the first named ranged in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the named range is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats .

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of named range is required. (Optional)

Returns

Returns an Excel named range in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel/10 ? worksheet= Products& namedrange = DispatchRange

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="1">
        <colspec colnum="1" colname="1" colwidth="83x"/>
        <tbody>
            <row>
                <entry align="right" valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>10</t>
                    </p>
                </entry>
            </row> ....... </tbody>
    </tgroup>
</table>

getNamedRangeBasedOnURI

Function

Get an Excel Named Range based on the URI of the Excel document.

Description

This request returns an Excel named range in the desired output format.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getNamedRangeBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

uri

string

Excel document URI.

namedrange

string

Name of the Excel named range to be retrieved.

worksheets=?

string

The name of the worksheet where the named ranged is defined. By default the first named ranged in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the named range is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats .

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of named range is required. (Optional)

Returns

Returns an Excel named range in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel? uri = classpath:SampleExcelFile.xlsx& namedrange = DispatchRange

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="1">
        <colspec colnum="1" colname="1" colwidth="83x"/>
        <tbody>
            <row>
                <entry align="right" valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>10</t>
                    </p>
                </entry>
            </row> ....... </tbody>
    </tgroup>
</table>

getNamedRangeBasedOnStream

Function

Get an Excel Named Range based on stream context.

Description

This request returns an Excel named range in the desired output format. Include the file in the request body or as file part.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getNamedRangeBasedOnStream

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

namedrange

string

Name of the Excel named range to be retrieved.

worksheets=?

string

The name of the worksheet where the named ranged is defined. By default the first named ranged in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the named range is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats .

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of named range is required. (Optional)

Returns

Returns an Excel named range in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel? worksheet= Sales&namedrange = DispatchRange & stream the Excel file in input

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="1">
        <colspec colnum="1" colname="1" colwidth="83x"/>
        <tbody>
            <row>
                <entry align="right" valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>10</t>
                    </p>
                </entry>
            </row> ....... </tbody>
    </tgroup>
</table>

getDynamicRange

Function

Get an Excel Dynamic Range.

Description

This request r eturns an Excel dynamic range in the desired output format.

Type

GET

URL Format

..office/excel/[assetId] OR .../ office/ excelbypath /{ coll name1}/{ coll name 2}/../{asset name}d]

Java API

Method Name

Class Name

getDynamicRange

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion=?

string

Major version to be retrieved. (Optional)

minorversion=?

string

Minor version to be retrieved. (Optional)

dynamicrange

string

Name of the Excel dynamic range to be retrieved.

worksheets=?

string

The name of the worksheet where the dynamic ranged is defined. By default the first dynamic ranged in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the dynamic range is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats .

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of dynamic range is required. (Optional)

Returns

Returns an Excel dynamic range in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel/1?worksheet=Sales&dynamicrange=A2:C25

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="1">
        <colspec colnum="1" colname="1" colwidth="104px"/>
        <tbody>
            <row>
                <entry colsep="0" rowsep="0">
                    <p>
                        <t/>
                    </p>
                </entry>
            </row>
            <row>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Product details</t>
                    </p>
                </entry>
            </row> ...... ...... </tbody>
    </tgroup>
</table>

getDynamicRangeBasedOnURI

Function

Get an Excel Dynamic Range based on the URI of the Excel document.

Description

This request returns an Excel dynamic range in the desired output format.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getDynamicRangeBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

uri

string

Excel document URI.

dynamicrange

string

Name of the Excel dynamic range to be retrieved.

worksheets=?

string

The name of the worksheet where the dynamic ranged is defined. By default the first dynamic ranged in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the dynamic range is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats .

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of named range is required. (Optional)

Returns

Returns an Excel dynamic range in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel? uri = classpath:SampleExcelFile.xlsx&worksheet = Sales&dynamicrange =A2:C25

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="1">
        <colspec colnum="1" colname="1" colwidth="104px"/>
        <tbody>
            <row>
                <entry colsep="0" rowsep="0">
                    <p>
                        <t/>
                    </p>
                </entry>
            </row>
            <row>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Product details</t>
                    </p>
                </entry>
            </row> ...... ...... </tbody>
    </tgroup>
</table>

getDynamicRangeBasedOnStream

Function

Get an Excel Dynamic Range based on stream context.

Description

This request returns an Excel dynamic range in the desired output format. Include the file in the request body or as file part.

Type

GET

URL Format

...office/excel

Java API

Method Name

Class Name

getDynamicRangeBasedOnStream

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

dynamicrange

string

Name of the Excel dynamic range to be retrieved.

worksheets=?

string

The name of the worksheet where the dynamic ranged is defined. By default the first named ranged in Excel with the given name is returned if the worksheet is not mentioned. (Optional)

outputformat

string

Value of the output format in which the dynamic range is to be rendered. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats .

contentDisposition

string

Used to set the content-disposition header value in the response. Set to "attachment" if downloading of named range is required. (Optional)

Returns

Returns an Excel dynamic range in the desired output format.

Examples

URL:

http://serverName:serverPort/rest/service/office/excel? worksheet= Sales&dynamicrange=r1c1:r5c5 & stream the Excel file in input

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<table xmlns="http://quark.com/ smartcontent /1.0" type=" smarttable ">
    <tgroup cols="1">
        <colspec colnum="1" colname="1" colwidth="104px"/>
        <tbody>
            <row>
                <entry colsep="0" rowsep="0">
                    <p>
                        <t/>
                    </p>
                </entry>
            </row>
            <row>
                <entry valign="bottom" colsep="0" rowsep="0">
                    <p>
                        <t>Product details</t>
                    </p>
                </entry>
            </row> ...... ...... </tbody>
    </tgroup>
</table>

getVisioPagesInfo

Function

Get metadata of all pages of a Visio asset.

Description

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter.

Type

GET

URL Format

.../office/visio/[assetId]

Java API

Method Name

Class Name

getVisioPagesInfo

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion and minorversion

string

Specify the required major and minor version for which the pages of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0.

pageNames= [comma-separated list of page names]

string

The set of page names.

Returns

Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.

Examples

URL:

http://serverName:serverPort/rest/service/office/visio/{assetId}

Result:

A VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<visioPageInfoList>
    <visioPageInfo index="1">
        <pageName>Page-1</pageName>
    </visioPageInfo>
</visioPageInfoList>

getVisioPagesInfoBasedOnURI

Function

Get metadata of all pages of a Visio asset based on URI.

Description

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter.

Type

GET

URL Format

.../office/visio

Java API

Method Name

Class Name

getVisioPagesInfoBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

Uri

string

The URI of the asset. (Mandatory)

pageNames= [comma-separated list of page names]

string

The set of page names.

Returns

Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.

Examples

URL:

http://serverName:serverPort/rest/service/office/visio?uri=qpp://assets/{assetId}

Result:

A VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<visioPageInfoList>
    <visioPageInfo index="1">
        <pageName>Page-1</pageName>
    </visioPageInfo>
</visioPageInfoList>

getVisioPagesInfoBasedOnStreamContext

Function

Get metadata of all pages of a Visio asset based on stream.

Description

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter. Include the file in the request body or as a file part. (Mandatory)

Type

GET

URL Format

.../office/visio

Java API

Method Name

Class Name

getVisioPagesInfoBasedOnStreamContext

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

pageNames= [comma-separated list of page names]

string

The set of page names.

Returns

Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.

Examples

URL:

http://serverName:serverPort/rest/service/office/visioInclude the file in the request body.

Result:

A VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.

<visioPageInfoList>
    <visioPageInfo index="1">
        <pageName>Page-1</pageName>
    </visioPageInfo>
</visioPageInfoList>

getVisioPageOutput

Function

Get page output of a Visio asset.

Description

This request returns a Visio document page output in the desired output format.

Type

GET

URL Format

.../office/visio/{assetId}

Java API

Method Name

Class Name

getVisioPageOutput

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion and minorversion

string

Specify the required major and minor version for which the pages of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0.

pagename= [comma-separated list of page names]

string

The set of page names.

Returns

Returns a filestream of required output format based on given parameters.

Examples

URL:

http://serverName:serverPort/rest/service/office/visio/{assetId}? outputformat=image&pagename={pageName}&imageformat=PNG

Result:

A filestream of the generated output of the given asset.

getVisioPageOutputBasedOnURI

Function

Get metadata of all pages of a Visio asset based on URI.

Description

This request returns a Visio document page output in the desired output format.

Type

GET

URL Format

.../office/visio

Java API

Method Name

Class Name

getVisioPagesOutputBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

Uri

string

The URI of the asset. (Mandatory)

pagename= [comma-separated list of page names]

string

The set of page names.

Returns

Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.

Examples

URL:

http://serverName:serverPort/rest/service/office/visio? uri=qpp://assets/{assetId}&outputformat=image&pagename={pageName}&imageformat=PNG

Result:

A filestream of the generated output of the given asset.

getVisioPageOutputBasedOnStreamContext

Function

Get page output of a Visio asset based on stream.

Description

This request returns a Visio document page output in the desired output format. Include the file in the request body or as a file part. (Mandatory)

Type

GET

URL Format

.../office/visio

Java API

Method Name

Class Name

getVisioPageOutputBasedOnStreamContext

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

pagename

string

The page name.

Returns

Returns a filestream of the required output format based on the given parameters.

Examples

URL:

http://serverName:serverPort/rest/service/office/visio/ outputformat=image&pagename={pageName}&imageformat=PNG Include the file in the request body.

Result:

A filestream of the generated output of the given asset.

getPowerPointSlidesInfo

Function

Get metadata of all slides of a PowerPoint asset.

Description

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid slide index in the slideIndexes parameter.

Type

GET

URL Format

.../office/powerpoint/[assetId]

Java API

Method Name

Class Name

getPowerPointSlidesInfo

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion and minorversion

string

Specify the required major and minor version for which the pages of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0.

slideindexes= [comma-separated list of slide indexes]

string

The set of slide indexes.

Returns

Returns a PowerPointSlidesInfoList object that contains index numbers and slide IDs of all slides for a given PowerPoint asset.

Examples

URL:

http://serverName:serverPort/rest/service/office/powerpoint{assetId}

Result:

A PowerPointSlidesInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<powerPointSlideInfoList>
    <powerPointSlideInfo index="1">
        <slideId>256</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="2">
        <slideId>257</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="3">
        <slideId>258</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="4">
        <slideId>259</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="5">
        <slideId>260</slideId>
    </powerPointSlideInfo>
</powerPointSlideInfoList>

getPowerPointSlidesInfoBasedOnURI

Function

Get metadata of all slides of a PowerPoint asset based on URI.

Description

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid slide id in the slideIndexes parameter.

Type

GET

URL Format

.../office/powerpoint

Java API

Method Name

Class Name

getPowerPointSlidesInfoBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

Uri

string

The URI of the asset. (Mandatory)

slideindexes= [comma-separated list of slide index numbers

string

The set of index number.

Returns

Returns a PowerPointSlidesInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset.

Examples

URL:

http://serverName:serverPort/rest/service/office/powerpoint? uri=qpp://assets/{assetId}

Result:

A PowerPointSlidesInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset.

getPowerPointSlidesInfoBasedOnStreamContext

Function

Get all slide metadata for a PowerPoint asset based on file stream.

Description

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid index of a slide in the slideIndexes parameter. Include the file in the request body or as a file part. (Mandatory)

Type

GET

URL Format

.../office/powerpoint

Java API

Method Name

Class Name

getPowerPointSlidesInfoBasedOnStreamContext

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

slideindexes= [comma-separated list of slide indexes

string

The set of slide ids.

Returns

Returns a PowerPointSlideInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset.

Examples

URL:

http://serverName:serverPort/rest/service/office/powerpointInclude the file in the request body.

Result:

A PowerPointSlideInfoList object that contains index numbers and slide ids of all slides of a given PowerPoint asset.
<powerPointSlideInfoList>
    <powerPointSlideInfo index="1">
        <slideId>256</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="2">
        <slideId>257</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="3">
        <slideId>258</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="4">
        <slideId>259</slideId>
    </powerPointSlideInfo>
    <powerPointSlideInfo index="5">
        <slideId>260</slideId>
    </powerPointSlideInfo>
</powerPointSlideInfoList>

getPowerPointSlideOutput

Function

Get slide output of a PowerPoint asset.

Description

This request extracts PowerPoint slide output in the specified format.

Type

GET

URL Format

.../office/powerpoint/[assetId]

Java API

Method Name

Class Name

getPowerPointSlidesOutput

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion and minorversion

string

Specify the required major and minor version for which the slide of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0.

slideid

string

The slide Id.

outputformat

string

The desired output format. Possible values are defined in class com.quark.qpp.office.service.constants.ExcelDataOutputFormats

Returns

Returns a filestream that contains the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/powerpoint/{assetId} ?outputformat=image&slideid={slideId}&imageformat=PNG

Result:

Returns a filestream that contains the required output format based on the given parameters.

getPowerPointSlideOutputBasedOnURI

Function

Get slide output of a PowerPoint asset based on URI.

Description

This request extracts the PowerPoint slide output in the desired output format..

Type

GET

URL Format

.../office/powerpoint

Java API

Method Name

Class Name

getPowerPointSlideOutputBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

Uri

string

The URI of the asset. (Mandatory)

slideid

string

The slide Id.

outputformat

string

The desired output format.

Returns

Returns a filestream that contains the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/powerpoint ?uri=qpp://assets/{assetId}&outputformat=image&slideid={slideId}&imageformat=PNG

Result:

Returns a filestream that contains the required output format based on the given parameters.

getPowerPointSlideOutputBasedOnStreamContext

Function

Get slide output of a PowerPoint asset based on file stream.

Description

This request extracts the PowerPoint slide output in the desired output format.. Include the file in the request body or as a file part. (Mandatory)

Type

GET

URL Format

.../office/powerpoint

Java API

Method Name

Class Name

getPowerPointSlideOutputBasedOnStreamContext

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

slideid

string

The slide Id.

outputformat

string

The desired output format.

Returns

Returns a filestream that contains the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/powerpoint? outputformat=image&slideid={slideId}&imageformat=PNGInclude the file in the request body.

Result:

Returns a filestream that contains the required output format based on the given parameters.

getPowerPointSlideRangeOutput

Function

Get slide range output of a PowerPoint asset.

Description

This request extracts the PowerPoint slide output in the desired output format.

Type

GET

URL Format

.../office/powerpoint/[assetId]

Java API

Method Name

Class Name

getPowerPointSlideRangeOutput

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

majorversion and minorversion

string

Specify the required major and minor version for which the slide of an asset is required. (Optional) These parameters will be used collectively. If neither parameter is passed, the latest version of the asset will be considered. If only one of the parameters is not passed, then the value for that parameter is assumed to be 0.

sliderange = [comma-separated list of slide indexes]

string

The set of slide indexes.

outputformat

string

The desired output format.

Returns

Returns a filestream that contains the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/powerpoint/{assetId} ?outputformat=image&sliderange=1,3,5&imageformat=PNG

Result:

Returns a filestream that contains the required output format based on the given parameters.

getPowerPointSlideRangeOutputBasedOnURI

Function

Get slide range output of a PowerPoint asset based on URI.

Description

This request extracts the PowerPoint slide output in the desired output format..

Type

GET

URL Format

.../office/powerpoint

Java API

Method Name

Class Name

getPowerPointSliderRangeOutputBasedOnURI

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

Uri

string

The URI of the asset. (Mandatory)

sliderange = [comma-separated list of slide indexes]

string

The set of slide indexes.

outputformat

string

The desired output format.

Returns

Returns a filestream that contains the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/powerpoint ?uri=qpp://assets/{assetId}&outputformat=image&sliderange=1,3,5&imageformat=PNG

Result:

Returns a filestream that contains the required output format based on the given parameters.

getPowerPointSlideRangeOutputBasedOnStreamContext

Function

Get slide range output of a PowerPoint asset based on file stream.

Description

This request extracts the PowerPoint slide output in the desired output format.. Include the file in the request body or as a file part. (Mandatory)

Type

GET

URL Format

.../office/powerpoint

Java API

Method Name

Class Name

getPowerPointSlideRangeOutputBasedOnStreamContext

com.quark.qpp.service.facadeClass OfficeFacade

Parameters

Name

Type

Description

sliderange = [comma-separated list of slide indexes]

string

The set of slide indexes.

outputformat

string

The desired output format.

Returns

Returns a filestream that contains the required output format based on the given parameters.

Examples

URL:

http://server:port/rest/service/office/powerpoint? sliderange=1,3,5&imageformat=PNGInclude the file in the request body.

Result:

Returns a filestream that contains the required output format based on the given parameters.