Stakeholder 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.

Stakeholder transactions include transactions for creating, updating, deleting and retrieving stakeholders. Transactions for emailing stakeholders are also available. You can specify whether you want to email all or selected stakeholders, as well as the email template to use.

For more information on messaging Stakeholders, see MessageStakeHolders Transaction.

StakeholderCreate Transaction

The StakeholderCreate transaction can be used to create a User, organization, Analyst, IPK group or Workflow group stakeholder for a call, Request or an entity in the CMDB.

Input Parameters: StakeholderCreateRequest

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

lCoreEntity

Lookup Field

Yes

-

Reference number of the entity (Call, Request, Task, CMDB item, etc.) to which to add a stakeholder.

eCoreEntityType

Enumerated

Yes

-

Entity to which to add a stakeholder. Values:

  • Call

  • Request

  • CMDB item

  • Person

  • Organization

  • Contract

  • Agreement

  • Location

  • Subscriber Group

  • Cost Center

lStakeholderEntity

Lookup Field

Yes

-

Ref of the entity to which to link as a stakeholder

eStakeholderType

Enumerated

Yes

Type of stakeholder to add to the entity. Values:

  • Person

  • Organization

  • IPK Group

  • Workflow Group

lLinkTypeRef

Lookup Field

No

Default link type for the item

Stakeholder Link Type. If lookup fails, default will be 23 (Stakeholder Link Type reference number)

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values:StakeholderResponse

Argument

Type

Description

nEntityRef

Integer

Newly created stakeholder link

sMessage

String

Error/Warning Message

Ret

APIReturn

Error/Warning Number

StakeholderUpdate Transaction

The StakeholderUpdate transaction can be used to update the link type of a stakeholder link.

Input Parameters: StakeholderUpdateRequest

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 Stakeholder link to update

lCoreEntity

Lookup Field

No

(As is)

Reference number of the entity (Call, Request, Task, CMDB item, etc.) to which to add a stakeholder.

eCoreEntityType

Enumerated

No

(As is)

Entity to which to add a stakeholder. Values:

  • Call

  • Request

  • CMDB item

  • Person

  • Organization

  • Contract

  • Agreement

  • Location

  • Subscriber Group

  • Cost Center

lStakeholderEntity

Lookup Field

No

(As is)

Reference number of the stakeholder to add to this entity

eStakeholderType

Enumerated

No

(As is)

Type of stakeholder to add to the entity. Values:

  • Person stakeholder

  • Organization stakeholder

  • IPK Group stakeholder

  • Workflow Group stakeholder

lLinkTypeRef

Lookup Field

No

(As is)

Stakeholder Link Type. If lookup fails, default will be 23 (the Stakeholder Link Type entity reference number)

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: StakeholderResponse

See StakeholderResponse for more information.

StakeholderRetrieve Transaction

The StakeholderRetrieve transaction can be used to retrieve the details of a stakeholder record.

Input Parameters: StakeholderEntityRequest

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

-

Stakeholder link to update

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: StakeholderRetrieveResponse

Argument

Type

Description

Ret

APIReturn

Error/Warning number

sMessage

String

Error/Warning message

ResultSet

DataSet

ResultSet containing attribute details

StakeholderDelete Transaction

The StakeholderDelete transaction can be used to delete a stakeholder.

Input Parameters: StakeholderDeleteRequest

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

-

Stakeholder link to update

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: StakeholderResponse

See StakeholderResponse for more information.

PreviousObject TransactionsNextWorkflow Transactions