Workflow (Request) Transactions
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.
Workflow transactions are used to create, update, retrieve, forward, authorize and complete Requests. These transactions use a prefix of Workflow instead of Request, as Request is a special term used by the web service.
Requests created through the API must be created from existing workflow templates. However, workflow templates can not be created through the API.
Availability transactions are available to find linked outages as well as create new ones.
The Classic API has transactions which enable you to send an email to Users, analysts and stakeholders. See Message Transactions for more information.
WorkflowCreate Transaction
The WorkflowCreate transaction can be used to create a request from a workflow template.
Input Parameters: WorkflowCreateRequest
Argument
Type
Mandatory
Default
Description
sID
String
No. See Transaction Login.
“”
Analyst’s current Session ID
sLoginUserID
String
No. See Transaction Login.
“”
Analyst’s Login ID
sLoginPassword
String
No. See Transaction Login.
“”
Analyst’s Password
sDatabase
String
No. See Transaction Login.
“”
Name of the ASM System for logging in.
lEntityRef
Lookup Field
Ignored
-
Ignored on create
lTemplateRef
Lookup Field
Yes
-
Reference of the workflow template to use to create the Request
sRequestRef
String
No
“”
Request Ref
sTitle
String
No
“”
Request title
lCustomer
Lookup Field
No
0
Request User
lFwdOfficer
Lookup Field
No
0
Analyst to whom to forward the Request
lLocation
Lookup Field
No
0
Request Location
lOrganization
Lookup Field
No
0
Request Organization
lPriority
Lookup Field
No
0
Request Priority
lRisk
Lookup Field
No
0
Request Risk
lType
Lookup Field
No
0
Request Type
dImpEnd
Date/Time
No
Now
Request Implementation End Date
dImpStart
Date/Time
No
Now
Request Implementation Start Date
dTargetDate
Date/Time
No
Now
Request Target Date
lFwdGroup
Lookup Field
No
0
Group to which to forward the Request
sDescription
String
No
“”
Request Description
lActionType
Lookup Field
No
0
Request Action & Solution Action Type
yPortal
Yes/No
No
N
Flag whether this Action & Solution is visible on the Self Service Portal. Values:
Y = Action & Solution is visible on the Self Service Portal
N = Action & Solution is not visible on the Self Service Portal
sActionDescription
String
No
“”
Action & Solution description
lRequestPhase
Lookup Field
No
0
Request Phase
lRequestStatus
Lookup Field
No
0
Request Completion Status
lSecurityProfile
Lookup Field
No
0
Security Profile to apply to the Action & Solution
sReason
String
No
“”
Audit reason
bSendEmail
Boolean
No
False
Flag whether to send an email to the assigned analyst/group. Values:
True = send email to the assigned analyst/group
False = do not send email to the assigned analyst/group
bSendPager
Boolean
No
False
Flag whether to send a pager message to the assigned analyst/group. Values:
True = send pager message to the assigned analyst/group
False = do not send pager message to the assigned analyst/group
aCustomParameters
Array
No
“”
See Defining Custom Parameters.
Return Values:WorkflowResponse
Argument
Type
Description
nEntityRef
Integer
New Request Number
sMessage
String
Error/Warning Message
Ret
APIReturn
Error/Warning Number
WorkflowUpdate Transaction
The WorkflowUpdate transaction can be used to update and defer existing request.
Input Parameters: WorkflowUpdateRequest
Argument
Type
Mandatory
Default
Description
sID
String
No. See Transaction Login.
“”
Analyst’s current Session ID
sLoginUserID
String
No. See Transaction Login.
“”
Analyst’s Login ID
sLoginPassword
String
No. See Transaction Login.
“”
Analyst’s Password
sDatabase
String
No. See Transaction Login.
“”
Name of the ASM System for logging in.
lEntityRef
Lookup Field
Yes
-
Reference number of the Request to update
lTemplateRef
Lookup Field
Ignored
-
Ignored on update
sRequestRef
String
No
(As is)
Request Ref
sTitle
String
No
(As is)
Request Title
lCustomer
Lookup Field
No
(As is)
Request User
lFwdOfficer