Request Class |
Namespace: Rally.RestApi
The Request type exposes the following members.
Name | Description | |
---|---|---|
Request |
Create a new empty Request.
| |
Request(String) |
Create a new Request with the specified artifact type
| |
Request(DynamicJsonObject) |
Create a new Request for the specified collection. (ie Defect.Tasks)
The collection should have a _ref property.
|
Name | Description | |
---|---|---|
ArtifactName |
The name of the artifact that will be queried
| |
Fetch |
A list of attributes to be returned in the result set.
If null or empty true will be used.
| |
Limit |
An upper bound on the total results to be returned.
| |
Order |
A sort string.
Examples ObjectId Desc Examples FormattedId | |
PageSize |
Page size for results. Must be between 1 and MAX_PAGE_SIZE, default is MAX_PAGE_SIZE.
| |
Project |
The ref for the project that you want the results from
Examples
/project/12345
| |
ProjectScopeDown |
Default is the user's default from Rally. In addition to the specified project, include child projects below the specified one.
| |
ProjectScopeUp |
Default is the user's default from Rally. In addition to the specified project, include projects above the specified one.
| |
Query |
A filter query to be applied to results before being returned
| |
Start |
Start index (1-based) for queries. The default is 1.
| |
UseShallowFetch |
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.
| |
Workspace |
The ref for the workspace that you want the results from
Examples
/workspace/12345
|
Name | Description | |
---|---|---|
AddParameter |
Ability to add parameters other than the ones explicitly exposed.
| |
Clone |
Perform a deep clone of this request and all its parameters.
| |
CreateFromUrl |
Create a request object from a url string.
| |
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.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
MAX_PAGE_SIZE |
The maximum page size (200).
|