RallyRestApi.Delete Method (String)

RallyRestApiDelete Method (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 aRef
)

Public Function Delete ( 
	aRef As String
) As OperationResult

public:
OperationResult^ Delete(
	String^ aRef
)

member Delete : 
        aRef : string -> OperationResult

Type: OperationResult
An OperationResult with information on 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

string objectRef = "/defect/12345678912";
OperationResult deleteResult = restApi.Delete(objectRef);