Click or drag to resize
Request Class
Represents a request to be sent to Rally
Inheritance Hierarchy
SystemObject
  Rally.RestApiRequest

Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
[SerializableAttribute]
public class Request

The Request type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleRequest
Create a new empty Request.
Public methodCode exampleRequest(String)
Create a new Request with the specified artifact type
Public methodCode exampleRequest(DynamicJsonObject)
Create a new Request for the specified collection. (ie Defect.Tasks) The collection should have a _ref property.
Top
Properties
  NameDescription
Public propertyArtifactName
The name of the artifact that will be queried
Public propertyFetch
A list of attributes to be returned in the result set. If null or empty true will be used.
Public propertyLimit
An upper bound on the total results to be returned.
Public propertyCode exampleOrder
A sort string.
Examples
ObjectId Desc
Examples
FormattedId
Public propertyPageSize
Page size for results. Must be between 1 and MAX_PAGE_SIZE, default is MAX_PAGE_SIZE.
Public propertyCode exampleProject
The ref for the project that you want the results from
Examples
/project/12345
Public propertyProjectScopeDown
Default is the user's default from Rally. In addition to the specified project, include child projects below the specified one.
Public propertyProjectScopeUp
Default is the user's default from Rally. In addition to the specified project, include projects above the specified one.
Public propertyQuery
A filter query to be applied to results before being returned
Public propertyStart
Start index (1-based) for queries. The default is 1.
Public propertyUseShallowFetch
Using ShallowFetch will only fetch the fields listed in the [] on the related items rather than fetching all fields on all objects. An example of the param is: shallowFetch=Name,WorkProduct[Name;FormattedID] The Fetch attributes will be treated as a shallow fetch if this is set to true.
Public propertyCode exampleWorkspace
The ref for the workspace that you want the results from
Examples
/workspace/12345
Top
Methods
  NameDescription
Public methodAddParameter
Ability to add parameters other than the ones explicitly exposed.
Public methodCode exampleClone
Perform a deep clone of this request and all its parameters.
Public methodStatic memberCode exampleCreateFromUrl
Create a request object from a url string.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberMAX_PAGE_SIZE
The maximum page size (200).
Top
See Also