runDynamicQuery

Parameters

projectName

Limits access to a project. Set the value as an empty string the query to search records in all projects that the session's user ID has access to.

moduleName

Limits the query to records in a module. Set the value as an empty string to indicate all modules

objectTypeNames

Limits the query to the object types. Set the value as an empty string to indicate all object types. If multiple object types are included, only fields that are a part of the base object definition for that module returns data.

guiNames

Limits the query to the GUI. Set the value as an empty string to indicate all GUIs.

associatedModuleName

Limits the query to the associated records of the Module ID.

associatedObjectTypeName

Limits the query to the associated records of the object type ID.

projectScope

Set the scope of the project by setting the value of projectScope to 0 for an active project, 1 for company level or 2 for all projects.

displayFields

Used to identify the fields included in the report. If a section name is not specified or recognized, that section is treated as the top-level section for the primary business object.

associatedDisplayFields

Used to identify the fields of the associated object. If a section name is not specified or recognized, that section is treated as the top-level section for the associated business object.

fieldSortOrders

An array of descriptors that describe how results are ordered.

filters

An array of dynamic filter parameters for this query.

start

Defines the start position of the search. For example, if a query returns 5 results and you set the start value to 1, all 5 results are returned. If you set the start value to 4, the last 2 results are returned.

maximumResultCount

Limits the number of records returned. The maximumResultCount argument cannot exceed the max integer value of 2147483647, minus the start argument. Since the start argument is base 1, the maximumResultCount cannot exceed 2147483646.

Returns

A QueryResult object that contains the resulting records, a total count of the results and a continuation token, if any, is returned.

Errors

ProjectDoesNotExistException

The project does not exist.

ModuleDoesNotExistException

The module does not exist.

ObjectTypeDoesNotExistException

The object type does not exist.

RecordDoesNotExistException

The record does not exist.

InvalidArgumentException

At least one of the arguments is invalid.

AccessException

The user does not have access to the module, business object, or record.

java.lang.Exception

A system error occurred when the request was being processed.

Sample request

<soapenv:Envelope 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:ws="http://ws.tririga.com" xmlns:dto="http://dto.ws.tririga.com">
   <soapenv:Body>
      <ws:runDynamicQuery>
         <ws:projectName/>
         <ws:moduleName>triPeople</ws:moduleName>
         <ws:objectTypeNames>
            <!--Zero or more repetitions:-->
            <ws:string>triPeople</ws:string>
         </ws:objectTypeNames>
         <ws:guiNames/>
         <ws:associatedModuleName/>
         <ws:associatedObjectTypeName/>
         <ws:projectScope>2</ws:projectScope>
         <ws:displayFields>
            <!--Zero or more repetitions:-->
            <dto:DisplayLabel>
               <dto:fieldName>triFirstNameTX</dto:fieldName>
               <!--Optional:-->
               <dto:label>First Name</dto:label>
               <dto:sectionName>Detail</dto:sectionName>
            </dto:DisplayLabel>
         </ws:displayFields>
         <ws:associatedDisplayFields/>
         <ws:fieldSortOrders/>
         <ws:filters/>
         <ws:associationFilters/>
         <ws:start>1</ws:start>
         <ws:maximumResultCount>2</ws:maximumResultCount>
      </ws:runDynamicQuery>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<soap:Envelope 
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:xsd="http://www.w3.org/2001/XMLSchema" 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <runDynamicQueryResponse xmlns="http://ws.tririga.com">
         <out>
            <continuationToken xmlns="http://dto.ws.tririga.com">
               <tokenString>80240783D81B64C65DB4A49620432065-1163463554765-0.2994752033211511</tokenString>
            </continuationToken>
            <queryResponseHelpers xmlns="http://dto.ws.tririga.com">
               <QueryResponseHelper>
                  <assocBoId xsi:nil="true"/>
                  <assocId xsi:nil="true"/>
                  <boId>106402</boId>
                  <queryResponseColumns>
                     <QueryResponseColumn>
                        <displayValue>loadTest_0.06389105809334483</displayValue>
                        <index>0</index>
                        <label>First Name</label>
                        <name>triFirstNameTX</name>
                        <section>Detail</section>
                        <uom/>
                        <value>loadTest_0.06389105809334483</value>
                     </QueryResponseColumn>
                  </queryResponseColumns>
                  <recordId>2573261</recordId>
               </QueryResponseHelper>
               <QueryResponseHelper>
                  <assocBoId xsi:nil="true"/>
                  <assocId xsi:nil="true"/>
                  <boId>106402</boId>
                  <queryResponseColumns>
                     <QueryResponseColumn>
                        <displayValue>loadTest_0.019704049349783426</displayValue>
                        <index>0</index>
                        <label>First Name</label>
                        <name>triFirstNameTX</name>
                        <section>Detail</section>
                        <uom/>
                        <value>loadTest_0.019704049349783426</value>
                     </QueryResponseColumn>
                  </queryResponseColumns>
                  <recordId>2573349</recordId>
               </QueryResponseHelper>
            </queryResponseHelpers>
            <totalResults xmlns="http://dto.ws.tririga.com">450</totalResults>
         </out>
      </runDynamicQueryResponse>
   </soap:Body>
</soap:Envelope>