RallyRestApiGetByReferenceAndWorkspace Method |
Get the object described by the specified reference scoped to the provided workspace.
Namespace: Rally.RestApiAssembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntaxpublic Object GetByReferenceAndWorkspace(
string aRef,
string workspaceRef,
params string[] fetchedFields
)
Public Function GetByReferenceAndWorkspace (
aRef As String,
workspaceRef As String,
ParamArray fetchedFields As String()
) As Object
public:
Object^ GetByReferenceAndWorkspace(
String^ aRef,
String^ workspaceRef,
... array<String^>^ fetchedFields
)
member GetByReferenceAndWorkspace :
aRef : string *
workspaceRef : string *
fetchedFields : string[] -> Object
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:
ObjectA
DynamicJsonObject containing the requested object.
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 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