Difference between revisions of "ChangeOwnerShipInfo"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(5 intermediate revisions by the same user not shown)
Line 6: Line 6:
:* Own the record,
:* Own the record,
:* Be a [[System Administrator]], or  
:* Be a [[System Administrator]], or  
:* Have [[Change Ownership of my Team’s Records]] permission and be working on a record that is owned by someone on your [[Team]].  
:* Have [[Change Ownership of my Team’s Records permission]] and be working on a record that is owned by someone on your [[Team]].  


{{Note|When adding a record with the [[addRecord]] method, it is only necessary to specify the owner in the requestParams:<br> &nbsp; <tt>requestParams.add("owner_id", "new user id");</tt>}}  
{{Note|When adding a record with the [[addRecord]] method, it is only necessary to specify the owner in the requestParams:<br> &nbsp; <tt>requestParams.add("owner_id", "new user id");</tt>}}  
Line 13: Line 13:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
Result result;
Result result;
result = Functions.changeOwnerShipInfo(String objectId, String recordId,
result = Functions.changeOwnerShipInfo(String objectName, String recordId,
                                       String ownerId [, Parameters params] );
                                       String ownerId [, Boolean notifyEmail] );
</syntaxhighlight>
</syntaxhighlight>


;Parameters:
;Parameters:
:'''objectId -''' The object identifier
:'''objectName -''' The object name or identifier
:'''recordId -''' The record identifier
:'''recordId -''' The record identifier
:'''ownerId -''' User ID of the new owner.
:'''ownerId -''' User ID of the new owner.
:'''params -''' An optional [[Parameters Class|Parameters]] object that contains additional parameters:
:'''notifyEmail-''' An optional parameter. Set to true to send the new owner an email notification.
::*'''notifyEmail -''' A Boolean. Set to true to send the new user an email notification.


;Returns:
;Returns:
:[[Result Class|<tt>Result</tt>]] object<br/>
:[[Result Class|<tt>Result</tt>]] object<br/>
--or--
:An integer containing ...
:A string containing ...


;Throws:
;Throws:

Latest revision as of 00:34, 18 November 2014

Change the owner of a record.

Requirements

To perform this operation, you must either:

Notepad.png

Note: When adding a record with the addRecord method, it is only necessary to specify the owner in the requestParams:
  requestParams.add("owner_id", "new user id");

Syntax
Result result;
result = Functions.changeOwnerShipInfo(String objectName, String recordId,
                                       String ownerId [, Boolean notifyEmail] );
Parameters
objectName - The object name or identifier
recordId - The record identifier
ownerId - User ID of the new owner.
notifyEmail- An optional parameter. Set to true to send the new owner an email notification.
Returns
Result object
Throws
Exception