Report Details

Request information about a report, including the parameters the report requires to be executed.

Only available to hosted SaaS clients

HTTP Request

GET /icweb.dll/report/{key}

URI Parameters

Name	In	Required	Type	Description	Default
`key`	Path	Yes	Integer	Key associated with report.

Responses

Name	Type	Description
200 OK	Report	OK
404 Not Found	String	Dashboard identified by key was not found.

Report

Contains the information associated with a report.

Name	Type	Description	Optional
`name`	string	Name of the report	No
`parameters`	Parameter []	List of parameters that the report requires.	No
`excludable`	Excludable	Defines the elements in the report that can be excluded from being generated	Yes

Parameter

Specifies a parameter for a report, a report may have 0 or more parameters, these parameters contain information on allowing the user to select or enter an appropriate value.

Name	Type	Description	Optional	Default
`parameterName`	string	Name of the parameter.	No
`displayName`	string	Display caption used when displaying the parameter to the user for them to enter/select a value.	No
`order`	integer	Display order of the parameter.	No
`columns`	integer	The number of display columns that this column consumes, report parameters should be displayed in a 2 column form.	No	1
`blankText`	string	Text that can be used, in a greyed-out embedded in the control for the parameter.	Yes
`fieldType`	Integer	Field Type of the parameter, determines what data can be entered by the user.	No
`editorType`	Integer	Editor that should be used for the parameter.	No
`foreignTable`	Integer	If this is a foreign key, then this specifies the table that should be used to provide a selection dialog.	Yes
`multiSelect`	Boolean	Does this parameter allow multiple values to be selected.	No	No
`lookupList`	Integer	Specifies the key of the lookup list to use, if `fieldType` is a lookup list.	No	No
`required`	Boolean	Is a value required to be provided for this report parameter.	No	True
`previousValue`	Any	Contains the previously selected value from the last time this report was executed.	Yes	Null

Excludable

Specifies a report element that may be excluded and defines children that may also be excluded.

Name	Type	Description	Optional	Default
`name`	string	Name of the report element.	No
`description`	string	Description of the report element.	No
`canExclude`	bool	True if the element can be excluded from the report	No
`key`	integer	Key associated with the element, when excluding elements from a report job, this key should be specified.	No
`elements`	Excludable []	List of child elements that may be excluded.	Yes

Example

Retrieve the name and parameters for the report identified by the key of 3

Request

GET /icweb.dll/report/3

Response

{
        "name": "Test Report",
        "parameters": [{
                        "parameterName": "Component_ID",
                        "displayName": "Asset",
                        "order": 0,
                        "columns": 1,
                        "fieldType": 3,
                        "editorType": 13,
                        "foreignTable": "Component",
                        "multiSelect": true,
                        "previousValue": 2
                }, {
                        "parameterName": "Workpack_ID",
                        "displayName": "Workpack",
                        "order": 0,
                        "columns": 1,
                        "fieldType": 3,
                        "editorType": 13,
                        "foreignTable": "Workpack",
                }
        ],
        "excludable": {
                "name": "Test Report",
                "canExclude": false,
                "key": 9,
                "elements": [{
                                "name": "Repeat Assets",
                                "canExclude": false,
                                "key": 10,
                                "elements": [{
                                                "name": "Tasks",
                                                "canExclude": true,
                                                "key": 11,
                                                "elements": []
                                        }
                                ]
                        }
                ]
        }
}