API Lookups
Limited Support/End of Life Capabilities
The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.
If you need to request a hotfix or support for these features, please contact Alemba Support
ASM has two Application Programming Interfaces (or APIs), which enable you to develop programs that automate many common ASM transactions. This section of the documentation deals with the Classic API.
All lookup input fields in the API are declared with the prefix “l”; for example,
InputParams.lCustomer.
Every lookup field can be used to search by a ref or name. If the input value begins with a tilde (~), the search will be performed by ref. Otherwise, the search will be performed by name. The name that can be used in the lookup is specific to each lookup.
If lCustomer =
~20, the API will search for Users where REF=20. If lCustomer =joeBloggs@alemba.com, the API will search for Users where EMAIL_ID=joeBloggs@alemba.com. If lCustomer =~joeBloggs, the API will return an error.
If lOfficer =
~20, then API will search for Analysts where REF=20. If lOfficer =JoeB12, the API will search for Analysts where USER_ID=JoeB12. If lOfficer =joeBloggs@alemba.com, the API will return an error.
If lSentBy =
~20, the API will search for Person records where REF=20. If lSentBy =Joe Bloggs, the API will search for Person records where DISPLAY=Joe Bloggs. If lSentBy =JoeB12, the API will return an error.
The tables below list the ref and name fields (Ref Field and Value Field respectively) in each table that can be used in each type of lookup.