RallyRestApiRemoveFromCollection Method |
Remove items from a collection
Namespace: Rally.RestApiAssembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntaxpublic OperationResult RemoveFromCollection(
string itemRef,
string collectionName,
List<DynamicJsonObject> items,
NameValueCollection parameters
)
Public Function RemoveFromCollection (
itemRef As String,
collectionName As String,
items As List(Of DynamicJsonObject),
parameters As NameValueCollection
) As OperationResult
public:
OperationResult^ RemoveFromCollection(
String^ itemRef,
String^ collectionName,
List<DynamicJsonObject^>^ items,
NameValueCollection^ parameters
)
member RemoveFromCollection :
itemRef : string *
collectionName : string *
items : List<DynamicJsonObject> *
parameters : NameValueCollection -> OperationResult
Parameters
- itemRef
- Type: SystemString
The ref of the object to update e.g. /defect/12345 - collectionName
- Type: SystemString
The name of the collection to be updated e.g. Tasks - items
- Type: System.Collections.GenericListDynamicJsonObject
The items to remove. - parameters
- Type: System.Collections.SpecializedNameValueCollection
additional query string parameters to be included on the request
Return Value
Type:
OperationResultAn
OperationResult describing the status of the request
ExamplesDynamicJsonObject existingTask = new DynamicJsonObject();
existingTask["_ref"] = "/task/23456";
NameValueCollection parameters = new NameValueCollection();
List{DynamicJsonObject} itemsToRemove = new List{DynamicJsonObject}() { existingTask };
OperationResult updateResult = restApi.RemoveFromCollection("/defect/12345", "Tasks", itemsToRemove, parameters);
See Also