Construct a new RallyRestApi configured to work with the specified WSAPI version
Namespace: Rally.RestApiAssembly: 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"
)
Public Sub New (
Optional authManger As ApiAuthManager = Nothing,
Optional webServiceVersion As String = "v2.0"
)
public:
RallyRestApi(
ApiAuthManager^ authManger = nullptr,
String^ webServiceVersion = L"v2.0"
)
new :
?authManger : ApiAuthManager *
?webServiceVersion : string
(* Defaults:
let _authManger = defaultArg authManger null
let _webServiceVersion = defaultArg webServiceVersion "v2.0"
*)
-> RallyRestApi
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.
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.
string applicationToken = "RallyRestAPISample";
string encryptionKey = "UserSpecificSaltForEncryption";
IEncryptionRoutines encryptionUtilities = new EncryptionUtilities();
wpfAuthMgr = new RestApiAuthMgrWpf(applicationToken, encryptionKey, encryptionUtilities);
See Also