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.
Table:
AR_CLASS
Ref Field:
REF
Value Field:
NAME
Table:
AR_CRITICALITY
Ref Field:
REF
Value Field:
NAME
Table:
AR_DISPOSAL_METHOD
Ref Field:
REF
Value Field:
NAME
Table:
AR_FINANCIAL_CATEGORY
Ref Field:
REF
Value Field:
NAME
Table:
AR_FIN_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
AR_CRITICALITY
Ref Field:
REF
Value Field:
NAME
Table:
AR_MANUFACTURER
Ref Field:
REF
Value Field:
NAME
Table:
AR_MODEL_TYPES
Ref Field:
REF
Value Field:
NAME
Table:
AR_PHYSICAL_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
AR_PURCHASE_METHOD
Ref Field:
REF
Value Field:
NAME
Table:
AR_USER_CATEGORY
Ref Field:
REF
Value Field:
DESCRIPTION
Table:
SU_ENTITY_TYPE
Ref Field:
REF
Value Field:
DISPLAY
Table:
AR_PRIMARY_ASSET
Ref Field:
ITEM_REF
Value Field:
ASSET_REF
Table:
AR_PRIMARY_ASSET
Ref Field:
ITEM_REF
Value Field:
ASSET_REF
Table:
AR_PRIMARY_ASSET
Ref Field:
ITEM_REF
Value Field:
ASSET_REF
Table:
AR_PRIMARY_ASSET
Ref Field:
ITEM_REF
Value Field:
ASSET_REF
Table:
AR_PRIMARY_ASSET
Ref Field:
ITEM_REF
Value Field:
ASSET_REF
Table:
AR_CLIENT_COMPANY
Ref Field:
CLIENT_CO_REF
Value Field:
CLIENT_CO_NAME
Table:
AR_CLIENT_COMPANY
Ref Field:
CLIENT_CO_REF
Value Field:
CLIENT_CO_NAME
Table:
AR_INDUSTRIES
Ref Field:
INDUSTRY_REF
Value Field:
INDUSTRY_NAME
Table:
AR_USER_CATEGORY
Ref Field:
REF
Value Field:
DESCRIPTION
Table:
AR_CLIENT_COMPANY
Ref Field:
CLIENT_CO_REF
Value Field:
CLIENT_CO_NAME
Table:
AR_ORGANIZATION_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
AR_PERSON
Ref Field:
REF
Value Field:
DISPLAY
Table:
AR_PERSON
Ref Field:
REF
Value Field:
EMAIL_ID
Table:
HD_FORMAT
Ref Field:
REF
Value Field:
NAME
Table:
SU_CUSTOMER_ROLE
Ref Field:
REF
Value Field:
NAME
Table:
AR_DEPARTMENT
Ref Field:
REF
Value Field:
NAME
Table:
AR_USER_CATEGORY
Ref Field:
REF
Value Field:
DESCRIPTION
Table:
AR_VIP_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
AR_LOCATIONS
Ref Field:
REF
Value Field:
NAME
Table:
AR_PERSON
Ref Field:
REF
Value Field:
USER_ID
Table:
AR_PERSON
Ref Field:
REF
Value Field:
FULL_NAME
Table:
AR_LOCATIONS
Ref Field:
LOCATION_REF
Value Field:
LOCATION_NAME
Table:
AR_CONTRACTS
Ref Field:
REF
Value Field:
CO_CONTRACT_REF
Table:
AR_CONTRACTS
Ref Field:
REF
Value Field:
CO_CONTRACT_REF
Table:
SU_ENTITY_TYPE
Ref Field:
REF
Value Field:
DISPLAY
Table:
AR_COST_CENTRE
Ref Field:
REF
Value Field:
NAME
Table:
AR_COST_CENTRE
Ref Field:
LINK_REF
Value Field:
NAME
Table:
AR_COST_CENTRE_CATEGORY
Ref Field:
REF
Value Field:
NAME
Table:
AR_SUBSCRIBER_GROUP
Ref Field:
REF
Value Field:
NAME
Table:
AR_JURISDICTION
Ref Field:
REF
Value Field:
NAME
Table:
SU_SECURITY_PROFILE
Ref Field:
REF
Value Field:
NAME
Table:
SU_PARTITIONS
Ref Field:
REF
Value Field:
NAME
Table:
IN_SYS_SOURCE
Ref Field:
REF
Value Field:
NAME
Table:
HD_FORMAT
Ref Field:
REF
Value Field:
NAME
Table:
SA_TIMEZONE
Ref Field:
REF
Value Field:
NAME
Table:
SU_SUPPORT_GROUP
Ref Field:
REF
Value Field:
NAME
Table:
CR_GROUP
Ref Field:
REF
Value Field:
NAME
Table:
BB_ENTRY
Ref Field:
BULLETIN_REF
Value Field:
TITLE
Table:
BB_PRIORITY
Ref Field:
REF
Value Field:
NAME
Table:
CR_REQUEST
Ref Field:
REQUEST_NO
Value Field:
REQUEST_TITLE
Table:
CR_IMPL_PROFILE
Ref Field:
REF_COMPOSITE
Value Field:
NAME_1
Table:
CR_IMPLEMENTATION_STATE
Ref Field:
REF
Value Field:
NAME
Table:
CR_REQ_PRIORITY
Ref Field:
REF
Value Field:
NAME
Table:
CR_REQ_RISK
Ref Field:
REF
Value Field:
NAME
Table:
CR_REQ_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
CR_REQUEST
Ref Field:
REQUEST_NO
Value Field:
T_PLATE_NAME
Table:
CR_REQ_TYPE
Ref Field:
REF_COMPOSITE
Value Field:
NAME_1
Table:
CR_REQ_ACTIVITY
Ref Field:
REF
Value Field:
NAME
Table:
CR_TASK_PHASE
Ref Field:
REF
Value Field:
NAME
Table:
CR_TASK
Ref Field:
TASK_NO
Value Field:
-
Table:
CR_TASK_TYPE
Ref Field:
REF
Value Field:
NAME
Table:
CR_HIST_ACTIVITY
Ref Field:
REF
Value Field:
NAME
Table:
CR_TASK_PHASE
Ref Field:
REF
Value Field:
NAME
Table:
CR_TASK_PRIORITY
Ref Field:
REF
Value Field:
NAME
Table:
CR_TASK_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
CL_CALL_LOGGING
Ref Field:
CALL_NUMBER
Value Field:
CALL_REF
Table:
CL_HIST_ACTIVITY
Ref Field:
REF
Value Field:
NAME
Table:
CL_IMPACT
Ref Field:
REF
Value Field:
NAME
Table:
SU_CALL_PRIORITY
Ref Field:
REF
Value Field:
NAME
Table:
CL_REASONS
Ref Field:
REF
Value Field:
REASON_NAME
Table:
CL_CALL_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
CL_CALL_LOGGING
Ref Field:
CALL_NUMBER
Value Field:
T_PLATE_NAME
Table:
SU_EDIT_SCREENS
Ref Field:
SCREEN_TYPE_REF
Value Field:
NAME
Table:
CL_URGENCY
Ref Field:
REF
Value Field:
NAME
Table:
CL_IPK_STREAM
Ref Field:
REF
Value Field:
NAME
Table:
CL_IPK_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
CL_PROBLEM_TYPE
Ref Field:
REF_COMPOSITE
Value Field:
NAME_1
Table:
KB_ENTRY
Ref Field:
KNOWLEDGE_REF
Value Field:
EXTERNAL_REF
Table:
KB_PROFILE
Ref Field:
REF
Value Field:
NAME_1
Table:
KB_RATING
Ref Field:
REF
Value Field:
SHORT_DESC
Table:
KB_ENTRY_STATUS
Ref Field:
REF
Value Field:
NAME
Table:
SU_ENTITY_TYPE
Ref Field:
REF
Value Field:
DISPLAY
Table:
SU_ENTITY_TYPE
Ref Field:
REF
Value Field:
DISPLAY
Table:
SU_ENTITY_TYPE
Ref Field:
REF
Value Field:
DISPLAY
Table:
SH_LINK
Ref Field:
LINK_REF
Value Field:
-
Table:
HD_ATTRIBUTE
Ref Field:
REF
Value Field:
NAME_1
Table:
SA_AGREEMENT
Ref Field:
AGREEMENT_NO
Value Field:
AGREEMENT_REF
Table:
AM_OUTAGE_TYPE
Ref Field:
OUTAGE_TYPE_REF
Value Field:
OUTAGE_TYPE_TITLE
