RallyRestApiGetSubscription Method |
Get the current subscription
Namespace: Rally.RestApiAssembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax public Object GetSubscription(
params string[] fetchedFields
)
Public Function GetSubscription (
ParamArray fetchedFields As String()
) As Object
public:
Object^ GetSubscription(
... array<String^>^ fetchedFields
)
member GetSubscription :
fetchedFields : string[] -> Object
Parameters
- fetchedFields
- Type: SystemString
An optional list of fields to be fetched
Return Value
Type:
ObjectA
DynamicJsonObject that contains the currently logged in user.
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 DynamicJsonObject subscription = restApi.GetSubscription("Name", "FormattedID");
string subscriptionName = subscription["Name"];
string subscriptionFormattedID = subscription["FormattedID"];
See Also