Namespace: document

WebiServices.document

Represents the Web Intelligence document, which includes reports, elements, filters, and so on.

Methods

(static) addDataProvider(obj)

Adds a data provider to a document.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
dataprovider String
Properties
Name Type Description
name String the data provider name
dataSourceId Number | String the data source identifier. A string in case of a BEx query.
Returns:
A JSON object containing the success message and the ID of the data provider

Examples
Universe
{"dataprovider": {"name": "My New Data Provider", "dataSourceId": 1689}}
BEx Query
{"dataprovider": {"name":"My New Data Provider", "dataSourceId": 11990";AAQUERY_SAMPLE"}}

(static) addDocumentAlerter(obj)

Adds an alerter to the report.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
requestBody Object the alerter data
Returns:
A JSON object containing the success message and the ID of the alerter

(static) addReportElementProperty(obj)

Adds a custom property to the specified report element.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
requestBody Object
Properties
Name Type Description
property String
Properties
Name Type Description
@key String the property key
$ String the property value
Returns:
A JSON object containing the success message and the key of the property

(static) addVariable(obj)

Adds a variable to dictionary of a report.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
variable String
Properties
Name Type Description
@dataType Numeric | String | Date
@qualification Measure | Dimension | Detail
name String the variable name
definition String the variable definition
Returns:
A JSON object containing the success message and the ID of the variable

(static) createBreakOnAxis(obj)

Creates a break on an axis of a report element of type table.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
axisId Number the axis identifier. Values are "0" for a row, "1" for a column, and "2" for a body.
Returns:
A JSON object containing the success message and the break ID

(static) createDocumentInputControl(obj)

Creates a new input control of the document.
Parameters:
Name Type Description
obj Object the argument object
Properties
Name Type Description
data Object the object that contains the input control object
Properties
Name Type Description
inputcontrol Object the input control object
Returns:
A JSON object containing the success message

(static) createDrillerFilter(obj)

Creates a drill filter.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
requestBody Object the filter definition
Returns:
A JSON object containing the success message and the ID of the filter

(static) createInputControl(obj)

Creates a report input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId Number a valid report identifier
requestBody Object a JSON object representing the report input control
Returns:
A JSON object containing the success message and the ID of the report input control

(static) createReport(objopt)

Creates or copies a report.
Parameters:
Name Type Attributes Description
obj Object <optional>
 a JSON object
Properties
Name Type Description
report String the report
Properties
Name Type Description
name String the report name
Returns:
A JSON object containing the success message and the report ID

Example
{"report": {"name": "REPORT_NAME"}}

(static) createReportDataFilter(obj)

Creates the list of filters in the report (when there is no filter).
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
requestBody Object the report filter structure
Returns:
A JSON object containing the success message and the ID of the filter

(static) createReportElement(obj)

Creates a report element.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
requestBody Object a JSON object describing the report element data

Note: the JavaScript element object definition given to requestBody is the same that the one returned by WebiServices.document.getReportElement.
Returns:
A JSON object containing the success message and the report element ID

(static) createReportElementDataFilter(obj)

Creates the list of report element filters (when there is no filter).
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
requestBody Object the report filter structure
Returns:
A JSON object containing the success message and the ID of the data filter

(static) deleteAxisExpression(obj)

Deletes the set of expressions of an axis.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
axisId Number the axis identifier. Values are "0" for a row, "1" for a column, and "2" for a body.
Returns:
A JSON object containing the success message and the axis ID

(static) deleteAxisSorts(obj)

Deletes sortings on an axis of a report element of type table.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
axisId Number the axis identifier. Values are "0" for a row, "1" for a column, and "2" for a body.
Returns:
A JSON object containing the success message and the axis ID

(static) deleteBreakOnAxis(obj)

Deletes a break on an axis.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
axisId Number the axis identifier. Values are "0" for a row, "1" for a column, and "2" for a body.
breakId Number the break identifier
Returns:
A JSON object containing the success message and the break ID

(static) deleteDocumentAlerter(obj)

Deletes an alerter.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
alerterId Number a valid alerter identifier
Returns:
A JSON object containing the success message and the ID of the deleted alerter

(static) deleteDocumentInputControl(obj)

Deletes a document input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId String a valid document input control identifier
Returns:
A JSON object containing the success message and the ID of the deleted control

(static) deleteDocumentInputControlSelection(obj)

Deletes the selection on an input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId String a valid input control identifier
Returns:
A JSON object containing the success message

(static) deleteDrillerFilter(obj)

Deletes a drill filter.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
filterId Number a valid filter identifier
Returns:
A JSON object containing the success message and the ID of the deleted filter

(static) deleteInputControl(obj)

Deletes an input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
inputControlId String a valid input control identifier
Returns:
A JSON object containing the success message and the ID of the deleted input control

(static) deleteInputControlSelection(obj)

Deletes the selection on an input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
inputControlId String a valid input control identifier
Returns:
A JSON object containing the success message

(static) deleteReportDataFilter(obj)

Deletes the list of report filters.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
Returns:
A JSON object containing the success message and the ID of the deleted filter

(static) deleteReportElement(obj)

Deletes a report element.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
Returns:
A JSON object containing the success message and the report element ID

(static) deleteReportElementDataFilter(obj)

Deletes the list of report element filters.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
Returns:
A JSON object containing the success message and the ID of the deleted filter

(static) deleteReportElementProperty(obj)

Deletes a custom property attached to the specified report element.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
propertyKey String the property key
Returns:
A JSON object containing the success message and the key of the deleted property

(static) deleteVariable(obj)

Deletes a variable from the document expressions dictionary.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
variableId Number a valid variable identifier, obtained from the expressions dictionary
Returns:
  • A JSON object containing the success message and the variable ID deleted
  • A JSON object containing the success message and the ID of the deleted variable

(static) exportDocumentAsZip(obj) → {String}

Export the document as a ZIP file. Start download of a zip file containing the document in HTML format (listing mode)
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
requestBody Object a JSON object containing the script that allows the file archiving
reportIds Array.<Number> the list of valid identifiers of document reports
fileName String <optional>
 the ZIP file name. Important: don't use characters that are not supported by Operating Systems.
dpi Number <optional>
 resolution in dots per inch for generated charts (if any). Values are in [75,9600] and default is 96.
chartOutputFormat String <optional>
 generated charts rendering format. Values are "bmp", "gif", "jpeg" and "png" (default).
Returns:
message if exportDocumentAsZip is OK

Type
String
Examples
requestBody structure
{"zipfile": {"zipentry": ... }}
{"reportIds": REPORT_IDS, "fileName": ZIP_FILENAME, "dpi": DPI_VALUE, "chartOutputFormat": OUTPUT_VALUE}

(static) exportReportAsZip(obj) → {String}

Exports a report as a zipped HTML file. Start download of a zip file containing the HTML report
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
dpi Number <optional>
 resolution in dots per inch for generated charts (if any). Values are in [75,9600] and default is 96.
chartOutputFormat String <optional>
 generated charts rendering format. Values are "bmp", "gif", "jpeg" and "png" (default).
fileName String <optional>
 a string that defines the name of the ZIP file
Returns:
message if exportReportAsZip is OK

Type
String

(static) exportReportElement(obj)

Exports an element of a report.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
datapath String <optional>
 the datapath, for example "DP1.DObc:2004,DP1.DOa6:Austin"
reference String <optional>
 the report element reference
dpi Number <optional>
 resolution in dots per inch for generated charts (if any). Values are in [75,9600] and default is 96.
chartOutputFormat String <optional>
 generated charts rendering format. Values are "bmp", "gif", "jpeg" and "png" (default).
imageUrl String <optional>
 a string that customize image links in HTML when they cannot be reached from the information system
Returns:
A report element in HTML format

Example
{"reportId": REPORT_ID, "elementId": ELEMENT_ID, "datapath": DATA_PATH, "dpi": DPI_VALUE,
 "chartOutputFormat": OUTPUT_VALUE}

(static) exportReportElementAsImage(obj) → {String}

Exports an element of a report as image (graph block only) Start download of a png file containing the reportElement
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
datapath String <optional>
 the datapath, for example "DP1.DObc:2004,DP1.DOa6:Austin"
fileName String <optional>
 a string that defines the name of the image file
reference String <optional>
 the report element reference
dpi Number <optional>
 resolution in dots per inch for generated charts (if any). Values are in [75,9600] and default is 96.
Returns:
returns success message if exportReportElementAsImage is OK

Type
String
Example
{"reportId": REPORT_ID, "elementId": ELEMENT_ID, "datapath": DATA_PATH, "dpi": DPI_VALUE}

(static) exportReportListingMode(obj)

Exports a report as HTML in listing mode.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
dpi Number <optional>
 resolution in dots per inch for generated charts (if any). Values are in [75,9600] and default is 96.
chartOutputFormat String <optional>
 generated charts rendering format. Values are "bmp", "gif", "jpeg" and "png" (default).
imageUrl String <optional>
 a string that customize image links in HTML when they cannot be reached from the information system
Returns:
An HTML report

(static) getDataProviders(obj)

Returns the data proviers of a document.
Parameters:
Name Type Description
obj Object
Returns:
A JSON object containing the list of data providers

(static) getDocumentAlerter(obj)

Returns the alerter details.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
alerterId Number a valid alerter identifier
Returns:
A JSON object containing the alerter details

(static) getDocumentAlerters(obj)

Returns the document alerters.
Parameters:
Name Type Description
obj Object
Returns:
A JSON object containing the list of document alerters

(static) getDocumentCss(obj)

Returns the document CSS.
Parameters:
Name Type Description
obj Object
Returns:
A JSON object containing the document CSS

(static) getDocumentDataObject(obj) → {Object}

Returns the details of a data object

A data object is a data provider expression, a variable, or a merged object.

Parameters:
Name Type Description
obj Object params
Properties
Name Type Description
dataObjectId Number a valid data object identifier
Returns:
A JSON object containing the details of an object

Type
Object

(static) getDocumentDataObjectLov(obj)

Returns the list of values of a data object of the document.

A data object is a data provider expression, a variable, or a merged object.

Parameters:
Name Type Description
obj Object
Properties
Name Type Description
dataObjectId Number a valid data object identifier
Returns:
A JSON object containing the list of values

(static) getDocumentDataObjects(obj) → {Object}

Returns list of objects (data provider expression, variable, or merged object dimension) of a document.
Parameters:
Name Type Description
obj Object params
Properties
Name Type Description
dataObjectId Number a valid data object identifier
Returns:
A JSON object containing the list of objects

Type
Object

(static) getDocumentInputControl(obj)

Returns the definition of a specific input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId String a valid input control identifier
Returns:
A JSON object containing the definition of the input control

(static) getDocumentInputControlLov(obj)

Returns the lov of a specific input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId String a valid input control identifier
Returns:
A JSON object containing the lov of the input control

(static) getDocumentInputControls(obj)

Returns the list of input controls of the document.
Parameters:
Name Type Description
obj Object
Returns:
A JSON object containing the list of input controls

(static) getDocumentInputControlSelection(obj)

Returns document input control selection.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId String a valid input control identifier
Returns:
A JSON object containing the selected values

(static) getDPDetails(obj)

Returns the details of a data provider.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
dpId Number a valid data provider identifier
Returns:
A JSON object containing the data provider details

Example
var response = WebiServices.document.getDPDetails({"dpId": id});

(static) getDPFlowDetails(obj)

Returns the details of a given flow for a given data provider.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
dpId Number a valid data provider identifier
flowId Number a valid flow identifier
Returns:
The detail of the given flow as a String

Example
{"dpId": "DP_ID", "flowId": FLOW_ID}

(static) getDPNbFlows(obj)

Returns the number of available flows, for a given data provider.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
dpId Number a valid data provider identifier
Returns:
The number of flows for the data provider specified as a String

(static) getDPQuerySpec(obj)

Returns the query specification attached to a given data provider.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
dpId Number a valid data provider identifier
Returns:
The XML containing the query specification attached to a data provider as a String

(static) getDrillerFilter(obj)

Returns a drill filter definition.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
filterId Number a valid filter identifier
Returns:
A JSON object containing the drill filter details

(static) getDrillerFilters(obj)

Returns the list of drill filters.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
Returns:
A JSON object containing the drill filters

Example
var response = WebiServices.document.getDrillerFilters({"reportId": appContext.selectedReportId })
if (response.error)
  {
    if (response.error.error_code == 400)
       alert("Please activate drill mode");

    return;
 }

(static) getInputControl(obj)

Returns the definition of a specific input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
inputControlId String a valid input control identifier
Returns:
A JSON object containing the definition of the input control

(static) getInputControlLov(obj)

Returns the definition of a specific input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
inputControlId String a valid input control identifier
Returns:
A JSON object containing the lov of the input control

(static) getInputControls(obj)

Returns the list of input controls of a report.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
Returns:
A JSON object containing the list of input controls

(static) getInputControlSelection(obj)

Returns the selection on an input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
inputControlId String a valid input control identifier
Returns:
A JSON object representing the selection

(static) getParameters(lovInfo)

Returns the Web Intelligence document parameters.
Parameters:
Name Type Description
lovInfo Boolean true if the associated lists of values are computed, false otherwise
Returns:
A JSON object containing the list of parameters

Example
{"parameters": [{"parameter":{...}] }

(static) getReportDataFilter(obj)

Returns the list of filters of a report.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
Returns:
A JSON object containing the list of filters

Example
var response = WebiServices.document.getReportDataFilter({"reportId": id});

(static) getReportElement(obj)

Returns the details of a report element.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
reference String <optional>
 the reference of the element
Returns:
A JSON object containing report element details

(static) getReportElementDataFilter(obj)

Returns the list of filters of a report element.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
Returns:
A JSON object containing the list of filters

(static) getReportElementDatapaths(obj)

Returns the list of datapaths of a report element.
Parameters:
Name Type Description
obj Object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
datapath String <optional>
 the datapath
reference String <optional>
 the reference parameter that gives the datapath of this specific instance
Returns:
A JSON object containing the datapaths of the report element

(static) getReportElementDataset(obj)

Returns the dataset of a report element.
Parameters:
Name Type Description
obj Object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
datapath String <optional>
 the datapath
reference String <optional>
 the report element reference
Returns:
A JSON object containing the dataset of the report element

(static) getReportElementProperties(obj)

Returns the entire list of custom properties attached to the specified report element.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
Returns:
A JSON object containing the list of custom properties (key, value)

(static) getReportElementProperty(obj)

Returns the custom property value attached to the specified report element.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
propertyKey String the property key
Returns:
A JSON object containing the property value

(static) getReportElements(obj)

Returns the list of elements of a report.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
Returns:
A JSON object containing the list of report elements

(static) getReportMap(obj)

Returns the report map.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
reportId Number a valid report identifier
reference String <optional>
 a valid reference of a map node
Returns:
A JSON object containing the report map

(static) getReportOutput(obj)

Returns the report output.
Parameters:
Name Type Description
obj Object see WebiServices.document.exportReportListingMode function.
Returns:
The report output in XML format

(static) getReports()

Returns all document reports.
Returns:
A JSON object containing the document reports

Example
{"reports": [{"report":{...}] }

(static) getReportSpecification(obj)

Returns the report specification.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
Returns:
The report specification in XML format

Example
var xmlSource = WebiServices.document.getReportSpecification({
 "reportId": appContext.selectedReportId
 });

(static) getVariableDefinition(obj)

Returns the definition of a variable from the document expressions dictionary.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
variableId Number a valid variable identifier, obtained from the expressions dictionary
Returns:
The variable definition in XML format

(static) getVariables()

Returns the content of a document variables dictionary.
Returns:
A JSON object containing the list of variables

(static) refreshDocument(obj)

Refreshes a Web Intelligence document.
Parameters:
Name Type Description
obj Object a JSON object representing the list of parameters with answers
Properties
Name Type Attributes Description
lovInfo Boolean <optional>
 true if the associated lists of values are computed (default)
requestBody Object a JSON object {"parameters": [{"parameter":{...}] }

(static) saveDocumentAs(obj)

Saves a Web Intelligence document to a folder of the user machine.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Attributes Description
folderId Number <optional>
 the identifier of the BI launch pad destination folder
filename String the new document file name

(static) setAxisSorts(obj)

Creates sortings on an axis of a report element of type table.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
axisId Number the axis identifier. Values are "0" for a row, "1" for a column, and "2" for a body.
Returns:
A JSON object containing the success message and the axis ID

(static) setDocumentInputControlSelection(obj)

Set the selection.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId String a valid input control identifier
data Object the selection to be setted
Properties
Name Type Description
all Boolean true if select all
value Object the selection array
Returns:
A JSON object containing the success message

(static) setInputControlSelection(obj)

Sets the selection on an input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
inputControlId String a valid input control identifier
requestBody Object a JSON object representing the selection
Returns:
A JSON object containing the success message

(static) updateAxisExpression(obj)

Updates an axis with a set of expressions.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
axisId Number the axis identifier. Values are "0" for a row, "1" for a column, and "2" for a body.
requestBody Object a JSON expression object
Returns:
A JSON object containing the success message and the axis ID

(static) updateBreakOnAxis(obj)

Updates a break on an axis of a report element of type table.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
axisId Number the axis identifier. Values are "0" for a row, "1" for a column, and "2" for a body.
breakId Number the break identifier
Returns:
A JSON object containing the success message and the break ID

(static) updateDataProvider(obj)

Updates a data provider.
Parameters:
Name Type Description
obj Object
Properties
Name Type Attributes Description
dpId Number a valid data provider identifier
requestBody Object a JSON object representing the data provider
Properties
Name Type Description
dataprovider String a data provider structure
Properties
Name Type Description
name String a data provider name
purge String <optional>
 true to purge the data provider (default is false)
purgeOptions String <optional>
 option to control the purge operation. The only valid value is: "prompts". If unset or empty, only the data provider will be purged.
Returns:
A JSON object containing the success message and the data provider ID updated

Example
{"dpId": "DP_ID", "requestBody": {"dataprovider": {"name": "DP_NAME"}}, "purge": "PURGE_VALUE",
 "purgeOptions": "PURGE_OPTIONS_VALUE"}

(static) updateDocumentAlerter(obj)

Updates an alerter.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
alerterId Number a valid alerter identifier
requestBody Object the alerter data
Returns:
A JSON object containing the success message and the ID of the updated alerter

(static) updateDocumentCss(obj)

Updates the document CSS.
Parameters:
Name Type Description
obj Object The object argument
Properties
Name Type Description
cssContent String The CSS content
Returns:
A JSON object containing the success message

(static) updateDocumentInputControl(obj)

Updates an input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
inputControlId String a valid input control identifier
requestBody Object a JSON object representing the input control
Returns:
A JSON object containing the success message and the ID of the updated control

(static) updateDPQuerySpec(obj)

Updates the query specification attached to a given data provider.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
dpId Number a valid data provider identifier
requestBody String the XML to submit
Returns:
A JSON object containing the success message and the ID of the data provider

(static) updateDrillerFilter(obj)

Updates a drill filter definition.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
filterId Number a valid filter identifier
requestBody Object the filter definition
Returns:
A JSON object containing the success message and the ID of the updated filter

(static) updateInputControl(obj)

Updates an input control.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
inputControlId String a valid input control identifier
requestBody Object a JSON object representing the input control
Returns:
A JSON object containing the success message and the ID of the updated control

(static) updateReport(obj)

Updates the report with the specified values.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
requestBody Object the report structure containing the report name
Properties
Name Type Description
report String the report
Properties
Name Type Attributes Description
name String <optional>
 the report name
showDataChanges Boolean <optional>
 true to display the data changes according to the tracking definition of the document, false otherwise
Returns:
A JSON object containing the success message and the ID of the updated report

Example
{"reportId": REPORT_ID, "requestBody": {"report":{"name": "REPORT_NAME", "showDataChanges": true}}}

(static) updateReportDataFilter(obj)

Updates the list of report filters.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
requestBody Object the report filter structure
Returns:
A JSON object containing the success message and the ID of the updated filter

(static) updateReportElement(obj)

Updates a report element.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
requestBody Object a JSON object describing the report element data
Returns:
A JSON object containing the success message and the report element ID

(static) updateReportElementDataFilter(obj)

Updates the list of report element filters.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
reportId Number a valid report identifier
elementId Number a valid report element identifier
requestBody Object the report filter structure
Returns:
A JSON object containing the success message and the ID of the updated filter

(static) updateReportElementProperty()

Updates a custom property to the specified report element.
See:
Returns:
A JSON object containing the success message and the key of the updated property

(static) updateReportSpecification(obj)

Updates the report specification.
Parameters:
Name Type Description
obj Object a JSON object
Properties
Name Type Description
reportId Number a valid report identifier
requestBody String The XML of the report specification to submit
Returns:
A JSON object containing the success message and the report ID

Example
var xml = document.getElementById("txtReportSpec").value;
var docContext = WebiApplication.getContext();
var obj = {"reportId": docContext.selectedReportId, "requestBody": xml};
var response = WebiServices.document.updateReportSpecification(obj);

(static) updateVariable(obj)

Modifies the definition of an existing variable from the document expressions dictionary.
Parameters:
Name Type Description
obj Object
Properties
Name Type Description
variableId String a valid variable identifier, obtained from the expressions dictionary
requestBody Object the JSON object defining the variable to update
Properties
Name Type Description
variable String
Properties
Name Type Description
@dataType String Numeric|String|Date
@qualification String Measure|Dimension|Detail
name String the variable name
definition String the variable definition
Returns:
A JSON object containing the success message and the ID of the updated variable