RallyRestApi.Update Method (String, DynamicJsonObject)

RallyRestApiUpdate Method (String, DynamicJsonObject)

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

public OperationResult Update(
	string reference,
	DynamicJsonObject obj
)

Public Function Update ( 
	reference As String,
	obj As DynamicJsonObject
) As OperationResult

public:
OperationResult^ Update(
	String^ reference, 
	DynamicJsonObject^ obj
)

member Update : 
        reference : string * 
        obj : DynamicJsonObject -> OperationResult

Parameters

reference: Type: SystemString
the reference to be updated
obj: Type: Rally.RestApi.JsonDynamicJsonObject
the object fields to update

Return Value

Type: OperationResult
An OperationResult describing the status of the request

Exceptions

Exception	Condition
RallyUnavailableException	Rally returned an HTML page. This usually occurs when Rally is off-line. Please check the ErrorMessage property for more information.
RallyFailedToDeserializeJson	The JSON returned by Rally was not able to be deserialized. Please check the JsonData property for what was returned by Rally.

Examples

Copy

string rallyRef = "https://preview.rallydev.com/slm/webservice/1.40/defect/12345.js";
DynamicJsonObject toUpdate = new DynamicJsonObject(); 
toUpdate["Description"] = "This is my defect."; 
OperationResult updateResult = restApi.Update(rallyRef, toUpdate);

Reference

RallyRestApi Class

Update Overload

Rally.RestApi Namespace