Click or drag to resize
RallyRestApi Constructor
Construct a new RallyRestApi configured to work with the specified WSAPI version

Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
public RallyRestApi(
	ApiAuthManager authManger = null,
	string webServiceVersion = "v2.0"
)

Parameters

authManger (Optional)
Type: Rally.RestApi.AuthApiAuthManager
The authorization manager to use when authentication requires it. If no driver is provided a console authentication manager will be used which does not allow SSO authentication.
webServiceVersion (Optional)
Type: SystemString
The WSAPI version to use (defaults to DEFAULT_WSAPI_VERSION)
Examples
For a console application, no authentication manager is needed as shown in this example.
C#
RallyRestApi restApi = new RallyRestApi();
For UI applications, an authentication manager must be provided. The authentication providers will configure the API and create the linkages as part of the constructor. Please see the documentation for the RestApiAuthMgrWpf and RestApiAuthMgrWinforms for more information.
C#
// You must define your own private application token. This ensures that your login details are not overwritten by someone else.
string applicationToken = "RallyRestAPISample";
// You must set a user specific salt for encryption.
string encryptionKey = "UserSpecificSaltForEncryption";
// You must define your own encryption routines.
IEncryptionRoutines encryptionUtilities = new EncryptionUtilities();

// Instantiate authorization manager
wpfAuthMgr = new RestApiAuthMgrWpf(applicationToken, encryptionKey, encryptionUtilities);
See Also