Click or drag to resize
RallyRestApiDelete Method (String, String)
Delete the object described by the specified reference.

Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
public OperationResult Delete(
	string workspaceRef,
	string aRef
)

Parameters

workspaceRef
Type: SystemString
the workspace from which the object will be deleted. Null means that the server will pick a workspace.
aRef
Type: SystemString
the reference

Return Value

Type: OperationResult
An OperationResult with information on 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#
string workspaceRef = "/workspace/12345678910";;
string objectRef = "/defect/12345678912";
OperationResult deleteResult = restApi.Delete(workspaceRef, objectRef);
See Also