Namespace: WebiServices

WebiServices

Represents the Web Intelligence Services global namespace object.

Namespaces

document

Methods

(static) getAbout()

Returns basic information about the Web Intelligence REST Web Services and SAP BusinessObjects BI version.
Returns:
A JSON object containing basic information about the Web Intelligence REST Web Services and SAP BusinessObjects BI version.

(static) getConnection(obj)

Returns the details of a connection in the CMS repository.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
connectionId Number the CMS connection identifier
Returns:
A JSON object containing the connection details

(static) getConnections(obj)

Returns the list of available connections in the CMS repository.
Parameters:
Name Type Description
obj Object
Properties
Name Type Attributes Default Description
limit Number <optional>
 10 the number of files in the list. Range is [0, 50].
offset Number <optional>
 0 the position in the list, from which connections are returned
type String <optional>
 the connection type. ("Relational", "FlattenedOlap", "Olap" or "DataFederator").
Returns:
A JSON object containing the connections

(static) getSpreadsheet(obj)

Returns the details of an Excel file on the CMS repository.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
spreadsheetId Number the Excel file identifier
Returns:
A JSON object containing the Excel spreadsheet details

(static) getSpreadsheets(obj)

Returns the list of available Excel files on the CMS repository.
Parameters:
Name Type Description
obj Object
Properties
Name Type Attributes Default Description
limit Number <optional>
 10 the number of files in the list. Range is [0, 50].
offset Number <optional>
 0 the position in the list, from which files are returned
Returns:
A JSON object containing the Excel spreadsheets

(static) isReady() → {Boolean}

Returns whether if the Web Intelligence services are ready to use.
Returns:
true if they are ready, false otherwise
Type
Boolean