getGUIs
Gets the metadata headers of all the GUIs for a particular object type. This lightweight method is useful for making a quick call to retrieve the GUI name or IDs for use with other methods. This method filters out alternative forms that are retrieved. Alternative forms are not returned for selection on the GUI.
Parameters
objectTypeId is the ID of the object type.
Returns
An array of the GUI objects is returned with the tab data emitted.
Errors
- ObjectTypeDoesNotExistException
- No object type with the ID objectTypeId exists.
- InvalidArgumentException
- The objectTypeId is less than or equal to zero.
- 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">
<soapenv:Body>
<ws:getGUIs>
<ws:objectTypeId>10010138</ws:objectTypeId>
</ws:getGUIs>
</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>
<getGUIsResponse xmlns="http://ws.tririga.com">
<out>
<ns1:GUI xmlns:ns1="http://gui.dto.ws.tririga.com">
<childRecordId xmlns="http://gui.dto.ws.tririga.com">0</childRecordId>
<id xmlns="http://gui.dto.ws.tririga.com">10015638</id>
<label xmlns="http://gui.dto.ws.tririga.com">ProjectWFTest</label>
<moduleId xmlns="http://gui.dto.ws.tririga.com">22219</moduleId>
<moduleName xmlns="http://gui.dto.ws.tririga.com">_rrTest</moduleName>
<name xmlns="http://gui.dto.ws.tririga.com">ProjectWFTest</name>
<objectTypeId xmlns="http://gui.dto.ws.tririga.com">10010138</objectTypeId>
<objectTypeName xmlns="http://gui.dto.ws.tririga.com">ProjectWFTest</objectTypeName>
<popupId xmlns="http://gui.dto.ws.tririga.com">0</popupId>
<recordId xmlns="http://gui.dto.ws.tririga.com">0</recordId>
<recordName xsi:nil="true" xmlns="http://gui.dto.ws.tririga.com"/>
<saveOnPopup xmlns="http://gui.dto.ws.tririga.com">false</saveOnPopup>
<singleTab xmlns="http://gui.dto.ws.tririga.com">false</singleTab>
<state xsi:nil="true" xmlns="http://gui.dto.ws.tririga.com"/>
<tabs xsi:nil="true" xmlns="http://gui.dto.ws.tririga.com"/>
<type xmlns="http://gui.dto.ws.tririga.com">Wizard</type>
</ns1:GUI>
</out>
</getGUIsResponse