Click or drag to resize
RallyRestApiGetByReferenceAndWorkspace Method
Get the object described by the specified reference scoped to the provided workspace.

Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
public Object GetByReferenceAndWorkspace(
	string aRef,
	string workspaceRef,
	params string[] fetchedFields
)

Parameters

aRef
Type: SystemString
the reference
workspaceRef
Type: SystemString
workspace scope
fetchedFields
Type: SystemString
the list of object fields to be fetched

Return Value

Type: Object
A DynamicJsonObject containing the requested object.
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 aRef = "https://preview.rallydev.com/slm/webservice/v2.0/defect/12345.js"
string workspaceRef = "/workspace/12345678910";
DynamicJsonObject item = restApi.GetByReference(aRef, workspaceRef, "Name", "FormattedID");
string itemName = item["Name"];
See Also