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.

CMDB Item Lookups

Class

Table:

AR_CLASS

Ref Field:

REF

Value Field:

NAME

Criticality

Table:

AR_CRITICALITY

Ref Field:

REF

Value Field:

NAME

Disposal Method

Table:

AR_DISPOSAL_METHOD

Ref Field:

REF

Value Field:

NAME

Financial Category

Table:

AR_FINANCIAL_CATEGORY

Ref Field:

REF

Value Field:

NAME

Financial Status

Table:

AR_FIN_STATUS

Ref Field:

REF

Value Field:

NAME

Table:

AR_CRITICALITY

Ref Field:

REF

Value Field:

NAME

Manufacturer

Table:

AR_MANUFACTURER

Ref Field:

REF

Value Field:

NAME

Model

Table:

AR_MODEL_TYPES

Ref Field:

REF

Value Field:

NAME

Physical Status

Table:

AR_PHYSICAL_STATUS

Ref Field:

REF

Value Field:

NAME

Purchase Method

Table:

AR_PURCHASE_METHOD

Ref Field:

REF

Value Field:

NAME

Service Level

Table:

AR_USER_CATEGORY

Ref Field:

REF

Value Field:

DESCRIPTION

CMDB Item Type

Table:

SU_ENTITY_TYPE

Ref Field:

REF

Value Field:

DISPLAY

CMDB Item

Table:

AR_PRIMARY_ASSET

Ref Field:

ITEM_REF

Value Field:

ASSET_REF

Service Action

Table:

AR_PRIMARY_ASSET

Ref Field:

ITEM_REF

Value Field:

ASSET_REF

Service Bundle

Table:

AR_PRIMARY_ASSET

Ref Field:

ITEM_REF

Value Field:

ASSET_REF

Service

Table:

AR_PRIMARY_ASSET

Ref Field:

ITEM_REF

Value Field:

ASSET_REF

Configuration Item

Table:

AR_PRIMARY_ASSET

Ref Field:

ITEM_REF

Value Field:

ASSET_REF

Organization (and External Supplier) Lookups

Organization

Table:

AR_CLIENT_COMPANY

Ref Field:

CLIENT_CO_REF

Value Field:

CLIENT_CO_NAME

Location

Table:

AR_CLIENT_COMPANY

Ref Field:

CLIENT_CO_REF

Value Field:

CLIENT_CO_NAME

Profile

Table:

AR_INDUSTRIES

Ref Field:

INDUSTRY_REF

Value Field:

INDUSTRY_NAME

Service Level

Table:

AR_USER_CATEGORY

Ref Field:

REF

Value Field:

DESCRIPTION

External Supplier

Table:

AR_CLIENT_COMPANY

Ref Field:

CLIENT_CO_REF

Value Field:

CLIENT_CO_NAME

External Supplier Status

Table:

AR_ORGANIZATION_STATUS

Ref Field:

REF

Value Field:

NAME

Person Lookups

Person

Table:

AR_PERSON

Ref Field:

REF

Value Field:

DISPLAY

User

Table:

AR_PERSON

Ref Field:

REF

Value Field:

EMAIL_ID

Email Format

Table:

HD_FORMAT

Ref Field:

REF

Value Field:

NAME

Self Service Portal Role

Table:

SU_CUSTOMER_ROLE

Ref Field:

REF

Value Field:

NAME

User Profile

Table:

AR_DEPARTMENT

Ref Field:

REF

Value Field:

NAME

Service Level

Table:

AR_USER_CATEGORY

Ref Field:

REF

Value Field:

DESCRIPTION

VIP Status

Table:

AR_VIP_STATUS

Ref Field:

REF

Value Field:

NAME

Location

Table:

AR_LOCATIONS

Ref Field:

REF

Value Field:

NAME

Analyst

Table:

AR_PERSON

Ref Field:

REF

Value Field:

USER_ID

External Contact

Table:

AR_PERSON

Ref Field:

REF

Value Field:

FULL_NAME

Location Lookups

Location

Table:

AR_LOCATIONS

Ref Field:

LOCATION_REF

Value Field:

LOCATION_NAME

Contract Lookups

Contract

Table:

AR_CONTRACTS

Ref Field:

REF

Value Field:

CO_CONTRACT_REF

External Contract

Table:

AR_CONTRACTS

Ref Field:

REF

Value Field:

CO_CONTRACT_REF

Contract Type

Table:

SU_ENTITY_TYPE

Ref Field:

REF

Value Field:

DISPLAY

Cost Center Lookups

Cost Center

Table:

AR_COST_CENTRE

Ref Field:

REF

Value Field:

NAME

Table:

AR_COST_CENTRE

Ref Field:

LINK_REF

Value Field:

NAME

Cost Center Category

Table:

AR_COST_CENTRE_CATEGORY

Ref Field:

REF

Value Field:

NAME

Subscriber Group Lookups

Subscriber Group

Table:

AR_SUBSCRIBER_GROUP

Ref Field:

REF

Value Field:

NAME

Jurisdiction Lookups

Jurisdiction

Table:

AR_JURISDICTION

Ref Field:

REF

Value Field:

NAME

Administration Lookups

Security Profile

Table:

SU_SECURITY_PROFILE

Ref Field:

REF

Value Field:

NAME

Partition

Table:

SU_PARTITIONS

Ref Field:

REF

Value Field:

NAME

Source

Table:

IN_SYS_SOURCE

Ref Field:

REF

Value Field:

NAME

Format

Table:

HD_FORMAT

Ref Field:

REF

Value Field:

NAME

Time Zone

Table:

SA_TIMEZONE

Ref Field:

REF

Value Field:

NAME

IPK Group Lookups

IPK Group

Table:

SU_SUPPORT_GROUP

Ref Field:

REF

Value Field:

NAME

Workflow Group Lookups

Workflow Group

Table:

CR_GROUP

Ref Field:

REF

Value Field:

NAME

Bulletin Lookups

Bulletin

Table:

BB_ENTRY

Ref Field:

BULLETIN_REF

Value Field:

TITLE

Bulletin Priority

Table:

BB_PRIORITY

Ref Field:

REF

Value Field:

NAME

Workflow (Request) Lookups

Request

Table:

CR_REQUEST

Ref Field:

REQUEST_NO

Value Field:

REQUEST_TITLE

Implementation Profile

Table:

CR_IMPL_PROFILE

Ref Field:

REF_COMPOSITE

Value Field:

NAME_1

Implementation State

Table:

CR_IMPLEMENTATION_STATE

Ref Field:

REF

Value Field:

NAME

Priority

Table:

CR_REQ_PRIORITY

Ref Field:

REF

Value Field:

NAME

Risk

Table:

CR_REQ_RISK

Ref Field:

REF

Value Field:

NAME

Status

Table:

CR_REQ_STATUS

Ref Field:

REF

Value Field:

NAME

Workflow Template

Table:

CR_REQUEST

Ref Field:

REQUEST_NO

Value Field:

T_PLATE_NAME

Type

Table:

CR_REQ_TYPE

Ref Field:

REF_COMPOSITE

Value Field:

NAME_1

Action Type

Table:

CR_REQ_ACTIVITY

Ref Field:

REF

Value Field:

NAME

Phase

Table:

CR_TASK_PHASE

Ref Field:

REF

Value Field:

NAME

Task Lookups

Task

Table:

CR_TASK

Ref Field:

TASK_NO

Value Field:

-

Task Type

Table:

CR_TASK_TYPE

Ref Field:

REF

Value Field:

NAME

Action Type

Table:

CR_HIST_ACTIVITY

Ref Field:

REF

Value Field:

NAME

Task Phase

Table:

CR_TASK_PHASE

Ref Field:

REF

Value Field:

NAME

Task Priority

Table:

CR_TASK_PRIORITY

Ref Field:

REF

Value Field:

NAME

Task Status

Table:

CR_TASK_STATUS

Ref Field:

REF

Value Field:

NAME

Call Lookups

Call

Table:

CL_CALL_LOGGING

Ref Field:

CALL_NUMBER

Value Field:

CALL_REF

Action Type

Table:

CL_HIST_ACTIVITY

Ref Field:

REF

Value Field:

NAME

Impact

Table:

CL_IMPACT

Ref Field:

REF

Value Field:

NAME

Priority

Table:

SU_CALL_PRIORITY

Ref Field:

REF

Value Field:

NAME

Reason

Table:

CL_REASONS

Ref Field:

REF

Value Field:

REASON_NAME

Call Status

Table:

CL_CALL_STATUS

Ref Field:

REF

Value Field:

NAME

Call Template

Table:

CL_CALL_LOGGING

Ref Field:

CALL_NUMBER

Value Field:

T_PLATE_NAME

Call Screen

Table:

SU_EDIT_SCREENS

Ref Field:

SCREEN_TYPE_REF

Value Field:

NAME

Urgency

Table:

CL_URGENCY

Ref Field:

REF

Value Field:

NAME

IPK Stream

Table:

CL_IPK_STREAM

Ref Field:

REF

Value Field:

NAME

IPK Status

Table:

CL_IPK_STATUS

Ref Field:

REF

Value Field:

NAME

Type

Table:

CL_PROBLEM_TYPE

Ref Field:

REF_COMPOSITE

Value Field:

NAME_1

Knowledge Lookups

Knowledge

Table:

KB_ENTRY

Ref Field:

KNOWLEDGE_REF

Value Field:

EXTERNAL_REF

Profile

Table:

KB_PROFILE

Ref Field:

REF

Value Field:

NAME_1

Rating

Table:

KB_RATING

Ref Field:

REF