RallyRestApiDelete Method (String, String, Int64) |
Delete the object described by the specified type and object id.
Namespace: Rally.RestApiAssembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntaxpublic OperationResult Delete(
string workspaceRef,
string typePath,
long oid
)
Public Function Delete (
workspaceRef As String,
typePath As String,
oid As Long
) As OperationResult
public:
OperationResult^ Delete(
String^ workspaceRef,
String^ typePath,
long long oid
)
member Delete :
workspaceRef : string *
typePath : string *
oid : int64 -> OperationResult
Parameters
- workspaceRef
- Type: SystemString
the workspace from which the object will be deleted. Null means that the server will pick a workspace. - typePath
- Type: SystemString
the type - oid
- Type: SystemInt64
the object id
Return Value
Type:
OperationResultAn OperationResult with information on the status of the request
ExceptionsException | 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. |
Examplesstring workspaceRef = "/workspace/12345678910";
long objectID = 12345678912L;
OperationResult deleteResult = restApi.Delete(workspaceRef, "Defect", objectID);
See Also