CMDB Item Transactions

The ASM web service provides a single create, update, delete, retrieve and clone transaction for CMDB item entities, including Configuration Items, Services, Service Actions and Service Bundles.

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

The ASM API provides transactions that allow messages to be sent to the User or stakeholders linked to a CMDB item.

For more information on sending messages to the CMDB item User or stakeholders see Message Transactions.

Functions are also provided to link and unlink two CMDB Items including the ability to specify link weighting information, and to link and unlink contracts to CMDB Items. To delete a link, you can either specify the link ref of the relevant table, or provide the CMDB item and contract (or linked CMDB Item) and the web service will delete any link between the two.

CMDBItemCreate Transaction

The CMDBItemCreate transaction can be used to create and save a new Configuration Item, Service, Service Action or Service Bundle.

Some parameters available in this transaction will only apply to Configuration Items, while others will only apply to Services, Service Actions and Service Bundles.

Input Parameters: CMDBItemCreateRequest

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 transaction

sAssetRef

String

Yes

“”

CI Reference number

sTitle

String

Yes

“”

CI Title

sVersion

String

No

1 (or next available version number)

CI Version number

nVersionOrder

Integer

No

1 (or next available version number)

CI Version Order

lCMDBEntityType

Lookup Field

Yes

-

CMDB item Type

lEntityClass

Lookup Field

No

0

CMDB item Class

lManufacturer

Lookup Field

No

0

CI Manufacturer. Only applies to Config Items.

lModelType

Lookup Field

No

0

CI Model. Only applies to Config Items.

sSerialNo

String

No

“”

CI Serial Number

bAssetCatalog

Boolean

No

False

Flag to specify whether this CMDB item is available in the Asset Catalog. Values:

  • True = CMDB item flagged for the Asset Catalog

  • False = CMDB item not available in the Asset Catalog

bBaseline

Boolean

No

False

Flag to specify whether this CMDB is a baseline. Values:

  • True = CMDB item is a baseline

  • False = CMDB item is not a baseline

bTemplateInd

Boolean

No

False

Flag whether this CMDB item is a template. Values:

  • True = CMDB item template

  • False = CMDB item

lCompany

Lookup Field

No

0

CMDB item Organization

lCustomer

Lookup Field

No

0

CMDB item User

lLocation

Lookup Field

No

0

CMDB item Location

lCriticality

Lookup Field

No

0

CMDB item Criticality

lPhysicalStatus

Lookup Field

No

0

CMDB item Physical Status

lServiceLevel

Lookup Field

No

0

CMDB Item Service Level

dLastChecked

Date/Time

No

Now

Last checked date

dPurchased

Date/Time

No

(null)

Purchase date

lExternalSupplier

Lookup Field

No

0

External Supplier associated with the CMDB item

lFinancialCategory

Lookup Field

No

0

CMDB item Financial Category

lFinancialStatus

Lookup Field

No

0

CMDB item Financial Status

lPurchaseMethod

Lookup Field

No

0

CMDB item Purchase Method

dDisposalDate

Date/Time

No

(null)

Disposal Date

lDisposalMethod

Lookup Field

No

0

Disposal Method

sDescription

String

No

“”

CMDB item Description

lTimeZone

Lookup Field

No

0

Time zone selected for the CMDB item

sFloor

String

No

“”

Floor

yLite

Yes/No

No

N

Is this CMDB item visible on the Self Service Portal? Only applies to CIs. Values:

  • Y = CI is visible on the Self Service Portal

  • N = CI is not visible on the Self Service Portal

sChargingArrangement

String

No

“”

CMDB item Charging Arrangement

sServiceAccess

String

No

“”

Access information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sServiceAvailability

String

No

“”

Availability information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sServiceBackupRecovery

String

No

“”

Backup and Recovery information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sServiceTarget

String

No

“”

Service Target information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sTargetAudience

String

No

“”

Target Audience information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sTraining

String

No

“”

Training information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

lPartition

Lookup Field

No

Analyst’s default partition

Partition in which the CMDB item will be created.

sReason

String

No

“”

Audit Reason.

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values:CMDBItemResponse

Argument

Type

Description

nEntityRef

Integer

Newly created Configuration Item Ref

sMessage

String

Error/Warning message returned from API

Ret

APIReturn

Error/Warning number returned from the API

CMDBItemUpdate Transaction

The CMDBItemUpdate transaction can be used to update and save an existing Configuration Item, Service, Service Action or Service Bundle entity.

Because a field cannot be updated with a blank value, the value ‘NULL’ can instead be used to indicate a blank value.

Input Parameters: CMDBItemUpdateRequest

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

-

CMDB item to update

sAssetRef

String

No

(As Is)

CI Reference number

sTitle

String

Yes

(As Is)

CI Title

sVersion

String

No

(As Is)

CI Version number

nVersionOrder

Integer

No

(As Is)

CI Version Order

lCMDBEntityType

Lookup Field

No

(As Is)

CMDB item Type

lEntityClass

Lookup Field

No

(As Is)

CMDB item Class

lManufacturer

Lookup Field

No

(As Is)

CI Manufacturer. Only applies to Config Items.

lModelType

Lookup Field

No

(As Is)

CI Model. Only applies to Config Items.

sSerialNo

String

No

(As Is)

CI Serial Number

bAssetCatalog

Boolean

No

(As Is)

Flag to specify whether this CMDB item is available in the Asset Catalog. Values:

  • True = CMDB item flagged for the Asset Catalog

  • False = CMDB item not available in the Asset Catalog

bBaseline

Boolean

No

(As Is)

Flag to specify whether this CMDB is a baseline. Values:

  • True = CMDB item is a baseline

  • False = CMDB item is not a baseline

bTemplateInd

Boolean

No

(As Is)

Flag whether this CMDB item is a template. Values:

  • True = CMDB item template

  • False = CMDB item

lCompany

Lookup Field

No

(As Is)

CMDB item Organization

lCustomer

Lookup Field

No

(As Is)

CMDB item User

lLocation

Lookup Field

No

(As Is)

CMDB item Location

lCriticality

Lookup Field

No

(As Is)

CMDB item Criticality

lPhysicalStatus

Lookup Field

No

(As Is)

CMDB item Physical Status

lServiceLevel

Lookup Field

No

(As Is)

CMDB Item Service Level

dLastChecked

Date/Time

No

(As Is)

Last checked date

dPurchased

Date/Time

No

(As Is)

Purchase date

lExternalSupplier

Lookup Field

No

(As Is)

External Supplier associated with the CMDB item

lFinancialCategory

Lookup Field

No

(As Is)

CMDB item Financial Category

lFinancialStatus

Lookup Field

No

(As Is)

CMDB item Financial Status

lPurchaseMethod

Lookup Field

No

(As Is)

CMDB item Purchase Method

dDisposalDate

Date/Time

No

(As Is)

Disposal Date

lDisposalMethod

Lookup Field

No

(As Is)

Disposal Method

sDescription

String

No

(As Is)

CMDB item Description

lTimeZone

Lookup Field

No

(As Is)

Time zone selected for the CMDB item

sFloor

String

No

(As Is)

Floor

yLite

Yes/No

No

(As Is)

Is this CMDB item visible on the Self Service Portal? Only applies to CIs. Values:

  • Y = CI is visible on the Self Service Portal

  • N = CI is not visible on the Self Service Portal

sChargingArrangement

String

No

(As Is)

CMDB item Charging Arrangement

sServiceAccess

String

No

(As Is)

Access information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sServiceAvailability

String

No

(As Is)

Availability information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sServiceBackupRecovery

String

No

(As Is)

Backup and Recovery information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sServiceTarget

String

No

(As Is)

Service Target information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sTargetAudience

String

No

(As Is)

Target Audience information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

sTraining

String

No

(As Is)

Training information to publish on the Service Request Catalog.

Valid for Services, Service Actions and Service Bundles only.

lPartition

Lookup Field

No

(As Is)

Partition in which the CMDB item will be created.

sReason

String

No

“”

Audit Reason.

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: CMDBItemResponse

See CMDBItemResponse for more information.

CMDBItemRetrieve Transaction

The CMDBItemRetrieve transaction can be used to retrieve the details of a Configuration Item, Service, Service Action or Service Bundle.

Input Parameters: CMDBItemRetrieveRequest

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

-

CMDB item to retrieve

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: CMDBItemRetrieveResponse

Argument

Type

Description

Ret

APIReturn

Error/Warning number returned from API

sMessage

String

Error/Warning message returned from API

ResultSet

DataSet

ResultSet containing attribute details

CMDBItemDelete Transaction

The CMDBItemDelete transaction can be used to find and delete a Configuration Item, Service, Service Action or Service Bundle.

The status and audit trail are updated after the transaction is executed.

Input Parameters: CMDBItemDeleteRequest

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 CMDB item to delete

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: CMDBItemResponse

See CMDBItemResponse for more information.

CMDBItemClone Transaction

The ConfigItemClone transaction can be used to clone an existing Configuration Item, Service, Service Action or Service Bundle.

Input Parameters: CMDBItemCloneRequest

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

-

CMDB item from which to clone

lEntityRefCloneTo

Lookup Field

Yes

-

Name of the new CMDB item. This must be a unique value.

sNewVersionNumber

String

No

1

New Version Number

bCopyLink

Boolean

No

False

Indicate whether to also clone links. Values:

  • True = clone links

  • False = do not clone links

yCloneNew

Yes/No

No

Yes

Flag as to whether to create a new CMDB item, or a new version of the CMDB item. Values:

  • True = create a new CMDB item

  • False = create a new version of the current CMDB item

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: CMDBItemResponse

See CMDBItemResponse for more information.

The CMDBItemLink transaction creates a link between two CMDB items.

Input Parameters: CMDBItemLinkRequest

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

lCMDBItemA

Lookup Field

Yes

-

The primary CMDB item in which to create a link i.e. Parent, Peer A, Container, Principal CMDB item.

lCMDBItemB

Lookup Field

Yes

-

The secondary CMDB item in which to create a link i.e. Child, Peer B, Component, Summarized CMDB item.

lLinkStatus

Lookup Field

No

0

CMDB Link status

nCMDBLinkType

Integer

Yes

-

link type between the two CMDB items

bAImpactsB

Boolean

No

False

Indicator as to whether CMDB item A impacts CMDB item B. Values:

  • True = CMDB item A will impact CMDB item B in the event of an outage.

  • False = CMDB item A has no impact on CMDB item B in the event of an outage.

bBImpactsA

Boolean

No

False

Indicator as to whether CMDB item B impacts CMDB item A. Values:

  • True = CMDB item B will impact CMDB item A in the event of an outage.

  • False = CMDB item B has no impact on CMDB item A in the event of an outage.

sReason

String

No

“”

Audit reason

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: CMDBItemResponse

See CMDBItemResponse for more information.

CMDBItemLinkDelete Transaction

The CMDBItemLinkDelete transaction can be used to delete a link between two CMDB items.

Input Parameters: CMDBItemLinkDeleteRequest

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 CMDB link to delete.

aCustomParameters

Array

No

“”

See Defining Custom Parameters.

Return Values: CMDBItemResponse

See CMDBItemResponse for more information.

Copyright 2023 Alemba, ASM EOS 10.4