RallyRestApiDelete Method (String, String) |
Delete the object described by the specified reference.
Namespace: Rally.RestApiAssembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax public OperationResult Delete(
string workspaceRef,
string aRef
)
Public Function Delete (
workspaceRef As String,
aRef As String
) As OperationResult
public:
OperationResult^ Delete(
String^ workspaceRef,
String^ aRef
)
member Delete :
workspaceRef : string *
aRef : string -> OperationResult
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:
OperationResultAn 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 workspaceRef = "/workspace/12345678910";;
string objectRef = "/defect/12345678912";
OperationResult deleteResult = restApi.Delete(workspaceRef, objectRef);
See Also