GetCategories Web メソッドの使用
5 min
サービス カタログで使用可能なカテゴリのリストを返します。
リクエスト構文
publicFRSHEATGetCategoriesResponse GetCategories(string sessionKey, string tenantId)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
戻り値
FRSHEATGetCategoriesResponse オブジェクトは次のように定義されます。
パブリッククラスFRSHEATGetCategoriesResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック リスト<FRSHEATServiceReqCategory> srCategories { get; set; }
}FRSHEATIntegrationFindBOResponse クラスには次のフィールドがあります。
- ステータス: 接続の状態に関するステータスを提供します。 以下の表には、使用可能なステータス値の詳細な説明が記載されています。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- srCategories: FRSHEATServiceReqCategory オブジェクトのリストが含まれます。各オブジェクトはサービス カタログ内のカテゴリ値を表します。
FRSHEATServiceReqCategory クラスは次のように定義されます。
パブリッククラス FRSHEATServiceReqCategory
{
public string strRecId;
public string strName;
パブリック文字列 strDescription;
}FRSHEATServiceReqCategory クラスには次のフィールドがあります。
- strRecId: カテゴリ値に対応する RecID。
- strName: カテゴリの名前。
- strDescription: カテゴリの説明。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | サービス カタログ内のカテゴリのリストを正常に取得しました。 このリストは srCategories フィールドで使用できます。 |
エラー | この Web メソッドの実行中にエラーが発生しました。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 |
例
FRSHEATGetCategoriesResponse getCategoriesResponse = frSvc.GetCategories(authSessionKey, tenantId);
if (getCategoriesResponse.status == "成功")
{
foreach (FRSHEATServiceReqCategory srCategory in getCategoriesResponse.srCategories)
{
Console.WriteLine("カテゴリ: {0}", srCategory.strName);
}
}