RallyRestApi.GetCurrentUser Method

RallyRestApiGetCurrentUser Method

Get the current user

Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)

Syntax

public Object GetCurrentUser(
	params string[] fetchedFields
)

Public Function GetCurrentUser ( 
	ParamArray fetchedFields As String()
) As Object

public:
Object^ GetCurrentUser(
	... array<String^>^ fetchedFields
)

member GetCurrentUser : 
        fetchedFields : string[] -> Object

fetchedFields: Type: SystemString
The fields that should be retrieved for the user. If no fields are specified, a * wild card will be used.

Type: Object
A DynamicJsonObject that contains the currently logged in user.

Exceptions

Exception	Condition
RallyUnavailableException	Rally returned an HTML page. This usually occurs when Rally is off-line. Please check the ErrorMessage property for more information.
RallyFailedToDeserializeJson	The JSON returned by Rally was not able to be deserialized. Please check the JsonData property for what was returned by Rally.

Examples

DynamicJsonObject user = restApi.GetCurrentUser("Name", "FormattedID");
string user = user["Name"];
string userID = user["FormattedID"];