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






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



java.lang.Object


com.rallydev.rest.request.Request


com.rallydev.rest.request.CreateRequest











public class CreateRequest
extends Request
Represents a WSAPI request to create an object.











Constructor Summary

Constructors 

Constructor and Description


CreateRequest(String type,
             JsonObject obj)
Create a new create request with the specified type and values.










Method Summary

Methods 

Modifier and Type
Method and Description


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



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



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





CreateRequest
public CreateRequest(String type,
             JsonObject obj)
Create a new create request with the specified type and values.
Parameters:
type - the WSAPI object type to be created, e.g. Defect
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 created.
Returns:
the JSON encoded object







getFetch
public Fetch getFetch()
Get the current list of fields to be returned on the created object.
 By default only the underscore fields such as _ref will be returned in the response.
Returns:
the current list of fields.







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