Availability Transactions

Availability transactions can be used to manipulate availability information for CMDB items.

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

AvailabilityFindItemOutages Transaction

The AvailabilityFindItemOutages transaction returns all outages within a given time period against a CMDB Item.

Input Parameters: AvailabilityFindItemOutagesRequest

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 against which to find the outage
dOutageEnd	Date/Time	No	-	The end date range in which to find an outage
dOutageStart	Date/Time	No	-	The start date range in which to find an outage
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values:AvailabilityRetrieveResponse

Argument	Type	Description
Ret	APIReturn	Error/Warning Number
sMessage	String	Error/Warning Message
ResultSet	DataSet	ResultSet containing attribute details

AvailabilityFindCurrentOutage Transaction

The AvailabilityFindCurrentOutage transaction can be used to find the ref of the current outage logged against a given CMDB Item.

Input Parameters: AvailabilityFindCurrentOutageRequest

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 against which to find the outage
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: AvailabilityRetrieveResponse

See AvailabilityRetrieveResponse for more information.

AvailabilityItemDependencies Transaction

The AvailabilityItemDependencies transaction can be used to find all CMDB Items dependent on a given item. This transaction returns only those linked items that have availability enabled, and takes into account any weighted links that have been defined.

AvailabilityItemDependencies will default to finding dependent items based on score. Passing PLANNED=1 as a custom parameter will ignore any currently running outages ;it does not matter where in the custom parameters array this is placed.

Input Parameters: AvailabilityItemDependenciesRequest

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
sItemRefs	String	Yes	-	A comma separated list of CMDB item Refs, in which the dependent items will be returned.
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: AvailabilityRetrieveResponse

See AvailabilityRetrieveResponse for more information.

AvailabilityOutageUpdate Transaction

The AvailabilityOutageUpdate transaction can be used to update an existing outage. If the outage end date is in the past (that is, before the current date), the outage will be closed.

Input Parameters: AvailabilityOutageUpdateRequest

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 with the outage to update
nOutageRef	Integer	Yes	-	Outage to update
dOutageEnd	Date/Time	No	-	Outage End of the specified outage
dOutageStart	Date/Time	No	-	Outage Start of the specified outage
sOutageDesc	String	No	“”	Outage Description of the specified outage
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: AvailabilityResponse

Argument	Type	Description
Ret	APIReturn	Error/Warning Number
sMessage	String	Error/Warning Message