Index (Rally Rest Toolkit For Java 2.2.1 API)

A B C D E F G H I O Q R S T U W

A

addParam(String, String) - Method in class com.rallydev.rest.request.Request: Add the specified parameter to this request.
and(QueryFilter) - Method in class com.rallydev.rest.util.QueryFilter: Get a query filter that is the ANDed combination of this filter and the specified one.
and(QueryFilter...) - Static method in class com.rallydev.rest.util.QueryFilter: Get a query filter that is the ANDed combination of the specified filters.
API_KEY_HEADER - Static variable in class com.rallydev.rest.client.ApiKeyClient
apiKey - Variable in class com.rallydev.rest.client.ApiKeyClient
ApiKeyClient - Class in com.rallydev.rest.client: A HttpClient which authenticates using an API Key.
ApiKeyClient(URI, String) - Constructor for class com.rallydev.rest.client.ApiKeyClient: Construct a new client.
attachSecurityInfo(HttpRequestBase) - Method in class com.rallydev.rest.client.BasicAuthClient: Attach the security token parameter to the request.

B

BasicAuthClient - Class in com.rallydev.rest.client: A HttpClient which authenticates using basic authentication (username/password).
BasicAuthClient(URI, String, String) - Constructor for class com.rallydev.rest.client.BasicAuthClient: Construct a new client.

C

client - Variable in class com.rallydev.rest.client.HttpClient
client - Variable in class com.rallydev.rest.RallyRestApi
clone() - Method in class com.rallydev.rest.request.QueryRequest: Clone this request.
close() - Method in class com.rallydev.rest.client.HttpClient: Release all resources associated with this instance.
close() - Method in class com.rallydev.rest.RallyRestApi: Release all resources associated with this instance.
CollectionUpdateRequest - Class in com.rallydev.rest.request: Represents a WSAPI request to update a collection.
CollectionUpdateRequest(JsonObject, JsonArray, boolean) - Constructor for class com.rallydev.rest.request.CollectionUpdateRequest: Create a new update request for the specified collection and values.
CollectionUpdateRequest(String, JsonArray, boolean) - Constructor for class com.rallydev.rest.request.CollectionUpdateRequest: Create a new update request for the specified collection and values.
CollectionUpdateResponse - Class in com.rallydev.rest.response: Represents a WSAPI response from updating a collection.
CollectionUpdateResponse(String) - Constructor for class com.rallydev.rest.response.CollectionUpdateResponse: Create a new collection update response from the specified JSON encoded string.
com.rallydev.rest - package com.rallydev.rest: Provides the main interface to the Rest API.
com.rallydev.rest.client - package com.rallydev.rest.client: Provides the underlying http client implementations.
com.rallydev.rest.request - package com.rallydev.rest.request: Provides objects for encoding requests to the Rest API.
com.rallydev.rest.response - package com.rallydev.rest.response: Provides objects for parsing responses from the Rest API.
com.rallydev.rest.util - package com.rallydev.rest.util: Provides utilities for working with the Rest API.
create(CreateRequest) - Method in class com.rallydev.rest.RallyRestApi: Create the specified object.
CreateRequest - Class in com.rallydev.rest.request: Represents a WSAPI request to create an object.
CreateRequest(String, JsonObject) - Constructor for class com.rallydev.rest.request.CreateRequest: Create a new create request with the specified type and values.
CreateResponse - Class in com.rallydev.rest.response: Represents a WSAPI response from creating an object
CreateResponse(String) - Constructor for class com.rallydev.rest.response.CreateResponse: Create a new create response from the specified JSON encoded string.
credentials - Variable in class com.rallydev.rest.client.BasicAuthClient

D

delete(DeleteRequest) - Method in class com.rallydev.rest.RallyRestApi: Delete the specified object.
DeleteRequest - Class in com.rallydev.rest.request: Represents a WSAPI request to delete an object.
DeleteRequest(String) - Constructor for class com.rallydev.rest.request.DeleteRequest: Createa new delete request for the specified object.
DeleteResponse - Class in com.rallydev.rest.response: Represents a WSAPI response from deleting an object
DeleteResponse(String) - Constructor for class com.rallydev.rest.response.DeleteResponse: Create a new delete response from the specified JSON encoded string.
doDelete(String) - Method in class com.rallydev.rest.client.HttpClient: Perform a delete against the WSAPI
doGet(String) - Method in class com.rallydev.rest.client.HttpClient: Perform a get against the WSAPI
doPost(String, String) - Method in class com.rallydev.rest.client.HttpClient: Perform a post against the WSAPI
doPut(String, String) - Method in class com.rallydev.rest.client.HttpClient: Perform a put against the WSAPI
doRequest(HttpRequestBase) - Method in class com.rallydev.rest.client.ApiKeyClient: Execute a request against the WSAPI
doRequest(HttpRequestBase) - Method in class com.rallydev.rest.client.BasicAuthClient: Execute a request against the WSAPI
doRequest(HttpRequestBase) - Method in class com.rallydev.rest.client.HttpClient: Execute a request against the WSAPI

E

executeRequest(HttpRequestBase) - Method in class com.rallydev.rest.client.HttpClient: Execute a request against the WSAPI

F

Fetch - Class in com.rallydev.rest.util: Represents a list of fields to be returned in responses from the WSAPI.
Fetch(String...) - Constructor for class com.rallydev.rest.util.Fetch: Create a new fetch with the specified fields.

G

get(GetRequest) - Method in class com.rallydev.rest.RallyRestApi: Get the specified object.
getBody() - Method in class com.rallydev.rest.request.CollectionUpdateRequest: Get the JSON encoded string representation of the object to be updated.
getBody() - Method in class com.rallydev.rest.request.CreateRequest: Get the JSON encoded string representation of the object to be created.
getBody() - Method in class com.rallydev.rest.request.UpdateRequest: Get the JSON encoded string representation of the object to be updated.
getClient() - Method in class com.rallydev.rest.RallyRestApi: Get the underlying http client implementation.
getEndpoint() - Method in class com.rallydev.rest.request.GetRequest
getErrors() - Method in class com.rallydev.rest.response.Response: Get any errors returned in the response.
getFetch() - Method in class com.rallydev.rest.request.CollectionUpdateRequest: Get the current list of fields to be returned on the updated object.
getFetch() - Method in class com.rallydev.rest.request.CreateRequest: Get the current list of fields to be returned on the created object.
getFetch() - Method in class com.rallydev.rest.request.GetRequest: Get the current list of fields to be returned on the retrieved object.
getFetch() - Method in class com.rallydev.rest.request.QueryRequest: Get the current list of fields to be returned on the matching objects.
getFetch() - Method in class com.rallydev.rest.request.UpdateRequest: Get the current list of fields to be returned on the updated object.
getGsonBuilder() - Method in class com.rallydev.rest.request.Request: Get the Gson Builder used for JSON serialization in this request.
getLimit() - Method in class com.rallydev.rest.request.QueryRequest: Get the maximum number of records to be returned from the query.
getObject() - Method in class com.rallydev.rest.response.CreateResponse: Get the created object.
getObject() - Method in class com.rallydev.rest.response.GetResponse: Get the retrieved object.
getObject() - Method in class com.rallydev.rest.response.UpdateResponse: Get the updated object.
getOidFromRef(String) - Static method in class com.rallydev.rest.util.Ref: Get the ObjectID from the specified ref url
getOrder() - Method in class com.rallydev.rest.request.QueryRequest: Set the order by which the result set will be sorted.
getPageSize() - Method in class com.rallydev.rest.request.QueryRequest: Get the page size of the result set.
getPageSize() - Method in class com.rallydev.rest.response.QueryResponse: Get the page size of the results
getParams() - Method in class com.rallydev.rest.request.Request: Get the list of additional parameters included in this request.
getProject() - Method in class com.rallydev.rest.request.QueryRequest: Get the project which the result set should be scoped to.
getQueryFilter() - Method in class com.rallydev.rest.request.QueryRequest: Get the filter by which the result set will be narrowed down.
getRelativeRef(String) - Static method in class com.rallydev.rest.util.Ref: Create a relative ref url from the specified ref
GetRequest - Class in com.rallydev.rest.request: Represents a WSAPI request to retrieve a specific object.
GetRequest(String) - Constructor for class com.rallydev.rest.request.GetRequest: Create a new get request for the specified object.
GetResponse - Class in com.rallydev.rest.response: Represents a WSAPI response from retrieving a single object.
GetResponse(String) - Constructor for class com.rallydev.rest.response.GetResponse: Create a new get response from the specified JSON encoded string.
getResults() - Method in class com.rallydev.rest.response.CollectionUpdateResponse: Get the results of the collection update
getResults() - Method in class com.rallydev.rest.response.QueryResponse: Get the results of the query
getRoot() - Method in class com.rallydev.rest.response.CollectionUpdateResponse: Get the name of the root JSON result
getRoot() - Method in class com.rallydev.rest.response.CreateResponse: Get the name of the root JSON result
getRoot() - Method in class com.rallydev.rest.response.DeleteResponse: Get the name of the root JSON result
getRoot() - Method in class com.rallydev.rest.response.GetResponse: Get the name of the root JSON result
getRoot() - Method in class com.rallydev.rest.response.QueryResponse: Get the name of the root JSON result
getRoot() - Method in class com.rallydev.rest.response.Response: Get the name of the root JSON result
getRoot() - Method in class com.rallydev.rest.response.UpdateResponse: Get the name of the root JSON result
getServer() - Method in class com.rallydev.rest.client.HttpClient: Get the current server being targeted.
getStart() - Method in class com.rallydev.rest.request.QueryRequest: Get the start index of the result set.
getStart() - Method in class com.rallydev.rest.response.QueryResponse: Get the start index of the results
getTotalResultCount() - Method in class com.rallydev.rest.response.QueryResponse: Get the total number of objects that matched the query
getTypeEndpoint() - Method in class com.rallydev.rest.request.QueryRequest
getTypeFromRef(String) - Static method in class com.rallydev.rest.util.Ref: Get the type from the specified ref url
getWarnings() - Method in class com.rallydev.rest.response.Response: Get any warnings returned in the response.
getWorkspace() - Method in class com.rallydev.rest.request.QueryRequest: Get the workspace which the result set should be scoped to.
getWsapiUrl() - Method in class com.rallydev.rest.client.HttpClient: Get the WSAPI base url based on the current server and WSAPI version
getWsapiVersion() - Method in class com.rallydev.rest.client.HttpClient: Get the current version of the WSAPI being targeted.
getWsapiVersion() - Method in class com.rallydev.rest.RallyRestApi: Get the current version of the WSAPI being targeted.
gsonBuilder - Variable in class com.rallydev.rest.request.Request: Gson Builder used for JSON serialization in this request.

H

HttpClient - Class in com.rallydev.rest.client: A HttpClient implementation providing connectivity to Rally.
HttpClient(URI) - Constructor for class com.rallydev.rest.client.HttpClient

I

isRef(String) - Static method in class com.rallydev.rest.util.Ref: Determine whether the specified string is a valid ref url.
isScopedDown() - Method in class com.rallydev.rest.request.QueryRequest: If a project has been specified, get whether to include matching objects in child projects in the result set.
isScopedUp() - Method in class com.rallydev.rest.request.QueryRequest: If a project has been specified, get whether to include matching objects in parent projects in the result set.

O

or(QueryFilter) - Method in class com.rallydev.rest.util.QueryFilter: Get a query filter that is the ORed combination of this filter and the specified one.
or(QueryFilter...) - Static method in class com.rallydev.rest.util.QueryFilter: Get a query filter that is the ORed combination of the specified filters.

Q

query(QueryRequest) - Method in class com.rallydev.rest.RallyRestApi: Query for objects matching the specified request.
QueryFilter - Class in com.rallydev.rest.util: Represents a query filter to be applied to query requests.
QueryFilter(String, String, String) - Constructor for class com.rallydev.rest.util.QueryFilter: Create a new query filter with the specified options.
QueryFilter(QueryFilter, String, QueryFilter) - Constructor for class com.rallydev.rest.util.QueryFilter: Internal constructor for joining multiple QueryFilter objects by an AND or OR.
QueryRequest - Class in com.rallydev.rest.request: Represents a WSAPI request to retrieve all objects matching specified criteria.
QueryRequest(String) - Constructor for class com.rallydev.rest.request.QueryRequest: Create a new query request for the specified type.
QueryRequest(JsonObject) - Constructor for class com.rallydev.rest.request.QueryRequest: Create a new query request for the specified collection.
QueryResponse - Class in com.rallydev.rest.response: Represents a WSAPI response from querying for objects.
QueryResponse(String) - Constructor for class com.rallydev.rest.response.QueryResponse: Create a new query response from the specified JSON encoded string.

R

RallyRestApi - Class in com.rallydev.rest: The main interface to the Rest API.
RallyRestApi(URI, String, String) - Constructor for class com.rallydev.rest.RallyRestApi: Deprecated.
Use the api key constructor instead.
RallyRestApi(URI, String) - Constructor for class com.rallydev.rest.RallyRestApi: Creates a new instance for the specified server using the specified API Key.
RallyRestApi(HttpClient) - Constructor for class com.rallydev.rest.RallyRestApi
raw - Variable in class com.rallydev.rest.response.Response
Ref - Class in com.rallydev.rest.util: Provides utility methods for working with ref URLs.
Ref() - Constructor for class com.rallydev.rest.util.Ref
Request - Class in com.rallydev.rest.request: Base class for all WSAPI requests.
Request() - Constructor for class com.rallydev.rest.request.Request: Create a new request.
Response - Class in com.rallydev.rest.response: Represents a WSAPI response.
Response(String) - Constructor for class com.rallydev.rest.response.Response: Create a new response from the specified JSON encoded string.
result - Variable in class com.rallydev.rest.response.Response

S

SECURITY_ENDPOINT_DOES_NOT_EXIST - Static variable in class com.rallydev.rest.client.BasicAuthClient
SECURITY_TOKEN_KEY - Static variable in class com.rallydev.rest.client.BasicAuthClient
SECURITY_TOKEN_PARAM_KEY - Static variable in class com.rallydev.rest.client.BasicAuthClient
securityToken - Variable in class com.rallydev.rest.client.BasicAuthClient
server - Variable in class com.rallydev.rest.client.HttpClient
setApplicationName(String) - Method in class com.rallydev.rest.client.HttpClient: Set the value of the X-RallyIntegrationName header included on all requests.
setApplicationName(String) - Method in class com.rallydev.rest.RallyRestApi: Set the value of the X-RallyIntegrationName header included on all requests.
setApplicationVendor(String) - Method in class com.rallydev.rest.client.HttpClient: Set the value of the X-RallyIntegrationVendor header included on all requests.
setApplicationVendor(String) - Method in class com.rallydev.rest.RallyRestApi: Set the value of the X-RallyIntegrationVendor header included on all requests.
setApplicationVersion(String) - Method in class com.rallydev.rest.client.HttpClient: Set the value of the X-RallyIntegrationVersion header included on all requests.
setApplicationVersion(String) - Method in class com.rallydev.rest.RallyRestApi: Set the value of the X-RallyIntegrationVersion header included on all requests.
setClientCredentials(URI, String, String) - Method in class com.rallydev.rest.client.HttpClient
setFetch(Fetch) - Method in class com.rallydev.rest.request.CollectionUpdateRequest: Set the current list of fields to be returned on the updated object.
setFetch(Fetch) - Method in class com.rallydev.rest.request.CreateRequest: Set the current list of fields to be returned on the created object.
setFetch(Fetch) - Method in class com.rallydev.rest.request.GetRequest: Set the current list of fields to be returned on the retrieved object.
setFetch(Fetch) - Method in class com.rallydev.rest.request.QueryRequest: Set the current list of fields to be returned on the matching objects.
setFetch(Fetch) - Method in class com.rallydev.rest.request.UpdateRequest: Set the current list of fields to be returned on the updated object.
setGsonBuilder(GsonBuilder) - Method in class com.rallydev.rest.request.Request: Set the Gson Builder used for JSON serialization in this request.
setLimit(int) - Method in class com.rallydev.rest.request.QueryRequest: Set the maximum number of records to be returned from the query.
setOrder(String) - Method in class com.rallydev.rest.request.QueryRequest: Get the order by which the result set will be sorted.
setPageSize(int) - Method in class com.rallydev.rest.request.QueryRequest: Set the page size of the result set.
setParams(List<NameValuePair>) - Method in class com.rallydev.rest.request.Request: Set the list of additional parameters included in this request.
setProject(String) - Method in class com.rallydev.rest.request.QueryRequest: Specify the project which the result set should be scoped to.
setProxy(URI) - Method in class com.rallydev.rest.client.HttpClient: Set the unauthenticated proxy server to use.
setProxy(URI, String, String) - Method in class com.rallydev.rest.client.HttpClient: Set the authenticated proxy server to use.
setProxy(URI) - Method in class com.rallydev.rest.RallyRestApi: Set the unauthenticated proxy server to use.
setProxy(URI, String, String) - Method in class com.rallydev.rest.RallyRestApi: Set the authenticated proxy server to use.
setQueryFilter(QueryFilter) - Method in class com.rallydev.rest.request.QueryRequest: Set a filter by which the result set will be narrowed down.
setScopedDown(boolean) - Method in class com.rallydev.rest.request.QueryRequest: If a project has been specified, set whether to include matching objects in child projects in the result set.
setScopedUp(boolean) - Method in class com.rallydev.rest.request.QueryRequest: If a project has been specified, set whether to include matching objects in parent projects in the result set.
setStart(int) - Method in class com.rallydev.rest.request.QueryRequest: Set the 1-based start index of the result set.
setWorkspace(String) - Method in class com.rallydev.rest.request.QueryRequest: Specify the workspace which the result set should be scoped to.
setWsapiVersion(String) - Method in class com.rallydev.rest.client.HttpClient: Set the current version of the WSAPI being targeted.
setWsapiVersion(String) - Method in class com.rallydev.rest.RallyRestApi: Set the current version of the WSAPI being targeted.

T

toString() - Method in class com.rallydev.rest.util.Fetch: Get the comma separated list of fields to be returned.
toString() - Method in class com.rallydev.rest.util.QueryFilter: Get the string representation of this query filter.
toUrl() - Method in class com.rallydev.rest.request.CollectionUpdateRequest: Convert this request into a url compatible with the WSAPI.
toUrl() - Method in class com.rallydev.rest.request.CreateRequest: Convert this request into a url compatible with the WSAPI.
toUrl() - Method in class com.rallydev.rest.request.DeleteRequest: Convert this request into a url compatible with the WSAPI.
toUrl() - Method in class com.rallydev.rest.request.GetRequest: Convert this request into a url compatible with the WSAPI.
toUrl() - Method in class com.rallydev.rest.request.QueryRequest: Convert this request into a url compatible with the WSAPI.
toUrl() - Method in class com.rallydev.rest.request.Request: Convert this request into a url compatible with the WSAPI.
toUrl() - Method in class com.rallydev.rest.request.UpdateRequest: Convert this request into a url compatible with the WSAPI.

U

update(UpdateRequest) - Method in class com.rallydev.rest.RallyRestApi: Update the specified object.
updateCollection(CollectionUpdateRequest) - Method in class com.rallydev.rest.RallyRestApi: Update the specified collection.
UpdateRequest - Class in com.rallydev.rest.request: Represents a WSAPI request to update an object.
UpdateRequest(String, JsonObject) - Constructor for class com.rallydev.rest.request.UpdateRequest: Create a new update request for the specified object and values.
UpdateResponse - Class in com.rallydev.rest.response: Represents a WSAPI response from updating an object.
UpdateResponse(String) - Constructor for class com.rallydev.rest.response.UpdateResponse: Create a new update response from the specified JSON encoded string.

W

wasSuccessful() - Method in class com.rallydev.rest.response.Response: Returns whether the response was successful (no errors)
wsapiVersion - Variable in class com.rallydev.rest.client.HttpClient

A B C D E F G H I O Q R S T U W