Filter Submitted Tasks via TEWS ViewSubmittedTasks Call

Products

• CA Identity Manager
• CA Identity Governance
• CA Identity Portal
• CA Identity Suite

Issue/Introduction

This article provides the required TEWS XML structure and parameter definitions for filtering "View Submitted Tasks" requests in Identity Manager. This filter is commonly used to restrict results by user identity or specific timeframes.

Environment

Identity Manager 

Resolution

To successfully execute a ViewSubmittedTasks request, use the following XML structure. Ensure that date parameters utilize the specific format: MM/dd/YYYY HH:mm.

TEWS Request Example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://tews6/wsdl">
   <soapenv:Header/>
   <soapenv:Body>
      <wsdl:TaskContext>
         <!--You may enter the following 11 items in any order-->
         <!--Optional:-->
         <wsdl:admin_id>imadmin</wsdl:admin_id>
         <!--Optional:-->
         <wsdl:admin_password>PASSWORD</wsdl:admin_password>
         <!--Optional:-->
         <wsdl:transaction_id>new</wsdl:transaction_id>

      </wsdl:TaskContext>
      <wsdl:ViewSubmittedTasksQuery>
         <!--Optional:-->
         <wsdl:ViewSubmittedTasksSubmittedTasksTab>
            <!--Optional:-->
            <wsdl:SearchCriteria>
               <!--Optional: -->
               <wsdl:InitiatedBy>?</wsdl:InitiatedBy>

               <!--Optional:-->
               <wsdl:PerformedOnObjectType>USER</wsdl:PerformedOnObjectType>
               <!--Optional:-->
               <wsdl:PerformedOnObjectFriendlyName>USER-ID</wsdl:PerformedOnObjectFriendlyName> -->


               <!--Optional:-->
               <wsdl:SubmittedAfter>11/02/2021 01:00</wsdl:SubmittedAfter>
               <wsdl:SubmittedBefore>12/05/2021 01:00</wsdl:SubmittedBefore>
      
               <!--Optional:-->
               <wsdl:ShowUnsubmittedTasks>false</wsdl:ShowUnsubmittedTasks>

               <wsdl:ShowArchiveDB>false</wsdl:ShowArchiveDB>
               <!--Optional:-->
               <wsdl:MaxmiumReturnRows>?</wsdl:MaxmiumReturnRows>
            </wsdl:SearchCriteria>
            <!--Optional:-->
 
         </wsdl:ViewSubmittedTasksSubmittedTasksTab>
      </wsdl:ViewSubmittedTasksQuery>
   </soapenv:Body>
</soapenv:Envelope>

Required Parameters:

 

Parameter	Requirements
SubmittedAfter	Use MM/dd/YYYY HH:mm format. Do not use StartDate.
SubmittedBefore	Use MM/dd/YYYY HH:mm format. Do not use EndDate.
PerformedOnObjectType	Must be set to USER (case-sensitive, must be uppercase).

Note: If you receive unexpected results or errors, verify that you are not using deprecated tags such as StartDate or EndDate. Only SubmittedAfter and SubmittedBefore are supported for time-based filtering.