Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Service API Calls >

HistoryQueryPage

Executes a query against the Recently Viewed records section in the Action bar, and returns a subset of the records that match the search criteria set by the method arguments.

Usage

You use the HistoryQueryPage method to read the records that are displayed in the Recently Viewed records section in the Action bar in the Oracle CRM On Demand application.

The following are attributes of the <ListOfHistoryItem> element that you can specify:

• pagesize. Determines the maximum number of records displayed on a page following a query.
• startrownum. Indicates the row from which the HistoryQueryPage method starts to return records.
• recordcountneeded. Indicates whether a record count for the query is to be returned.

Each of the child elements of <ListOfHistoryItem> can have the following attributes:

• sortorder. Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.
• sortsequence. An integer value that determines the order of the sort specification.

The following are attributes of the <HistoryItemData> element that can be returned:

• recordcount. An integer value that indicates the record count.
• lastpage. A value that indicates whether or not the last value in the query set has been returned.

Arguments

Table 55 describes the arguments taken by the HistoryQueryPage method.

Return Value of the Call

A list of recently viewed records. The following are the child elements of ListOfHistory:

• Id. The row ID of the record.
• CreatedById. One of the standard audit fields, see Audit Fields.
• CreatedDate. One of the standard audit fields, see Audit Fields.
• CreatedBy. One of the standard audit fields, see Audit Fields.
• ModifiedById. One of the standard audit fields, see Audit Fields.
• ModifiedDate. One of the standard audit fields, see Audit Fields.
• ModifiedBy. One of the standard audit fields, see Audit Fields.
• ModId. The modification key.
• ObjectName. The system name of the object.
• ObjectId. The object ID of the record.
• ObjectDisplay. The display name of the record.
• Order. A sequence number. Recently viewed records are displayed in the UI in descending order. If two records have the same <Order> value, then <CreatedDate> is considered.
• RecordCreated. The date and time the record was created.
• RecordType. The record type.

Sample SOAP Request - HistoryQueryPage

The following SOAP request retrieves all of the records from the Recently Viewed list.

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:his="urn:crmondemand/ws/history/" xmlns:quer="urn:/crmondemand/xml/historyitem/Query">

<soapenv:Header/>

   <soapenv:Body>

      <his:HistoryQueryPage_Input>

         <quer:ListOfHistoryItem>

            <quer:HistoryItem>

               <quer:Id></quer:Id>

               <quer:CreatedById></quer:CreatedById>

               <quer:CreatedDate></quer:CreatedDate>

               <quer:CreatedBy></quer:CreatedBy>

               <quer:ModifiedById></quer:ModifiedById>

               <quer:ModifiedDate></quer:ModifiedDate>

               <quer:ModifiedBy></quer:ModifiedBy>

               <quer:ModId></quer:ModId>

               <quer:ObjectName></quer:ObjectName>

               <quer:ObjectId></quer:ObjectId>

               <quer:ObjectDisplay></quer:ObjectDisplay>

               <quer:Order></quer:Order>

               <quer:RecordCreated></quer:RecordCreated>

               <quer:RecordType></quer:RecordType>

            </quer:HistoryItem>

         </quer:ListOfHistoryItem>

      </his:HistoryQueryPage_Input>

   </soapenv:Body>

</soapenv:Envelope>

Sample SOAP Response - HistoryQueryPage

The following SOAP response contains ten items from the Recently Viewed list (only two items are shown):

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <SOAP-ENV:Body>

      <ns:HistoryQueryPage_Output xmlns:ns="urn:crmondemand/ws/history/">

         <ListOfHistoryItem lastpage="false" xmlns="urn:/crmondemand/xml/historyitem Data">

            <HistoryItem>

               <Id>1QA2-33GUI8</Id>

               <CreatedById>1-CZ010</CreatedById>

               <CreatedDate>2018-01-02T08:18:03Z</CreatedDate>

               <CreatedBy>Tara Treadlightly, 01/02/2018 03:18:03</CreatedBy>

               <ModifiedById>1-CZ010</ModifiedById>

               <ModifiedDate>2018-01-02T08:18:03Z</ModifiedDate>

               <ModifiedBy>Tara Treadlightly, 01/02/2018 03:18:03</ModifiedBy>

               <ModId>0</ModId>

               <ObjectName>ServiceQuota</ObjectName>

               <ObjectId>1QA2!591</ObjectId>

               <ObjectDisplay>Web Services Operations Allotment</ObjectDisplay>

               <Order>28</Order>

               <RecordCreated>2018-01-02T08:18:03Z</RecordCreated>

               <RecordType/>

            </HistoryItem>

...

...

            <HistoryItem>

<Id>1QA2-33GUIH</Id>

<CreatedById>1-CZ010</CreatedById>

<CreatedDate>2018-01-02T08:18:03Z</CreatedDate>

<CreatedBy>Tara Treadlightly, 01/02/2018 03:18:03</CreatedBy>

<ModifiedById>1-CZ010</ModifiedById>

<ModifiedDate>2018-01-02T08:18:03Z</ModifiedDate>

<ModifiedBy>Tara Treadlightly, 01/02/2018 03:18:03</ModifiedBy>

<ModId>0</ModId>

<ObjectName>Product</ObjectName>

<ObjectId>1QA2-1AV5FQ</ObjectId>

<ObjectDisplay>WSPRD2</ObjectDisplay>

<Order>37</Order>

<RecordCreated>2018-01-02T08:18:03Z</RecordCreated>

<RecordType/>

            </HistoryItem>

         </ListOfHistoryItem>

      </ns:HistoryQueryPage_Output>

      </SOAP-ENV:Body>

</SOAP-ENV:Envelope>