Click or drag to resize
Request Properties

The Request type exposes the following members.

Properties
  Name Description
Public property ArtifactName
The name of the artifact that will be queried
Public property Fetch
A list of attributes to be returned in the result set. If null or empty true will be used.
Public property Limit
An upper bound on the total results to be returned.
Public property Code example Order
A sort string.
Examples
ObjectId Desc
Examples
FormattedId
Public property PageSize
Page size for results. Must be between 1 and MAX_PAGE_SIZE, default is MAX_PAGE_SIZE.
Public property Code example Project
The ref for the project that you want the results from
Examples
/project/12345
Public property ProjectScopeDown
Default is the user's default from Rally. In addition to the specified project, include child projects below the specified one.
Public property ProjectScopeUp
Default is the user's default from Rally. In addition to the specified project, include projects above the specified one.
Public property Query
A filter query to be applied to results before being returned
Public property Start
Start index (1-based) for queries. The default is 1.
Public property 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.
Public property Code example Workspace
The ref for the workspace that you want the results from
Examples
/workspace/12345
Top
See Also