Lists of Values
You
can use Lists of Values (LOVs) to retrieve frequently used static
data, such as member status, member class, voucher discount type,
and types or subtypes for transactions, and so on. You can get the
values in an LOV through a DESCRIBE call.
You can use the DESCRIBE call on any REST resource
to retrieve lovResourcePath information for each LOV attribute. The lovResourcePath information includes
the resource to be invoked and the filter to be applied to get the
list of accepted values for that LOV attribute. For example, to retrieve
the list of valid LOV values for ORA_LOY_MEM_STATUS (Member Status)
attribute, you run the DESCRIBE call' on loyMembers resource. that is, loyMembers/describe. Please note
that there could be multiple lovResourcePath parameters available. The status code of interest here is ORA_LOY_MEM_STATUS:
"lov"; {
"childRef": "MemberStatus",
"attributeMap": [
{
"source": "LookupCode",
"target": "StatusCode"
}
],
"lovResourcePath": [
{
"resource": "fndStatisLookups",
"filter": "?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_STATUS"
}
]
},In the this example, the resource parameter under lovResourcePath indicates the REST
resource to invoke, and filter indicates the filter to use. So, the corresponding REST call is
as follows: :
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder;BindLookupType=ORA_LOY_MEM_STATUSThe result of this REST call provides
the list of valid LOV values for the attribute ORA_LOY_MEM_STATUS.
The payload contains LookupCode and Meaning among other
details. For brevity, the lookup codes and their meanings are summarized
in the following table.
| LookupCode | Meaning |
|---|---|
| ORA_MEM_STATUS_ACTIVE | Active |
| ORA_MEM_STATUS_CANCEL | Canceled |
| ORA_MEM_STATUS_DORMAT | Dormant |
| ORA_MEM_STATUS_INACTIVE | Inactive |
| ORA_MEM_STATUS_POT_FRAUD | Potentially Fraudulent |
| ORA_MEM_STATUS_MERGED | Merged |
| ORA_MEM_STATUS_PAYPEND | Payment Pending |