Click or drag to resize
RallyRestApiUpdate Method (String, DynamicJsonObject, NameValueCollection)
Update the item described by the specified reference with the fields of the specified object

Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
Copy
public OperationResult Update(
	string reference,
	DynamicJsonObject obj,
	NameValueCollection parameters
)

Parameters

reference
Type: SystemString
the reference to be updated
obj
Type: Rally.RestApi.JsonDynamicJsonObject
the object fields to update
parameters
Type: System.Collections.SpecializedNameValueCollection
additional query string parameters to be included on the request

Return Value

Type: OperationResult
An OperationResult describing the status of the request
Exceptions
ExceptionCondition
RallyUnavailableExceptionRally returned an HTML page. This usually occurs when Rally is off-line. Please check the ErrorMessage property for more information.
RallyFailedToDeserializeJsonThe JSON returned by Rally was not able to be deserialized. Please check the JsonData property for what was returned by Rally.
Examples
C#
Copy
string rallyRef = "https://preview.rallydev.com/slm/webservice/1.40/defect/12345.js";
DynamicJsonObject toUpdate = new DynamicJsonObject(); 
toUpdate["Description"] = "This is my defect."; 
NameValueCollection parameters = new NameValueCollection();
parameters["rankAbove"] = "/defect/23456";
OperationResult updateResult = restApi.Update(rallyRef, toUpdate, parameters);
See Also