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

“”

Request Ref

sTitle

String

“”

Request title

lCustomer

Lookup Field

Request User

lFwdOfficer

Lookup Field

Analyst to whom to forward the Request

lLocation

Lookup Field

Request Location

lOrganization

Lookup Field

Request Organization

lPriority

Lookup Field

Request Priority

lRisk

Lookup Field

Request Risk

lType

Lookup Field

Request Type

dImpEnd

Date/Time

Now

Request Implementation End Date

dImpStart

Date/Time

Now

Request Implementation Start Date

dTargetDate

Date/Time

Now

Request Target Date

lFwdGroup

Lookup Field

Group to which to forward the Request

sDescription

String

“”

Request Description

lActionType

Lookup Field

Request Action & Solution Action Type

yPortal

Yes/No

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

“”

Action & Solution description

lRequestPhase

Lookup Field

Request Phase

lRequestStatus

Lookup Field

Request Completion Status

lSecurityProfile

Lookup Field

Security Profile to apply to the Action & Solution

sReason

String

“”

Audit reason

bSendEmail

Boolean

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

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

“”

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

(As is)

Request Ref

sTitle

String

(As is)

Request Title

lCustomer

Lookup Field

(As is)

Request User

lFwdOfficer

Lookup Field

(As is)

Analyst to whom to forward the Request

lLocation

Lookup Field

(As is)

Request Location

lOrganization

Lookup Field

(As is)

Request Organization

lPriority

Lookup Field

(As is)

Request Priority

lRisk

Lookup Field

(As is)

Request Risk

lType

Lookup Field

(As is)

Request Type

dImpEnd

Date/Time

(As is)

Request Implementation End Date

dImpStart

Date/Time

(As is)

Request Implementation Start Date

dTargetDate

Date/Time

(As is)

Request Target Date

lFwdGroup

Lookup Field

(As is)

Group to which to forward the Request

sDescription

String

(As is)

Request Description

lActionType

Lookup Field

Request Action & Solution Action Type

yPortal

Yes/No

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

“”

Action & Solution description

lRequestPhase

Lookup Field

(As is)

Request Phase

lRequestStatus

Lookup Field

(As is)

Request Completion Status

lSecurityProfile

Lookup Field

Security Profile to apply to the Action & Solution

sReason

String

“”

Audit reason

bSendEmail

Boolean

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

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

“”

See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowRetrieve Transaction

The WorkflowRetrieve transaction can be used to search for and retrieve the details of a request.

Input Parameters: WorkflowRetrieveRequest

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 retrieve

aCustomParameters

Array

“”

See Defining Custom Parameters.

Return Values:WorkflowRetrieveResponse

Argument

Type

Description

Ret

APIReturn

Error/Warning Number

sMessage

String

Error/Warning Message

InfraEnterpriseAPI .Recordset

Infra Recordset object containing request’s details

WorkflowComplete Transaction

The WorkflowComplete transaction can be used to complete an existing request.

Input Parameters: WorkflowCompleteRequest

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 complete

lImpState

Lookup Field

Request Implementation State

lImpProfile

Lookup Field

Request Implementation Profile

dImpReviewDate

Date/Time

(null)

Request Implementation Review Date

lStatus

Lookup Field

Request completion status

sDetail

String

“”

Request Implementation details – description associated with the implementation.

bEmailOwner

Boolean

False

Flag whether to email the owner of any linked calls/requests. Values:

True = email owners of linked calls/ requests
False = do not email owners of linked calls/requests

bEmailRequestor

Boolean

False

Flag whether to email the Request User. Values:

True = email User of request completion
False = do not email User of request completion

bPagerOwner

Boolean

False

Flag whether to send a pager message to the owner of any linked calls/requests. Values:

True = send a pager message to linked call/request owner
False = do not send a pager message to linked call/request owner

sReason

String

“”

Audit reason

aCustomParameters

Array

“”

See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowAuthorize Transaction

The WorkflowAuthorize transaction can be used to authorize an existing request.

Input Parameters: WorkflowAuthorizeRequest

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 authorize

lStatus

Lookup Field

Request Completion Status

sPassword

String

Yes

Authorizer’s password

sComments

String

“”

Authorizer’s comments

bEmailRequestor

Boolean

False

Flag whether to email the Request User. Values:

True = email the Request User
False = do not email the Request User

sActionDesc

String

“”

Action & Solution history description

yAuthorized

Yes/No

Yes

Flag whether to authorize the Request. Values:

Y = authorize the Request
N = do not authorize the Request

lActionType

Lookup Field

Action & Solution action type

lAuthorizeStatus

Lookup Field

Authorize Status

sReason

String

“”

Audit reason

bSendEmail

Boolean

False

Flag whether to send an email to the assigned task analysts/groups. Values:

True = send an email to assigned task owners
False = do not send an email to assigned task owners

bSendPager

Boolean

False

Flag whether to send a pager message to the assigned task analysts/groups. Values:

True = send a pager message to assigned task owners
False = do not send an email to assigned task owners

aCustomParameters

Array

“”

See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowForwardInternal Transaction

The WorkflowForwardInternal transaction can be used to open and forward an existing request.

Input Parameters: WorkflowInternalRequest

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 forward

lFwdOfficer

Lookup Field

Analyst to whom to forward the Request

lFwdGroup

Lookup Field

Group to which to forward the Request

bSendEmail

Boolean

False

Flag whether to send an email to the assigned analyst/group. Values:

True = send email to assigned analyst/group
False = do not send email to assigned analyst/group

bSendPager

Boolean

False

Flag whether to send a pager message to the assigned analyst/group. Values:

True = send pager message to assigned analyst/group
False = do not send pager message to assigned analyst/group

aCustomParameters

Array

“”

See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowCreateOutage Transaction

The WorkflowCreateOutage transaction can be used to create an outage against an item linked to a request.

Input Parameters: WorkflowCreateOutageRequest

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 against which to create an outage

lCMDBItem

Lookup Field

Yes

Linked CMDB item against which to create an outage

lOutageType

Lookup Field

Unspecified

Planned

Outage type. This must be a planned outage type.

dOutageEnd

Date/Time

Now

Outage end date. This must be after the Outage start date. This value cannot be null.

dOutageStart

Date/Time

Now

Outage start date.

sOutageDesc

String

“”

Outage description

sReason

String

“”

Audit reason

aCustomParameters

Array

“”

See Define Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowFindLinkedOutage Transaction

The WorkflowFindLinkedOutages transaction can be used to find outages linked to a request.

Input Parameters: WorkflowFindLinkedOutageRequest

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 in which to find linked outages.

aCustomParameters

Array

“”

See Defining Custom Parameters.

Return Values: WorkflowRetrieveResponse

See WorkflowRetrieveResponse for more information.

Last updated 2 months ago