GetReportsByFolderNameAdvanced

Guida SDK › Portal Integration › Web Services › Methods for Web Services › Report Methods › GetReportsByFolderNameAdvanced

GetReportsByFolderNameAdvanced

Description

This method returns full content of a specified folder according to specified search criteria, excluding booklets and shortcuts.

Syntax

A typical syntax for this method is shown. Note that the exact syntax to use depends on the type of protocol used to communicate with the web service.

DataSet

GetReportsByFolderNameAdvanced (

string

sessionID,

string

foldername,

string
 CriteriaXML)

Parameters

Name	Type	Description
sessionID	string	Current session ID to perform authentication check.
foldername	string	Contains folder name.
CriteriaXML	string	Contains search criteria. <Criteria> <Name></Name> <ReportTypes></ReportTypes> </Criteria> CriteriaXML parameter contains search criteria for report selection: Name node contains mask for searching report by name. Asterisks () symbols are allowed for a mask search. ReportTypes node contains a comma-separated list of report types to search. Available report types are Freeform, Group, Compound, and Normal. Type names are case-insensitive. Example: <Criteria> <Name>Service Rep</Name> <ReportTypes>FreeForm,Group</ReportTypes> </Criteria> When criteriaXML parameter is an empty string, all report types are included in the resulting list.

Name

Type

Description

sessionID

string

Current session ID to perform authentication check.

foldername

string

Contains folder name.

CriteriaXML

string

Contains search criteria.

<Criteria>
          <Name></Name>
          <ReportTypes></ReportTypes>
</Criteria>

CriteriaXML parameter contains search criteria for report selection:

Name node contains mask for searching report by name. Asterisks (*) symbols are allowed for a mask search.

ReportTypes node contains a comma-separated list of report types to search. Available report types are Freeform, Group, Compound, and Normal. Type names are case-insensitive.

Example:

<Criteria>
          <Name>Service Rep*</Name>
          <ReportTypes>FreeForm,Group</ReportTypes>
</Criteria>

When criteriaXML parameter is an empty string, all report types are included in the resulting list.

Return Value

Returns a dataset in the following format:

Table name: tblreports

Field Name	Type	Description
item_id	Long	ID to perform authentication check.
item_name	String	Name of the report.
user_id	Long	ID of User that owns the report.
folder_id	Long	ID of the folder that the report is located in.
folder_name	String	Name of the folder that the report is located in.
item_description	String	Report description.
item_type	String	Item type (report).
report_type	String	Report type (normal, compound, group, booklet, free-form).
is_executable	boolean	Shows if report is executable.
modify_date	Date	Last modify date.
schedule_id	Long	ID of schedule.

Errors

If any errors occur, web service will log and throw the InsightWebServiceException error.

Error Name	Description
AUTH_ERROR	Authentication failed.
NO_USER_PERMISSION	User does not have permission to view reports.
FOLDER_NOT_EXIST	Specified folder does not exist.
OE_ILLEGAL_PARAMETER	Specified parameter is not valid.

Remarks

All parameters are mandatory.

Sample Scenarios

Possible scenarios to generate request report data:

Request	Result
Call method without permission to view reports	Throws error NO_USER_PERMISSION.
Call method only with SessionID	Default filter data is applied (All reports types in my reports).
FolderID = 0	Returns all reports that exist in root folder only.
FolderID = 0 Subfolders = 1	Returns all reports in all folders.
FolderID = 0 FolderName = “FolderName"	Returns all reports that exist in root folder only. Folder name is not relevant.
FolderName = “FolderName”	Returns all reports that exist in folder by name “FolderName”.
Specify invalid FolderID or FolderName	Throws error OE_FOLDER_NOT_EXIST.

Contatta CA Technologies