The Data Returned

Understanding the Web Services › The Report List Web Service › The Data Returned

The Data Returned

The Report List Web Service request returns lists of attributes for selected reports in repositories. The attributes that are returned are requested by the client application using the fields input parameter. The client application can request a single field of information or multiple fields. If more than 50 field names are specified the request fails with a WEBSER051E error. The selection criteria can select a single report or multiple reports.

Based on the request being made and the number of reports that are selected, the data content that is returned differs as follows:

If the returnas value is "Vector", there is a vector entry for each report. The vector entry is a string array with an entry for each field.
If the returnas value is "StringArray", there is a string array entry for each report. The string array entry is another string array with an entry for each field.
If the returnas value is "XMLString", there is an entry for each report. The entry includes entries for each field.
If the returnas value is XMLAttachment, it contains a file with the same data that is returned by XMLString.

For example, a request to return data fields for the text reports beginning with the letter c in the repository that defines the repository definition file named "TestRepository" contains the following parameters:

Request Parameter	Value
Userid	"omuser"
Password	"ompwd"
Repository	"TestRepository"
ReturnAs	"vector"
Fields	"RID","GEN","SEQ","DOC_TYPE","LPAGES","LINES", "ARCDATE","ARCTIME"
Selection Criteria	DOC_TYPE="TEXT" RID="C*"

The request returns the following data:

Item	RID	GEN	SEQ	DOC_TYPE	LPAGES	LINES	ARCDATE	ARCTIME
1	CHARRPT3	19	19	TEXT	1	41	3/1/00	8:17:55:29
2	CHARRPT4	19	18	TEXT	1	41	2/29/00	11:22:17:03

Specifying a returnas value of "xmlstring" returns the following data for the text reports beginning with the letter c in the repository that defines the repository definition file named "TestRepository":

<reportlistdata>

<report>

<rid>CHARRPT3</rid>
<gen>19</gen>
<seq>19</seq>
<doc_type>TEXT</doc_type>
<lpages>1</lpages>
<lines>41</lines>
<arcdate>3/1/00</arcdate>
<arctime>8:17:55:29</arctime>

<rpt_handle>c3c8c1d9d9d7e3f3404040404040404040404040ffecffec000000000000000000000

000</rpt_handle>

</report>
<report>

<rid>CHARRPT4</rid>
<gen>19</gen>
<seq>18</seq>
<doc_type>TEXT</doc_type>
<lpages>1</lpages>
<lines>41</lines>
<arcdate>2/29/00</arcdate>
<arctime>11:22:17:03</arctime>

<rpt_handle>c3c8c1d9d9d7e3f3404040404040404040404040ffecffed000000000000000000010

000</rpt_handle>

</report>

</reportlistdata>