get Operation

The get operation accepts the primary key of a business object in the request payload and returns the entire corresponding business object in the response payload. If the business object is a composite business object, then the operation returns all the attributes of the service data objects and its child and descendant objects.

If the internal ID of the business object is not known, use the find operation to query based on alternate key or other search criteria.

Operation Signature

The following is the definition of the get operation for the Sales Lead service. The operation accepts the Sales Lead internal identifier, which is of long type.

<element name="getSalesLead">
    <complexType>
        <sequence>
            <element name="leadId" type="long"/>
        </sequence>
    </complexType>
</element>

The operation returns information for the corresponding Sales Lead business object, which is of MklLead type.

<element name="getSalesLeadResponse">
    <complexType>
        <sequence>
            <element name="result" type="ns1:MklLead"/>
        </sequence>
    </complexType>
</element>

Example

This example retrieves the Sales Lead object with 300100041938883 as the internal identifier.

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

The response payload includes all the attributes of the Sales Lead business object.

<ns0:getSalesLeadResponse xmlns="" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns0="http://xmlns.oracle.com/apps/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">
    <ns2:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" 
xmlns:ns1="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/" 
xmlns:ns2="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/types/" 
xmlns:ns3="http://xmlns.oracle.com/apps/crmCommon/notes/noteService"
xmlns:ns4="http://xmlns.oracle.com/oracle/apps/marketing/leadMgmt/leads/leadService/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns4:MklLead">
    <ns4:Name>Issaquah Imaging Innovations - Tablets</ns4:Name>
        <ns4:LeadNumber>CDRM_80328</ns4:LeadNumber>
        <ns4:OwnerPartyName>Gabrielle Lee</ns4:OwnerPartyName>
        <ns4:StatusCode>UNQUALIFIED</ns4:StatusCode>
        <ns4:Rank xsi:nil="true"/>
        ...
        <ns4:leadId>300100041938883</ns1:leadId>
        <ns4:DealAmount currencyCode="USD" 
xmlns:tns="http://xmlns.oracle.com/adf/svc/errors/">100000</ns4:DealAmount>
        ...
        <ns4:MklLeadResources>
            <ns1:LeadResourceId>300100041938884</ns1:LeadResourceId>
            <ns1:CreatedBy>SALES_ADMIN</ns1:CreatedBy>
            <ns1:CreationDate>2015-04-01T05:02:38.426-07:00</ns1:CreationDate>
            <ns1:LastUpdateDate>2015-04-01T05:02:39.87-07:00</ns1:LastUpdateDate>
            <ns1:LastUpdatedBy>SALES_ADMIN</ns1:LastUpdatedBy>
            <ns1:ObjectVersionNumber>1</ns1:ObjectVersionNumber>
            <ns1:PrimaryFlag>true</ns1:PrimaryFlag>
            <ns1:FunctionalRole xsi:nil="true"/>
            <ns1:ResourceId>100010025532672</ns1:ResourceId>
            <ns1:LeadId>300100041938883</ns1:LeadId>
            <ns1:OrgTreeCode/>
            <ns1:OrgTreeStructureCode/>
            <ns1:OrgTreeVersionId/>
            <ns1:ResourceOrgId/>
            <ns1:EmailAddress>sendmail-test-discard@oracle.com</ns1:EmailAddress>
            <ns1:PartyName>Gabrielle Lee</ns1:PartyName>
            <ns1:PrimaryPhonePurpose>BUSINESS</ns1:PrimaryPhonePurpose>
            <ns1:RoleName/>
            <ns1:ManagerName/>
            <ns1:FormattedPhoneNumber>+1 (650) 506-6601</ns1:FormattedPhoneNumber>
            <ns1:Name/>
            <ns1:ManagerPartyId xsi:nil="true"/>
            <ns1:StartDateActive>2009-05-20</ns1:StartDateActive>
            <ns1:EndDateActive>4712-12-31</ns1:EndDateActive>
        </ns4:MklLeadResources>
    </ns2:result>
</ns0:getSalesLeadResponse><ns0:getLocationResponse xmlns=""

Related Operations

To retrieve only a subset of attributes of a large business object or a service data object with descendants more than the default fetch size of 500, use the find operation. This operation allows you to specify fetch start, fetch size, complex search criteria, business object attributes to include or exclude, and sort order.

Related Topics

Standard CRUD Operations

create Operation

delete Operation

find Operation

find by additional predefined search criteria Operation

update Operation

merge Operation

process Operation