RESTful Engine JavaScript Client Reference

This article describes how to get the Fluent RESTful V2 JavaScript client installed, as well as a list of all methods and models defined in the client.

Setting Up the Client

note

To see a sample application using the Fluent RESTful V2 JavaScript client, please refer to our sample JavaScript client application github page.

To set up the client, run one of the following commands:

npm install --save windwardrestapi

or to install globally:

npm install -g windwardrestapi

Then in your project, import the client and the models you need:

import pkg from 'windwardrestapi';
const { WindwardClient, Template, Xml_10DataSource, OutputFormatEnum } = pkg;

Then to initialize the client:

const client = new WindwardClient("http://your-restful-engine-url");

Now the client is set up and you can call the different methods associated with it.

Client Models

info

This section will go over the relevant models associated with the client that you will use. Import the models you need from the package: import pkg from 'windwardrestapi'; const { WindwardClient, Template, Xml_10DataSource, OutputFormatEnum, ... } = pkg;

Template

These are the parameters for the Template object constructor:

:param outputFormat : The desired output file type (set using OutputFormatEnum)
:type OutputFormatEnum

:param datasources : The datasources to apply to the template. The datasources are applied simultaneously.
:type DataSource[]

:param callback : If set, this url will be called with a POST when a job completes. If the text "{guid}" is in the url, that text will
be replaced with the Guid for the callback.
:type string

:param data : The file path for your template (the client will encode to base64) (only use if connectionString is undefined)
:type string : string representation of the file path

:param connectionString : The connection string to your template file (only use if data is undefined)
:type string

:param format : The format of the template to be processed (if left empty it will auto populate)
:type string

:param properties : Fluent properties for this report. These override any properties set in the configuration file on the server side.
:type Property[] : An array of Property objects

:param parameters : A set of input parameters for this report. The parameters are global and shared among all data sources.
:type Parameter[] : An array of Parameter objects

:param tag : A tag you want to assign to the template.
This is passed in to the repository job handlers and is set in the final generated Report object
:type string

:param trackImports : Return all imports with the generated document
:type boolean

:param trackErrors : Enable or disable the error handling and verify functionality.
:type number

:param mainPrinter : If you are using printer output use to specify main printer. Printer must be recognized by Network
:type string

:param firstPagePrinter : Set first page printer if main printer is already set
:type string

:param printerJobName : Assign the print job a name
:type string

:param printCopies : Set number of copies the print job should print
:type number

:param printDuplex : Selects the printers duplex mode
:type string

Here is the constructor for the Template object:

new Template(outputFormat, datasources, callback, data, connectionString, format, properties,
             parameters, tag, trackImports, trackErrors, mainPrinter,
             firstPagePrinter, printerJobName, printCopies, printDuplex)

Only set the input parameters that apply to your report. You must have either the data input parameter or the connectionString input parameter set.