RallyRestApiUpdate Method (String, String, DynamicJsonObject, NameValueCollection) |
Update the item described by the specified type and object id with
the fields of the specified object
Namespace: Rally.RestApiAssembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax public OperationResult Update(
string typePath,
string oid,
DynamicJsonObject obj,
NameValueCollection parameters
)
Public Function Update (
typePath As String,
oid As String,
obj As DynamicJsonObject,
parameters As NameValueCollection
) As OperationResult
public:
OperationResult^ Update(
String^ typePath,
String^ oid,
DynamicJsonObject^ obj,
NameValueCollection^ parameters
)
member Update :
typePath : string *
oid : string *
obj : DynamicJsonObject *
parameters : NameValueCollection -> OperationResult
Parameters
- typePath
- Type: SystemString
the type of the item to be updated - oid
- Type: SystemString
the object id of the item to be updated - obj
- Type: Rally.RestApi.JsonDynamicJsonObject
the object fields to update - parameters
- Type: System.Collections.SpecializedNameValueCollection
additional query string parameters to be include on the request
Return Value
Type:
OperationResultAn
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 DynamicJsonObject toUpdate = new DynamicJsonObject();
toUpdate["Description"] = "This is my defect.";
NameValueCollection parameters = new NameValueCollection();
parameters["rankAbove"] = "/defect/23456";
OperationResult updateResult = restApi.Update("defect", "12345", toUpdate, parameters);
See Also