doc.com.rallydev.rest.request.UpdateRequest.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






UpdateRequest (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 UpdateRequest



java.lang.Object


com.rallydev.rest.request.Request


com.rallydev.rest.request.UpdateRequest











public class UpdateRequest
extends Request
Represents a WSAPI request to update an object.











Constructor Summary

Constructors 

Constructor and Description


UpdateRequest(String ref,
             JsonObject obj)
Create a new update request for the specified object and values.










Method Summary

Methods 

Modifier and Type
Method and Description


String
getBody()
Get the JSON encoded string representation of the object to be updated.



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



void
setFetch(Fetch fetch)
Set the current list of fields to be returned on the updated 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





UpdateRequest
public UpdateRequest(String ref,
             JsonObject obj)
Create a new update request for the specified object and values.
Parameters:
ref - the ref of the WSAPI object to be created.  May be absolute or relative, e.g. "/defect/12345"
obj - the JSON representation of the values of the object









Method Detail





getBody
public String getBody()
Get the JSON encoded string representation of the object to be updated.
Returns:
the JSON encoded object







getFetch
public Fetch getFetch()
Get the current list of fields to be returned on the updated 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 updated 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
`String`	`getBody()` Get the JSON encoded string representation of the object to be updated.
`Fetch`	`getFetch()` Get the current list of fields to be returned on the updated object.
`void`	`setFetch(Fetch fetch)` Set the current list of fields to be returned on the updated object.
`String`	`toUrl()` Convert this request into a url compatible with the WSAPI.