getEntityList操作

この操作は、ビジネス・オブジェクト・サービスに対して定義されているサービス・データ・オブジェクトのリストを取得します。

ビジネス・オブジェクト・サービスが汎用サービス・インタフェースを実装する場合、この操作は、アプリケーション・コンポーザで定義されたカスタム・オブジェクトに関する情報を取得します。たとえば、販売カスタム・ビジネス・オブジェクト・サービスでgetEntityList操作を呼び出すと、アプリケーション・コンポーザで販売アプリケーションに定義されたカスタム・オブジェクトが返されます。汎用サービス・インタフェースを実装するその他のビジネス・オブジェクト・サービスには、カスタム共通ビジネス・オブジェクト、顧客カスタム・ビジネス・オブジェクト、マーケティング・カスタム・ビジネス・オブジェクト、販売カスタム・ビジネス・オブジェクト、営業リード・カスタム・ビジネス・オブジェクトおよび営業テリトリ・カスタム・ビジネス・オブジェクトがあります。

各サービス・データ・オブジェクトについて、応答ペイロードには次の情報が含まれます。

QName: サービス・データ・オブジェクトを表す、対応するXMLスキーマ複合型の完全修飾名。
サービス・データ・オブジェクトのサービス・ビュー使用名: サービスを定義するアプリケーション・モジュール内の内部名。この値をパラメータとしてgetDfltObjAttrHints操作に渡すと、サービス・データ・オブジェクトの属性のUIヒントを取得できます。
アプリケーション・コンポーザで定義されたカスタム・オブジェクトのオブジェクト名: この情報は、汎用サービス・インタフェースを実装するビジネス・オブジェクト・サービスでこの操作が呼び出された場合にのみ返されます。
ブール値: これらの値は、create、update、mergeおよびdelete操作をサービス・データ・オブジェクトに対して直接実行できるかどうかを示します。デフォルト値はfalseです。

操作のシグネチャ

入力パラメータを受け取らないgetEntityList操作のシグネチャは次のとおりです。

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

応答ペイロードには、そのサービス定義内のサービス・データ・オブジェクトに関する情報が格納されます。 ServiceViewInfoの定義は、BC4JService.xsdのサンプルを参照してください。

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

例

この例は、営業リード・サービスに対して定義されたgetEntityList操作の要求ペイロードを示しています。

<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>

この例の応答ペイロードには、営業リード・サービスで参照されるすべてのサービス・データ・オブジェクトに関する情報が格納されます。特定の結果について、typeNameがサービス・データ・オブジェクトにマップされている場合があります。 canCreate、canUpdate、canMergeまたはcanDeleteがtrueに設定されている場合、対応する標準のCRUD操作がサービス・データ・オブジェクトのサービス・インタフェースで公開されます。この例では、応答ペイロードの最初の2つの要素のみを示しています。

<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>

操作のシグネチャ

例

関連する操作