|
Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Service API Calls >
DeletedItemQueryPage
Returns details of deleted items. Objects Supported
DeletedItemQueryPage is supported for all Web Services v1.0 and Web Services v2.0 accessible objects that can be deleted. Usage
You use the DeletedItemQueryPage method to execute a query against the list of deleted records, and return a subset of the records that match the search criteria set by the method arguments. The set of records returned is sorted by DeletedDate in ascending order (as shown in the response in Sample SOAP Request - DeletedItemQueryPage). The Type of the DeletedItems object returned by the DeletedItemQueryPage method is not always the same as that used in the UI of the Oracle CRM On Demand application, as shown in Table 43. NOTE: In Table 43, the * characters are asterisk characters, and do not represent wildcard characters.
You must use the types shown in the table in queries for deleted item records. (The type is language independent.)
Table 43. Deleted Item Types Returned by DeletedItemQueryPage Method
|
|
Account |
Account |
Account Attachment |
Account Attachment |
Account Note |
Account Note |
Account Private Note |
Account Private Note |
Action Attachment |
Action Attachment |
Address |
Address |
Appointment |
Action***Appointment |
Asset |
Asset Mgmt - Asset |
Campaign |
Campaign |
Campaign Attachment |
Campaign Attachment |
Campaign Note |
Campaign Note |
Channel Partner |
Channel Partner |
Contact |
Contact |
Contact Attachment |
Contact Attachment |
Contact Interest |
Contact Interests |
Contact Note |
Contact Note |
Contact Private Note |
Contact Private Note |
Custom Object 01 |
OnDemand Custom Object 1 |
Custom Object 02 |
OnDemand Custom Object 2 |
Custom Object 03 |
OnDemand Custom Object 3 |
Custom Object n (where n = 04 and higher) |
CustomObjectn (where n = 4 and higher) |
Custom Object 01 Attachment |
OnDemand Custom Object 1 Attachment |
Custom Object 02 Attachment |
OnDemand Custom Object 2 Attachment |
Custom Object 03 Attachment |
OnDemand Custom Object 3 Attachment |
Custom Object 01 Note |
OnDemand Custom Object 1 Note |
Custom Object 02 Note |
OnDemand Custom Object 2 Note |
Custom Object 03 Note |
OnDemand Custom Object 3 Note |
Dealer Attachment |
Dealer Attachment |
Dealer Note |
Dealer Note |
Event |
Pharma ME Event |
Forecast Revenue |
Forecast Revenue |
Fund |
Fund |
Fund Attachment |
Fund Attachment |
Fund Note |
Fund Note |
Fund Request |
Fund Request |
Fund Request Attachment |
Fund Request Attachment |
Fund Request Note |
Fund Request Note |
Household |
Household |
Lead |
Lead |
Lead Attachment |
Lead Attachment |
Note |
Note |
Opportunity |
Opportunity |
Opportunity Attachment |
Opportunity Attachment |
Opportunity Note |
Opportunity Note |
Opportunity Private Note |
Opportunity Private Note |
Organization |
Organization |
Organizations Note |
Organizations Note |
Plan Account |
CRMODLS_BPL_ACNT |
Portfolio |
VONDINS Portfolio***Portfolio |
Portfolio Child |
VONDINS Portfolio Child***Portfolio |
Position |
Position |
Product Detailed |
Pharma Call Product Detailed |
Referral |
VONDINS Referral***Referral |
Revenue |
Revenue |
Sales Stage Attachment |
Sales Stage Attachment |
Sample Dropped |
Pharma Call Sample Dropped |
Service Request |
Service Request |
Service Request Attachment |
Service Request Attachment |
Service Request Note |
Service Request Note |
Smart Call |
Pharma Template Call |
Solution |
Solution |
Solution Attachment |
Solution Attachment |
Task |
Action***Task |
Vehicle |
Auto Vehicle |
Arguments
Table 44 describes the arguments taken by the DeletedItemQueryPage method.
Table 44. Arguments Taken by the DeletedItemQueryPage Method
|
|
|
|
|
ListOfDeletedItem |
The list of object instances queried (input), and after query execution, the list of object instances returned (output). |
Yes |
Not applicable |
Input/Output |
PageSize |
The maximum number of records displayed on a page following a query. |
No |
10 |
Input |
StartRowNum |
Indicates the row from which the DeletedItemQueryPage method starts to return records. Use the StartRowNum argument to return a set of records for any given method. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query. |
No |
0 |
Input |
LastPage |
A value that indicates whether or not the last value in the query set has been returned. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The following information is returned for deleted items:
- DeletedItemId. The ID of the deleted item.
- DeletedById. The user ID of the user who deleted the item.
- DeletedBy. The name of the user who deleted the item.
- DeletedDate. The date on which the item was deleted.
- Name. The name of the deleted record.
- ObjectId. The object ID of the deleted record.
- Type. The type of the deleted record.
- ExternalSystemId. The external system ID of the item.
Sample SOAP Request - DeletedItemQueryPage
The following SOAP request queries the list of deleted items with the object type = "Contact". It demonstrates the use of the optional arguments <PageSize> and <StartRowNum> to return a specific number of records starting at a specific row. <?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
<wsse:UsernameToken>
<wsse:Username>%%%USERNAME%%%</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<DeletedItemWS_DeletedItemQueryPage_Input xmlns="urn:crmondemand/ws/deleteditem/">
<ListOfDeletedItem>
<DeletedItem>
<DeletedItemId />
<DeletedById />
<DeletedBy />
<DeletedDate />
<Name />
<ObjectId />
<Type>='Contact'</Type>
<ExternalSystemId />
</DeletedItem>
</ListOfDeletedItem>
<PageSize>3</PageSize>
<StartRowNum>0</StartRowNum>
</DeletedItemWS_DeletedItemQueryPage_Input>
</soap:Body>
</soap:Envelope>
Sample SOAP Response
The following SOAP response contains three deleted contact records: <?xml version="1.0" encoding="utf-8"?>
<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:DeletedItemWS_DeletedItemQueryPage_Output xmlns:ns="urn:crmondemand/ws/deleteditem/">
<ns:LastPage>true</ns:LastPage>
<ListOfDeletedItem xmlns="urn:/crmondemand/xml/deleteditem">
<DeletedItem>
<DeletedItemId>ADSA-921PLC</DeletedItemId>
<DeletedBy>Joanne Brown</DeletedBy>
<DeletedById>HRZ780-I5RUE</DeletedById>
<DeletedDate>08/02/2011 15:19:24</DeletedDate>
<Name>Person One</Name>
<ObjectId>ADSA-921PL5</ObjectId>
<Type>Contact</Type>
<ExternalSystemId></ExternalSystemId>
</DeletedItem>
<DeletedItem>
<DeletedItemId>ADSA-93EVML</DeletedItemId>
<DeletedBy>Joanne Brown</DeletedBy>
<DeletedById>HRZ780-I5RUE</DeletedById>
<DeletedDate>08/04/2011 12:16:39</DeletedDate>
<Name>Jordan Lak</Name>
<ObjectId>ADSA-93EGXJ</ObjectId>
<Type>Contact</Type>
<ExternalSystemId>ABC321</ExternalSystemId>
</DeletedItem>
<DeletedItem>
<DeletedItemId>ADSA-93EVFP</DeletedItemId>
<DeletedBy>Joanne Brown</DeletedBy>
<DeletedById>HRZ780-I5RUE</DeletedById>
<DeletedDate>08/04/2011 12:20:44</DeletedDate>
<Name>J Lak</Name>
<ObjectId>ADSA-93ET5I</ObjectId>
<Type>Contact</Type>
<ExternalSystemId>abc223</ExternalSystemId>
</DeletedItem>
</ListOfDeletedItem>
</ns:DeletedItemWS_DeletedItemQueryPage_Output>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
| 
