| RallyRestApi Class |
The main interface to the Rally REST API
Inheritance Hierarchy
Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
SyntaxThe RallyRestApi type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | RallyRestApi |
Construct a new RallyRestApi configured to work with the specified WSAPI version
|
Properties| Name | Description | |
|---|---|---|
 | AuthenticationState |
The state of authentication for this API instance.
|
| ConnectionInfo |
The connection info thsi API is using.
|
| Headers |
The HTTP headers to be included on all REST requests
|
| WebServiceUrl |
The full WSAPI url
|
| WsapiVersion |
The WSAPI version we are talking to.
|
Methods| Name | Description | |||
|---|---|---|---|---|
| AddToCollection |
Add items to a collection
| ||
| Authenticate(String, String, String, WebProxy, Boolean) |
Authenticates against Rally with the specified credentials
| ||
| Authenticate(String, String, Uri, WebProxy, Boolean) |
Authenticates against Rally with the specified credentials
| ||
| AuthenticateWithApiKey(String, String, WebProxy) |
Authenticates against Rally with the specified credentials
| ||
| AuthenticateWithApiKey(String, Uri, WebProxy) |
Authenticates against Rally with the specified credentials
| ||
| AuthenticateWithZSessionID |
Authenticates against Rally with the specified credentials
| ||
| Create(String, DynamicJsonObject) |
Create an object of the specified type from the specified object
| ||
| Create(String, DynamicJsonObject, NameValueCollection) |
Create an object of the specified type from the specified object
| ||
| Create(String, String, DynamicJsonObject) |
Create an object of the specified type from the specified object
| ||
| Delete(String) |
Delete the object described by the specified reference.
| ||
| Delete(String, Int64) |
Delete the object described by the specified type and object id.
| ||
| Delete(String, String) |
Delete the object described by the specified reference.
| ||
| Delete(String, String, Int64) |
Delete the object described by the specified type and object id.
| ||
| DownloadAttachment |
Downloads an attachment from Rally.
| ||
| Equals | (Inherited from Object.) | ||
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | ||
| GetAllowedAttributeValues |
Get the allowed values for the specified type and attribute
| ||
| GetAttributesByType |
Get the attribute definitions for the specified type
| ||
| GetByReference(String, String) |
Get the object described by the specified reference.
| ||
| GetByReference(String, Int64, String) |
Get the object described by the specified type and object id.
| ||
| GetByReferenceAndWorkspace |
Get the object described by the specified reference scoped to the provided workspace.
| ||
| GetCurrentUser |
Get the current user
| ||
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | ||
| GetSubscription |
Get the current subscription
| ||
| GetType | Gets the Type of the current instance. (Inherited from Object.) | ||
| GetTypes | Unsupported - DO NOT USE Get the attribute definitions for the specified project or workspace (part of the query string).
| ||
| Logout |
Logs this API out from any connection to Rally and clears the authentication configuration.
| ||
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | ||
| Post |
Performs a post of data to the provided URI.
| ||
| Query |
Perform a read against the WSAPI operation based
on the data in the specified request
| ||
| RemoveFromCollection |
Remove items from a collection
| ||
 | SetDefaultConnectionLimit |
Sets the default maximum concurrent connection limit for this application.
| ||
| ToString | Returns a string that represents the current object. (Inherited from Object.) | ||
| Update(String, DynamicJsonObject) |
Update the item described by the specified reference with
the fields of the specified object
| ||
| Update(String, DynamicJsonObject, NameValueCollection) |
Update the item described by the specified reference with
the fields of the specified object
| ||
| Update(String, String, DynamicJsonObject) |
Update the item described by the specified type and object id with
the fields of the specified object
| ||
| Update(String, String, DynamicJsonObject, NameValueCollection) |
Update the item described by the specified type and object id with
the fields of the specified object
|
NoteFields| Name | Description | |
|---|---|---|
 | AUTH_ERROR |
/// The default auth arror
|
| DEFAULT_SERVER |
The default server to use: (https://rally1.rallydev.com)
|
| DEFAULT_WSAPI_VERSION |
The default WSAPI version to use
|
| SECURITY_ENDPOINT |
The endpoint for getting a CSRF token. This has custom logic in HttpService for SSO users.
|
| ZSessionID |
The identifier for the authentication cookie used by Rally.
|
See Also