Inquiry UI  Locate

The Inquiry UI API has been implemented for improving the performance of the Business Service Control. The basic idea is to retrieve data that appear in the Business Service Control using a single API call.

This API contains only one operation get_entityDetail. Its input includes a query specification and an output format:

The operation get_entityDetail returns a list of UDDI data structures. ACLs are also applied to retrieved data.

For example, if you specify the following inquiry:

<get_entityDetail xmlns="http://systinet.com/uddi/inquiryUI/6.0">
  <outputFormat>
    <businessEntityMask descriptionIncluded="true" identifierBagIncluded="true"/>
    <businessServiceMask descriptionIncluded="true"/>
  </outputFormat>
  <find_binding serviceKey="uddi:systinet.com:demo:hr:employeesList" 
     xmlns="urn:uddi-org:api_v3"/>
</get_entityDetail>

You will receive the following output:

<entityDetail xmlns="http://systinet.com/uddi/inquiryUI/6.0">
  <businessEntity businessKey="uddi:systinet.com:demo:hr" 
        xmlns="urn:uddi-org:api_v3">
    <name>HR</name>
    <description>HR department</description>
    <businessServices>
      <businessService serviceKey="uddi:systinet.com:demo:hr:employeesList" 
            businessKey="uddi:systinet.com:demo:hr">
        <name>EmployeeList</name>
        <description>wsdl:type representing service</description>
      </businessService>
    </businessServices>
    <identifierBag>
      <keyedReference tModelKey="uddi:systinet.com:demo:departmentID" 
            keyName="department id" keyValue="002"/>
    </identifierBag>
  </businessEntity>
</entityDetail>

If there are matching bindingTemplates accessible while associated businessServices are not (because of ACLs), such bindingTemplates will be included in the result in a separate list of bindingTemplates. The same behavior applies to accessible businessServices of inaccessible businessEntities.

Data Structures  Locate

The following structures are used by the Inquiry UI API:

bindingTemplateMask  Locate

Table 44. Attributes

AttributeRequired
descriptionIncludedNo
categoryBagIncludedNo
SignatureIncludedNo

The bindingTemplateMask structure specifies the mask of the binding template of the outputFormat. Optional attributes define which elements will be returned in the entityDetail

businessEntityMask  Locate

Table 45. Attributes

AttributeRequired
discoveryURLIncludedNo
descriptionIncluded No
identifierBagIncludedNo
categoryBagIncludedNo
SignatureIncludedNo

The businessEntityMask structure specifies the mask of the business entity of the outputFormat. It also include a contactMask. Optional attributes define which elements will be returned in the entityDetail.

businessServiceMask  Locate

Table 46. Attributes

AttributeRequired
descriptionIncluded No
categoryBagIncludedNo
SignatureIncludedNo

The businessServiceMask structure specifies the mask of the business service of the outputFormat. Optional attributes define which elements will be returned in the entityDetail.

contactMask  Locate

The contactMask structure specifies the submask of the business entity mask of the outputFormat. Optional attributes define which elements will be returned in the entityDetail

Table 47. Attributes

AttributeRequired
descriptionIncluded No
phoneIncluded No
emailIncludedNo
addressIncludedNo
entityDetail  Locate

The entityDetail structure is returned by the get_entityDetail operation. The attribute truncated indicates a truncated result list.

Table 48. Attributes

AttributeRequired
uddi:truncatedNo
outputFormat  Locate

The outputFormat is a mask for data to be returned and can prune returned structures. The output format is defined by the following arguments.

tModelInstanceInfoMask  Locate

The tModelInstanceInfoMask structure specifies the mask of the tModel instance info of the outputFormat. Optional attributes define which elements will be returned in the entityDetail

Table 49. Attributes

AttributeRequired
descriptionIncludedNo
instanceDetailsIncludedNo
tModelMask  Locate

The tModelMask structure specifies the mask of the tModel of the outputFormat. Optional attributes define which elements will be returned in the entityDetail

Table 50. Attributes

AttributeRequired
descriptionIncludedNo
overviewDocIncludedNo
identifierBagIncludedNo
categoryBagIncludedNo
SignatureIncludedNo
Operations  Locate
get_entityDetail  Locate

This is the core operation of the Inquiry UI API.

Arguments  Locate
  • uddi:authInfo - This optional argument is an element that contains an authentication token.

  • inquiryUI:outputFormat

  • uddi:get_businessDetail, uddi:get_bindingDetail, uddi:get_tModelDetail, uddi:find_business, uddi:find_service, uddi:find_binding, uddi:find_tModel - standard UDDI v3 structures.

Returns  Locate

Upon successful completion, an entityDetail structure is returned.

WSDL  Locate

You can find the WSDL specification in the file inquiryUI.wsdl.

API Endpoint  Locate

You can find the Inquiry UI API endpoint at http://<host name>:<port>/<context>/uddi/inquiryUI.

Java  Locate

Java API is generated directly from WSDL. You are encouraged to browse org.systinet.uddi.client.v3.ui.InquiryUIApi.