doc.com.rallydev.rest.request.GetRequest.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rally-rest-api Show documentation

A java toolkit for interacting with the Rally Rest API

There is a newer version: 2.2.1






GetRequest (Rally Rest API for Java 2.1)













Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.rallydev.rest.request
Class GetRequest



java.lang.Object


com.rallydev.rest.request.Request


com.rallydev.rest.request.GetRequest











public class GetRequest
extends Request
Represents a WSAPI request to retrieve a specific object.











Constructor Summary

Constructors 

Constructor and Description


GetRequest(String ref)
Create a new get request for the specified object.










Method Summary

Methods 

Modifier and Type
Method and Description


Fetch
getFetch()
Get the current list of fields to be returned on the retrieved object.



void
setFetch(Fetch fetch)
Set the current list of fields to be returned on the retrieved object.



String
toUrl()
Convert this request into a url compatible with the WSAPI.







Methods inherited from class com.rallydev.rest.request.Request
addParam, getParams, setParams





Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





GetRequest
public GetRequest(String ref)
Create a new get request for the specified object.
Parameters:
ref - the ref of the WSAPI object to be retrieved.  May be absolute or relative, e.g. "/defect/12345"
            May also be "/user" or "/subscription" to get the current instances









Method Detail





getFetch
public Fetch getFetch()
Get the current list of fields to be returned on the retrieved object.
 By default all fields will be returned in the response (fetch=true).
Returns:
the current list of fields.







setFetch
public void setFetch(Fetch fetch)
Set the current list of fields to be returned on the retrieved object.
Parameters:
fetch - the list of fields to be returned.







toUrl
public String toUrl()
Convert this request into a url compatible with the WSAPI.
 The current fetch and any other parameters will be included.

Specified by:
toUrl in class Request
Returns:
the url representing this request.
















Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`Fetch`	`getFetch()` Get the current list of fields to be returned on the retrieved object.
`void`	`setFetch(Fetch fetch)` Set the current list of fields to be returned on the retrieved object.
`String`	`toUrl()` Convert this request into a url compatible with the WSAPI.