getEntityList Operation

If the business object service implements a generic service interface, this operation retrieves information about custom objects defined in the Application Composer. For example, invoking the getEntityList operation on the Sales Custom Business Object service returns the custom objects defined in the Sales application in the Application Composer. Other business object services which implement a generic service interface include Custom Common Business Object, Customer Custom Business Object, Marketing Custom Business Object, Sales Custom Business Object, Sales Lead Custom Business Object, and Sales Territory Custom Business Object.

For each service data object, the response payload includes:

QName: A fully qualified name of the corresponding XML Schema complex type representing the service data object.
Service view usage name for the service data object: An internal value in the application module that defines the service. This value can be passed as a parameter to the getDfltObjAttrHints operation to get UI hints for attributes in the service data object.
Object name for custom objects defined in Application Composer: This information is returned only when the operation is invoked on a business object service that implements a generic service interface.
Boolean values: These values indicate whether create, update, merge, and delete operations can be performed directly on the service data object. The default value is false.

Operation Signature

The following is the signature of the getEntityList operation, which doesn't accept any input parameters.

<element name="getEntityList">
    <complexType>
        <sequence/>
    </complexType>
</element>

The response payload contains information about the service data objects in this service definition. For the definition of ServiceViewInfo, see Sample BC4JService.xsd.

<element name="getEntityListResponse">
    <complexType>
        <sequence>
            <element maxOccurs="unbounded" minOccurs="0" 
            name="result" type="ns2:ServiceViewInfo"/>
        </sequence>
    </complexType>
</element>

Example

This example shows a request payload for the getEntityList operation defined on the Sales Lead service.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns1:getEntityList
xmlns:ns1="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/
types/"></ns1:getEntityList>
    </soap:Body>
</soap:Envelope>

The sample response payload contains information for all the service data objects referenced in the Sales Lead service. For a given result, the typeName can be mapped to a service data object. If canCreate, canUpdate, canMerge or canDelete is set to true, the corresponding standard CRUD operation is exposed on the service interface of the service data object. This example shows only the first two elements of the response payload.

<ns0:getEntityListResponse xmlns="" 
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns0="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/types/"
xmlns:wsa="http://www.w3.org/2005/08/addressing"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <ns1:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/"  
xmlns:ns1="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/types/"
xmlns:tns="http://xmlns.oracle.com/adf/svc/errors/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns0:ServiceViewInfo">
    ...
    <ns1:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" 
xmlns:ns1="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/types/"
xmlns:tns="http://xmlns.oracle.com/adf/svc/errors/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns0:ServiceViewInfo">
        <ns0:name>SalesLead</ns0:name>
        <ns0:typeName>{http://xmlns.oracle.com/oracle/apps/marketing/leadMgmt/leads/
        leadService/}MklLead</ns0:typeName>
        <ns0:canCreate>true</ns0:canCreate>
        <ns0:canUpdate>true</ns0:canUpdate>
        <ns0:canMerge>true</ns0:canMerge>
        <ns0:canDelete>true</ns0:canDelete>
    </ns1:result>
    <ns1:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" 
xmlns:ns1="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/types/"
xmlns:tns="http://xmlns.oracle.com/adf/svc/errors/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns0:ServiceViewInfo">
        <ns0:name>SalesLeadContact</ns0:name>
        <ns0:typeName>{http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/
        leadService/}MklLeadTcMembers</ns0:typeName>
        <ns0:canCreate>true</ns0:canCreate>
        <ns0:canUpdate>true</ns0:canUpdate>
        <ns0:canDelete>true</ns0:canDelete>
    </ns1:result>
</ns0:getEntityListResponse>

Related Operations

To get UI hints for the service data objects in a service definition, pass the name element in the getEntityList response payload to the getDfltObjAttrHints request payload.