attachChangeToRequest

Web Services Methods › Business Methods › attachChangeToRequest

attachChangeToRequest

The following parameters apply to the attachChangeToRequest method:

Parameter	Type	Description
SID	Integer	Identifies the session retrieved from logging in.
creator	String	Identifies the handle of the contact responsible for the activity.
requestHandle	String	Identifies the request to which you attach the change.
changeHandle	String	Identifies the handle of the change to add. If this is blank, a new change order is created. For additional information, see the following Description.
changeAttrVals	String[]	Identifies the attribute-value pairs used to initialize a new change order if the changeHandle is blank. For more information, see the following Description.
description	String	(Optional) Identifies the description of the activity.

Description

Attaches a new or existing change order to a request. It corresponds with “Activities—New Change Request” or “Activities—Attach to Existing Request” on a Request detail in the CA SDM interface.

To create a new change order, pass the empty string in changeHandle. The system will create a new change order with values initialized from the request, including the change’s Requestor, Affected End User, Description, and Priority (you can see this effect in the CA SDM interface). You can override these or set additional values with changeAttrVals, which is a name-value array similar to what is passed for createObject().

To attach an existing change order, specify a handle in the changeHandle parameter. In this case, changeAttrVals is ignored.

If a new change order is created, description is used on the new change order’s activity log. If an existing change is attached, description is used on the request’s activity log.

If the request already has an attached change order, the following error is returned:

UDS_CREATION_ERROR

Note: This method works exactly the same for the ITIL methodology—simply verify that you are passing the appropriate handle of an ITIL Incident or Problem to the method.

Returns

The following is returned:

XML Element	Type	Description
<changeHandle>	String	Identifies the handle for the change order, created or attached.