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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The AssetID. |
|
|
|
string |
Major version of the asset. (Optional) |
|
|
|
string |
Minor version of the asset. (Optional) |
|
|
|
string |
Image output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The AssetPath. |
|
|
|
string |
Major version of the asset. (Optional) |
|
|
|
string |
Minor version of the asset. (Optional) |
|
|
|
string |
Image output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
getExcelChartBasedOnStream |
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The stream of the input file. (Mandatory) |
|
|
|
string |
Image output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
getExcelChartBasedOnURI |
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The URI of the Microsoft Excel chart |
|
|
|
string |
Image output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The AssetID. |
|
|
|
string |
Major version of the asset. (Optional) |
|
|
|
string |
Minor version of the asset. (Optional) |
|
|
|
string |
Output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The AssetPath. |
|
|
|
string |
Major version of the asset. (Optional) |
|
|
|
string |
Minor version of the asset. (Optional) |
|
|
|
string |
Output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
getExcelTableBasedOnStream |
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The stream of the input file. (Mandatory) |
|
|
|
string |
Output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The URI of the Microsoft Exceltable |
|
|
|
string |
Output format. (Optional) |
|
|
|
string |
Content disposition value to be set on the http response headers. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Major version to be fetched. (Optional) |
|
|
|
string |
Minor version to be fetched. (Optional) |
|
|
|
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:
Result:
|
||
|
URL:
Result:
|
|||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Excel document uri. |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Excel document in request. |
|
|
|
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:
Result:
|
||
getChart
|
Function |
Get an Excel chart in image format. |
||
|
Description |
This request returns an Excel chart in image format. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Major version of the asset. (Optional) |
|
|
|
string |
Minor version of the asset. (Optional) |
|
|
|
string |
Name of the Excel chart to be retrieved. |
|
|
|
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) |
|
|
|
string |
Image output horizontal resolution. (Optional) |
|
|
|
string |
Image output vetical resolution. (Optional) |
|
|
|
string |
Image output format. By default the image is returned in png format. (Optional) |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
URI of the Excel document. |
|
|
|
string |
Name of the Excel chart to be retrieved. |
|
|
|
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) |
|
|
|
string |
Image output horizontal resolution. (Optional) |
|
|
|
string |
Image output vetical resolution. (Optional) |
|
|
|
string |
Image output format. By default the image is returned in png format. (Optional) |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Name of the Excel chart to be retrieved. |
|
|
|
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) |
|
|
|
string |
Image output horizontal resolution. (Optional) |
|
|
|
string |
Image output vetical resolution. (Optional) |
|
|
|
string |
Image output format. By default the image is returned in png format. (Optional) |
|
|
|
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:
Result: |
||
getTable
|
Function |
Get an Excel table. |
||
|
Description |
This request r eturns an Excel table in the desired output format. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Major version to be retrieved. (Optional) |
|
|
|
string |
Minor version to be retrieved. (Optional) |
|
|
|
string |
Name of the table to be retrieved. (Optional) |
|
|
|
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) |
|
|
|
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" . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
URI of the Excel document. |
|
|
|
string |
Name of the table to be retrieved. (Optional) |
|
|
|
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) |
|
|
|
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" . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Name of the table to be retrieved. (Optional) |
|
|
|
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) |
|
|
|
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". |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Major version to be retrieved. (Optional) |
|
|
|
string |
Minor version to be retrieved. (Optional) |
|
|
|
string |
Name of the Excel named range to be retrieved. |
|
|
|
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) |
|
|
|
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 . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Excel document URI. |
|
|
|
string |
Name of the Excel named range to be retrieved. |
|
|
|
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) |
|
|
|
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 . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Name of the Excel named range to be retrieved. |
|
|
|
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) |
|
|
|
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 . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Major version to be retrieved. (Optional) |
|
|
|
string |
Minor version to be retrieved. (Optional) |
|
|
|
string |
Name of the Excel dynamic range to be retrieved. |
|
|
|
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) |
|
|
|
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 . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Excel document URI. |
|
|
|
string |
Name of the Excel dynamic range to be retrieved. |
|
|
|
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) |
|
|
|
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 . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Name of the Excel dynamic range to be retrieved. |
|
|
|
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) |
|
|
|
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 . |
|
|
|
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:
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
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. |
|
|
|
string |
The set of page names. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result: A VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
Uri |
string |
The URI of the asset. (Mandatory) |
|
|
|
string |
The set of page names. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result: A VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The set of page names. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result: A VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
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. |
|
|
|
string |
The set of page names. |
|
|
Returns |
Returns a filestream of required output format based on given parameters. |
||
|
Examples |
URL:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The URI of the asset. (Mandatory) |
|
|
|
string |
The set of page names. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
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. |
|
|
|
string |
The set of slide indexes. |
|
|
Returns |
Returns a |
||
|
Examples |
Result:
|
||
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The URI of the asset. (Mandatory) |
|
|
|
string |
The set of index number. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The set of slide ids. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getPowerPointSlideOutput
|
Function |
Get slide output of a PowerPoint asset. |
||
|
Description |
This request extracts PowerPoint slide output in the specified format. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
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. |
|
|
|
string |
The slide Id. |
|
|
|
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:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The URI of the asset. (Mandatory) |
|
|
|
string |
The slide Id. |
|
|
|
string |
The desired output format. |
|
|
Returns |
Returns a filestream that contains the required output format based on the given parameters. |
||
|
Examples |
URL:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The slide Id. |
|
|
|
string |
The desired output format. |
|
|
Returns |
Returns a filestream that contains the required output format based on the given parameters. |
||
|
Examples |
URL:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
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. |
|
|
|
string |
The set of slide indexes. |
|
|
|
string |
The desired output format. |
|
|
Returns |
Returns a filestream that contains the required output format based on the given parameters. |
||
|
Examples |
URL:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The URI of the asset. (Mandatory) |
|
|
|
string |
The set of slide indexes. |
|
|
|
string |
The desired output format. |
|
|
Returns |
Returns a filestream that contains the required output format based on the given parameters. |
||
|
Examples |
URL:
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 |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The set of slide indexes. |
|
|
|
string |
The desired output format. |
|
|
Returns |
Returns a filestream that contains the required output format based on the given parameters. |
||
|
Examples |
URL:
Result: Returns a filestream that contains the required output format based on the given parameters. |
||
