RallyRestApi.GetByReference Method (String, String[])

RallyRestApiGetByReference Method (String, String)

Get 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 Object GetByReference(
	string aRef,
	params string[] fetchedFields
)

Public Function GetByReference ( 
	aRef As String,
	ParamArray fetchedFields As String()
) As Object

public:
Object^ GetByReference(
	String^ aRef, 
	... array<String^>^ fetchedFields
)

member GetByReference : 
        aRef : string * 
        fetchedFields : string[] -> Object

Parameters

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

Return Value

Type: Object
A DynamicJsonObject containing the requested object.

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.
InvalidOperationException	Occurs if authentication is not completed prior to calling this method.
ArgumentNullException	Occurs if the passed in aRef parameter is null.

Examples

Copy

string aRef = "https://preview.rallydev.com/slm/webservice/v2.0/defect/12345.js"
DynamicJsonObject item = restApi.GetByReference(aRef, "Name", "FormattedID");
string itemName = item["Name"];

Reference

RallyRestApi Class

GetByReference Overload

Rally.RestApi Namespace