Click or drag to resize
RallyRestApi Methods

The RallyRestApi type exposes the following members.

Methods
  Name Description
Public method Code example AddToCollection
Add items to a collection
Public method Code example Authenticate(String, String, String, WebProxy, Boolean)
Authenticates against Rally with the specified credentials
Public method Code example Authenticate(String, String, Uri, WebProxy, Boolean)
Authenticates against Rally with the specified credentials
Public method Code example AuthenticateWithApiKey(String, String, WebProxy)
Authenticates against Rally with the specified credentials
Public method Code example AuthenticateWithApiKey(String, Uri, WebProxy)
Authenticates against Rally with the specified credentials
Public method Code example AuthenticateWithZSessionID
Authenticates against Rally with the specified credentials
Public method Code example Create(String, DynamicJsonObject)
Create an object of the specified type from the specified object
Public method Code example Create(String, DynamicJsonObject, NameValueCollection)
Create an object of the specified type from the specified object
Public method Code example Create(String, String, DynamicJsonObject)
Create an object of the specified type from the specified object
Public method Code example Delete(String)
Delete the object described by the specified reference.
Public method Code example Delete(String, Int64)
Delete the object described by the specified type and object id.
Public method Code example Delete(String, String)
Delete the object described by the specified reference.
Public method Code example Delete(String, String, Int64)
Delete the object described by the specified type and object id.
Public method Code example DownloadAttachment
Downloads an attachment from Rally.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method Code example GetAllowedAttributeValues
Get the allowed values for the specified type and attribute
Public method Code example GetAttributesByType
Get the attribute definitions for the specified type
Public method Code example GetByReference(String, String)
Get the object described by the specified reference.
Public method Code example GetByReference(String, Int64, String)
Get the object described by the specified type and object id.
Public method Code example GetByReferenceAndWorkspace
Get the object described by the specified reference scoped to the provided workspace.
Public method Code example GetCurrentUser
Get the current user
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method Code example GetSubscription
Get the current subscription
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method Code example GetTypes

Unsupported - DO NOT USE

Get the attribute definitions for the specified project or workspace (part of the query string).
Note Note
This uses an unpublished/unsupported endpoint and should NOT be used by non-Rally applications. This endpoint may alter behavior at any point in time.
Public method Code example Logout
Logs this API out from any connection to Rally and clears the authentication configuration.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Code example Post
Performs a post of data to the provided URI.
Public method Code example Query
Perform a read against the WSAPI operation based on the data in the specified request
Public method Code example RemoveFromCollection
Remove items from a collection
Public method Static member Code example SetDefaultConnectionLimit
Sets the default maximum concurrent connection limit for this application.
Note Note
This will affect all connections that use Service Point.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method Code example Update(String, DynamicJsonObject)
Update the item described by the specified reference with the fields of the specified object
Public method Code example Update(String, DynamicJsonObject, NameValueCollection)
Update the item described by the specified reference with the fields of the specified object
Public method Code example Update(String, String, DynamicJsonObject)
Update the item described by the specified type and object id with the fields of the specified object
Public method Code example Update(String, String, DynamicJsonObject, NameValueCollection)
Update the item described by the specified type and object id with the fields of the specified object
Top
See Also