getDfltObjAttrHints Operation
This operation returns the labels for the service data objects and the label and UI hints for a given locale for the business object attributes, which are part of the service definition.
This table lists information about the return values of
the getDfltObjAttrHints
operation.
Level | Key | Value |
---|---|---|
Service data object | LABEL | Name of object (singular) |
Service data object | LABEL_PLURAL | Name of object (plural) |
Service data object attribute | LABEL_ResId | Expression to retrieve the key from the resource bundle |
You must pass the internal names of the service data
objects as parameters. To retrieve these internal names, invoke the getEntityList
operation defined on this
service.
Operation Signature
The getDfltObjAttrHints
operation accepts two parameters:
-
viewName
: Corresponds to the service view usage name, which is an internal name for the service data object. Specify the value of the<name>
element from thegetEntityList
response payload. -
localeName
: Evaluates locale-based UI hints. The format of this value is ISO 639-1.
The following is the signature of the getDfltObjAttrHints
operation:
<element name="getDfltObjAttrHints">
<complexType>
<sequence>
<element name="viewName" type="string"/>
<element name="localeName" type="string"/>
</sequence>
</complexType>
</element>
The response payload contains the label and UI hints for
the object and the object attributes in a name-value pair format. For the definition
of ObjAttrHints
type, see Sample BC4JService.xsd.
<element name="getDfltObjAttrHintsResponse">
<complexType>
<sequence>
<element name="result" type="ns0:ObjAttrHints"/>
</sequence>
</complexType>
</element>
Example
This example shows a request payload that specifies the
usage name and en
locale of the Sales
Lead object, and requests for the label and UI hints.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getDfltObjAttrHints
xmlns:ns1="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/types/">
<ns1:viewName>SalesLead</ns1:viewName>
<ns1:localeName>en</ns1:localeName>
</ns1:getDfltObjAttrHints>
</soap:Body>
</soap:Envelope>
The response payload contains information about the service data object attribute. The example payload shows only the object entity level and three of the attribute level hints.
<ns0:getDfltObjAttrHintsResponse 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:ObjAttrHints">
<ns0:objHint>
<ns0:key>LABEL</ns0:key>
<ns0:value>Sales Lead</ns0:value>
</ns0:objHint>
<ns0:objHint>
<ns0:key>TOOLTIP</ns0:key>
<ns0:value>The interest or the potential interest of prospects or existing customers in
a product or service being sold.</ns0:value>
</ns0:objHint>
<ns0:objHint>
<ns0:key>LABEL_PLURAL</ns0:key>
<ns0:value>Sales Lead</ns0:value>
</ns0:objHint>
<ns0:attrHints>
<ns0:attrName>LeadId</ns0:attrName>
<ns0:ctrlHint>
<ns0:key>fnd:GLOBALLY_UNIQUE</ns0:key>
<ns0:value>true</ns0:value>
</ns0:ctrlHint>
<ns0:ctrlHint>
<ns0:key>LABEL_ResId</ns0:key>
<ns0:value>${adfBundle['oracle.apps.marketing.leadMgmt.leads.resource.
MklLeadsAttrBundle']['ColAttr.Identifier.LeadIdentifier.MKLLMLEADS.LEADID']}
</ns0:value>
</ns0:ctrlHint>
<ns0:ctrlHint>
<ns0:key>ExtnEventActionProperty</ns0:key>
<ns0:value>UpdateInFieldUpdate</ns0:value>
</ns0:ctrlHint>
<ns0:ctrlHint>
<ns0:key>fnd:OSN_OBJECT_KEY</ns0:key>
<ns0:value>true</ns0:value>
</ns0:ctrlHint>
</ns0:attrHints>
<ns0:attrHints>
<ns0:attrName>DealAmount</ns0:attrName>
<ns0:ctrlHint>
<ns0:key>LABEL_ResId</ns0:key>
<ns0:value>${adfBundle['oracle.apps.marketing.leadMgmt.leads.resource.
MklLeadsAttrBundle']['ColAttr.DealSize.LeadDealSize.MKLLMLEADS.DEALSIZE']}
</ns0:value>
</ns0:ctrlHint>
<ns0:ctrlHint>
<ns0:key>ExtnEventActionProperty</ns0:key>
<ns0:value>UpdateInFieldUpdate</ns0:value>
</ns0:ctrlHint>
<ns0:ctrlHint>
<ns0:key>fnd:OSN_ENABLED_ATTR</ns0:key>
<ns0:value>true</ns0:value>
</ns0:ctrlHint>
<ns0:ctrlHint>
<ns0:key>fnd:FND_AUDIT_ATTR_ENABLED</ns0:key>
<ns0:value>true</ns0:value>
</ns0:ctrlHint>
<ns0:ctrlHint>
<ns0:key>fnd:APPLCORE_SETID_LOOKUP_TYPE</ns0:key>
<ns0:value>LEAD_TIMELINE</ns0:value>
</ns0:ctrlHint>
</ns0:attrHints>
...
</ns1:result>
</ns0:getDfltObjAttrHintsResponse>
Related Operations
To get the list of entities and their names, use the
getEntityList
operation and then
pass the name as a request parameter to the getDfltObjAttrHints
operation.