runNamedQueryMultiBoLocalized

Parameters

projectName

The name of the project.

moduleName

The name of the module.

objectTypeName

The name of the object type.

queryName

The name of the query.

filters

An array of filter objects for this query. The filters do not need to be runtime filters. Any filters that are already applied to the static query pertain. If a $$RECORDID$$ association filter is predefined in the query, a single associated record ID can be included in the request by specifying $$RECORDID$$ as the field name and the associated record ID as the value.

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 QueryMultiBoResult object is returned. The QueryMultiBoResult object contains the resulting records, a total count of the results, and a continuation token, if any. Each resulting record in the QueryMultiBoResult contains QueryMultiBoResponseColumn elements. Each QueryMultiBoResponseColumn element includes the module name, the business object name, and resulting data for the corresponding query defined display column. Each QueryMultiBoResponseColumn also contains a multiBoFieldIndex element. The multiBoFieldIndex element is used as an incremental index for a QueryMultiBoResponseColumn field that has the same name, module, and business object as another QueryMultiBoResponseColumn field. The first time a QueryMultiBoResponseColumn field is used, the multiBoFieldIndex element has a value of zero. The value of the multiBoFieldIndex element increases by one each time it is used. The displayValue element within each QueryMultiBoResponseColumn contains the translated value based on the user's locale.

Errors

ProjectDoesNotExistException

The project does not exist.

ModuleDoesNotExistException

The module does not exist.

ObjectTypeDoesNotExistException

The object type does not exist.

QueryDoesNotExistException

The query 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:Header/>
   <soapenv:Body>
      <ws:runNamedQueryMultiBoLocalized>
         <ws:projectName></ws:projectName>
         <ws:moduleName>triProject</ws:moduleName>
         <ws:objectTypeName>triFacilitiesProject</ws:objectTypeName>
         <ws:queryName>triFacilitiesProject - Projects And Users Demo</ws:queryName>
                 <ws:filters>
                    <dto:Filter>
                      <dto:fieldName>$$RECORDID$$</dto:fieldName>
                      <dto:value>10596554</dto:value>
                    </dto:Filter>
                   <dto:Filter>
                       <dto:dataType>320</dto:dataType>
                       <dto:fieldName>triNameTX</dto:fieldName>
                       <dto:operator>16</dto:operator>
                       <dto:sectionName>RecordInformation</dto:sectionName>
                       <dto:value>Facility</dto:value>
                   </dto:Filter>
                 </ws:filters>
                 <ws:start>1</ws:start>
         <ws:maximumResultCount>2</ws:maximumResultCount>
      </ws:runNamedQueryMultiBoLocalized>
   </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>
      <runNamedQueryMultiBoLocalizedResponse xmlns="http://ws.tririga.com">
         <out>
              <continuationToken xmlns="http://dto.ws.tririga.com">
                  <tokenString>B36189CC1AB8D7989B867AC33C218A63-1163464971156-0.9400269990980882</tokenString>
              </continuationToken>
              <queryMultiBoResponseHelpers>   
               <QueryMultiBoResponseHelper>
                  <boId>10003240</boId>
                  <queryMultiBoResponseColumns>
                     <QueryMultiBoResponseColumn>
                        <displayValue>Facility Project Test 1</displayValue>
                        <index>0</index>
                        <module>triProject</module>
                        <bo>triFacilitiesProject</bo>
                        <label>Name</label>
                        <name>triNameTX</name>
                        <multiBoFieldIndex/>
                        <section>RecordInformation</section>
                        <uom/>
                        <value>Facility Project Test 1</value>
                     </QueryMultiBoResponseColumn>
                     <QueryMultiBoResponseColumn>
                        <displayValue>Captital Project Test 1</displayValue>
                        <index>1</index>
                        <module>triProject</module>
                        <bo>triCapitalProject</bo>
                        <label>Name</label>
                        <name>triNameTX</name>
                        <multiBoFieldIndex/>
                        <section>RecordInformation</section>
                        <uom/>
                        <value>Captital Project Test 1</value>
                      </QueryMultiBoResponseColumn>
                     <QueryMultiBoResponseColumn>
                        <displayValue>Captital Project Test 2</displayValue>
                        <index>2</index>
                        <module>triProject</module>
                        <bo>triCapitalProject</bo>
                        <label>Name</label>
                        <name>triNameTX</name>
                        <multiBoFieldIndex>1</multiBoFieldIndex>
                        <section> RecordInformation</section>
                        <uom/>
                        <value>Captital Project Test 2</value>
                     </QueryMultiBoResponseColumn>
                     <QueryMultiBoResponseColumn>
                        <displayValue>John User</displayValue>
                        <index>3</index>
                        <module>triPeople</module>
                        <bo>triPeople</bo>
                        <label>Name</label>
                        <name>triNameTX</name>
                        <multiBoFieldIndex/>
                        <section> Details</section>
                        <uom/>
                        <value>John User</value>
                     </QueryMultiBoResponseColumn>
                  </queryMultiBoResponseColumns>
                  <recordId>10598779</recordId>
               </QueryMultiBoResponseHelper>
            </queryMultiBoResponseHelpers>
            <totalResults xmlns="http://dto.ws.tririga.com">1</totalResults>
         </:return>
      </:runNamedQueryMultiBoLocalizedResponse>
   </soap:Body>
</soap:Envelope>