Contract Transactions

The ASM web service provides basic contract transactions such as create, update, delete and retrieve.

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

In addition to this, the web service can also be used to link and unlink a contract to a Configuration Item or External Contact. The Classic API MessageStakeholders transaction also lets you send an email message to stakeholders linked to a contract. For more information, see MessageStakeHolders Transaction.

ContractCreate Transaction

The ContractCreate transaction can be used to create a new contract record and save its details.

Input Parameters: ContractCreateRequest

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
sName	String	Yes	-	Name of the contract
lMasterRef	Lookup Field	No	0	Master contract
lCompany	Lookup Field	No	0	External supplier to assign this contract
dStartDate	Date/Time	No	Now	Contract Start Date
dExpiryDate	Date/Time	No	Now	Contract End Date
nPeriod	Integer	No	0	Contract Period
fPayCycle	Float	No	0	Contract Pay Cycle
fPrice	Float	No	0	Contract Price
sDescription	String	No	“”	Contract Description
lContractType	Lookup Field	No	0	Contract Type
lPartition	Lookup Field	No	Analyst’s default partition	Partition of the contract
sReason	String	No	“”	Audit trail reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values:ContractResponse

Argument	Type	Description
nEntityRef	Integer	Newly created contract ref
sMessage	String	Error/Warning message from API
Ret	APIReturn	Error/Warning Message from API

ContractUpdate Transaction

The ContractUpdate transaction can be used to open and edit the details of a contract record.

Input Parameters: ContractUpdateRequest

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 contract to update
sName	String	No	(As is)	Name of the contract
lMasterRef	Lookup Field	No	(As is)	Master contract
lCompany	Lookup Field	No	(As is)	External supplier to assign this contract
dStartDate	Date/Time	No	(As is)	Contract Start Date
dExpiryDate	Date/Time	No	(As is)	Contract End Date
nPeriod	Integer	No	(As is)	Contract Period
fPayCycle	Float	No	(As is)	Contract Pay Cycle
fPrice	Float	No	(As is)	Contract Price
sDescription	String	No	(As is)	Contract Description
lContractType	Lookup Field	No	(As is)	Contract Type
lPartition	Lookup Field	No	(As is)	Partition of the contract
sReason	String	No	“”	Audit trail reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: ContractResponse

See ContractResponse for more information.

ContractRetrieve Transaction

The ContractRetrieve transaction can be used to open and view the details of a contract record. This transaction cannot be used to update the details of the contract record.

Input Parameters: ContractEntityRequest

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	-	Contract to delete
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: ContractRetrieveResponse

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

ContractDelete Transaction

The ContractDelete transaction can be used to find and delete a contract. Only the status and audit trail are updated when this transaction is executed.

Input Parameters: ContractDeleteRequest

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 contract to delete
sReason	String	No	“”	Audit reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: ContractResponse

See ContractResponse for more information.

ContractLinkCI Transaction

The ContractLinkCI transaction can be used to link a CMDB item to a contract.

Input Parameters: ContractLinkCIRequest

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
lConfigItem	Lookup Field	Yes	-	CMDB item in which to link the contract
lContract	Lookup Field	Yes	-	Contract to link to the CMDB item
sReason	String	No	“”	Audit reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: ContractResponse

See ContractResponse for more information.

ContractLinkExtOfficer Transaction

The ContractLinkExtOfficer transaction can be used to link an external contact to a contract.

Input Parameters: ContractLinkExtOfficerRequest

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	No	-	Ignored on Create
lExtOfficer	Lookup Field	Yes	-	External contact to link to the contract
lContract	Lookup Field	Yes	-	Contract in which to link the external contact
sReason	String	No	“”	Audit reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: ContractResponse

See ContractResponse for more information.

ContractUnlinkCI Transaction

The ContractUnlinkCI transaction can be used to delete the link between a contract and a CMDB item.

Input Parameters: ContractUnlinkCIRequest

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	No – if the contract and CMDB item are provided.	-	Link Ref between the contract and configuration item to delete.
lConfigItem	Lookup Field	No – if the Link ref is provided	-	Configuration Item linked to the contract
lContract	Lookup Field	No – if the Link ref is provided	-	Contract from which to delete the link to the Configuration Item
sReason	String	No	“”	Audit Reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: ContractResponse

See ContractResponse for more information.

ContractUnlinkExtOfficer Transaction

The ContractUnlinkCI transaction can be used to delete the link between an external contact and a CMDB item.

Input Parameters: ContractUnlinkExtOfficerRequest

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	No – if the contract and external contact are provided.	-	Link Ref between the contract and external contact to delete.
lExtOfficer	Lookup Field	No – if the Link ref is provided	-	External contact linked to the contract
lContract	Lookup Field	No – if the Link ref is provided	-	Contract from which to delete the link to the external contact
sReason	String	No	“”	Audit Reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: ContractResponse

See ContractResponse for more information.