Difference between revisions of "ChangeOwnerShipInfo"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 8: | Line 8: | ||
:* 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: <tt>requestParams.add("owner_id", " | {{Note|When adding a record with the [[addRecord]] method, it is only necessary to specify the owner in the requestParams: <tt>requestParams.add("owner_id", "new user id");</tt>}} | ||
;Syntax: | ;Syntax: | ||
:<syntaxhighlight lang="java" enclose="div"> | :<syntaxhighlight lang="java" enclose="div"> | ||
Result result = | Result result = Functions.changeOwnerShipInfo(String objectId, String recordId, String ownerId); | ||
Result result = __apiName__(String objectId, String | Result result = Functions.__apiName__(String objectId, String recordId, String ownerId | ||
[, Parameters params] ); | [, Parameters params] ); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
;Parameters: | ;Parameters: | ||
:;objectId:The object identifier | :;objectId:The object identifier | ||
:; | :;recordId:The record identifier | ||
:; | :;ownerId:User ID of the new owner. | ||
:;params: Optional. A [[Parameters Class|Parameters]] object that contains additional parameters. | :;params: Optional. A [[Parameters Class|Parameters]] object that contains additional parameters. | ||
::*. | ::*''' -notifyEmail -''' A Boolean. Set to true to send the new user an email notification. | ||
;Returns: | ;Returns: | ||
| Line 37: | Line 33: | ||
;Throws: | ;Throws: | ||
:Exception | :Exception | ||
<!-- | |||
;Example:This example .... | ;Example:This example .... | ||
:<syntaxhighlight lang="java" enclose="div"> | :<syntaxhighlight lang="java" enclose="div"> | ||
... | ... | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<noinclude> | --><noinclude> | ||
[[Category:Java API | changeOwnerShipInfo]] | [[Category:Java API | changeOwnerShipInfo]] | ||
</noinclude> | </noinclude> | ||
Revision as of 01:24, 16 September 2011
Change the owner of a record.
- Requirements
To perform this operation, you must either:
- Own the record,
- 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.
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
- <syntaxhighlight lang="java" enclose="div">
Result result = Functions.changeOwnerShipInfo(String objectId, String recordId, String ownerId); Result result = Functions.__apiName__(String objectId, String recordId, String ownerId
[, Parameters params] );
</syntaxhighlight>
- Parameters
-
- objectId
- The object identifier
- recordId
- The record identifier
- ownerId
- User ID of the new owner.
- params
- Optional. A Parameters object that contains additional parameters.
- -notifyEmail - A Boolean. Set to true to send the new user an email notification.
- Returns
- Result object
--or--
- An integer containing ...
- A string containing ...
- Throws
- Exception