runNamedQuery
Runs a pre-defined query that is stored in the platform in the Report Manager.
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 QueryResult object is returned. The QueryResult object contains the resulting records, a total count of the results and a continuation token, if any.
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:Body>
<ws:runNamedQuery>
<ws:projectName/>
<ws:moduleName>triPeople</ws:moduleName>
<ws:objectTypeName>triPeople</ws:objectTypeName>
<ws:queryName>triEmployee - Find</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>11</dto:operator>
<dto:sectionName>Detail</dto:sectionName>
<dto:value>Guest User</dto:value>
</dto:Filter>
</ws:filters>
<ws:start>1</ws:start>
<ws:maximumResultCount>2</ws:maximumResultCount>
</ws:runNamedQuery>
</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>
<runNamedQueryResponse xmlns="http://ws.tririga.com">
<out>
<continuationToken xmlns="http://dto.ws.tririga.com">
<tokenString>B36189CC1AB8D7989B867AC33C218A63-1163464971156-0.9400269990980881</tokenString>
</continuationToken>
<queryResponseHelpers xmlns="http://dto.ws.tririga.com">
<QueryResponseHelper>
<assocBoId xsi:nil="true"/>
<assocId xsi:nil="true"/>
<boId>106402</boId>
<queryResponseColumns>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>0</index>
<label>!</label>
<name>triUserMessageFlagTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue>API User 111</displayValue>
<index>1</index>
<label>Name</label>
<name>triNameTX</name>
<section>Detail</section>
<uom/>
<value>API User 111</value>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>2</index>
<label>Title</label>
<name>triTitleTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>3</index>
<label>Primary Organization</label>
<name>triPathTX</name>
<section>triPrimaryOrganization</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>4</index>
<label>Work Phone</label>
<name>triWorkPhoneTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>5</index>
<label>Work Fax</label>
<name>triWorkFaxTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>6</index>
<label>eMail</label>
<name>triEmailTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
</queryResponseColumns>
<recordId>2552575</recordId>
</QueryResponseHelper>
<QueryResponseHelper>
<assocBoId xsi:nil="true"/>
<assocId xsi:nil="true"/>
<boId>106402</boId>
<queryResponseColumns>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>0</index>
<label>!</label>
<name>triUserMessageFlagTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue>api1test api1test</displayValue>
<index>1</index>
<label>Name</label>
<name>triNameTX</name>
<section>Detail</section>
<uom/>
<value>api1test api1test</value>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>2</index>
<label>Title</label>
<name>triTitleTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>3</index>
<label>Primary Organization</label>
<name>triPathTX</name>
<section>triPrimaryOrganization</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>4</index>
<label>Work Phone</label>
<name>triWorkPhoneTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>5</index>
<label>Work Fax</label>
<name>triWorkFaxTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
<QueryResponseColumn>
<displayValue xsi:nil="true"/>
<index>6</index>
<label>eMail</label>
<name>triEmailTX</name>
<section>Detail</section>
<uom/>
<value xsi:nil="true"/>
</QueryResponseColumn>
</queryResponseColumns>
<recordId>2538355</recordId>
</QueryResponseHelper>
</queryResponseHelpers>
<totalResults xmlns="http://dto.ws.tririga.com">326</totalResults>
</out>
</runNamedQueryResponse>
</soap:Body>
</soap:Envelope>