escalate

Web Services Methods › Business Methods › escalate

escalate

The following parameters apply to the escalate 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.
objectHandle	String	Identifies the handle for a request, issue, or change order. Any other object type is rejected.
description	String	Identifies the description for the activity, which will appear in the activity log.
setAssignee	Boolean	Updates the assignee field, if true.
newAssigneeHandle	String	Identifies the handle of the new assignee for the object.
setGroup	Boolean	Updates the group field with the value in newGroupHandle, if true.
newGroupHandle	String	Identifies the handle of the new group for the object.
setOrganization	Boolean	Sets the organization field with the value specified in the newOrganizationHandle, if true.
newOrgnizationHandle	String	(Issues and Change Orders only) Identifies the handle of the new organization for the object.
setPriorityHandle	Boolean	Updates the priority field with the value specified in newPriority, if true.
newPriority	String	Identifies the handle of the new priority for the object.

Description

Performs an escalate activity on an Issue, Request or Change Order. This method generates an activity log and optionally sets a new assignee, group, priority and/or organization.

It corresponds to the “Activities—Escalate” command in the CA SDM interface.

The assignee, group, or organization is not updated unless one or more of the corresponding setAssignee/setGroup/setOrganization parameters is set to true. If the companion parameter is false, then escalate will not attempt to update the field, even if a value is passed for that field. For example, if setAssignee is passed as false, escalate will not update the assignee even if newAssignee specifies a value. If the setXXXX parameter is true, then the field is updated. Pass the empty string to set a field to empty/null.

Note: Organization is not used for Requests.

Returns

One or more handles to the activity log objects created.

XML Element	Type	Description
<LogHandle>	String	Identifies the handle for the new activity log (zero or more of these can be returned).