GetPackageData Web メソッドの使用
5 min
指定された申請項目の詳細を返します。
リクエスト構文
publicFRSHEATGetPackageDataResponse GetPackageData(string sessionKey, string tenantId, string strSubscrRecId)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- strSubscrRecId: 現在のユーザーに対して提供されているリクエストに対応するサブスクリプション ID。
戻り値
FRSHEATGetPackageDataResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATGetPackageDataResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック FRSHEATServiceReqSubscription srSubscription { 取得; 設定; }
}FRSHEATGetPackageDataResponse クラスには次のフィールドがあります。
- ステータス: 接続の状態に関するステータスを提供します。 以下の表には、使用可能なステータス値の詳細な説明が記載されています。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- srSubscription: 申請項目の完全な詳細 (パラメータの詳細など) を含む FRSHEATServiceReqSubscription オブジェクトが含まれます。
FRSHEATServiceReqSubscription クラスは次のように定義されます。
パブリッククラス FRSHEATServiceReqSubscription
{
public string strSubscriptionRecId;
パブリック文字列 strDateSubscribed;
public string strOrgUnitId;
public string strName;
パブリック文字列 strDescription;
public string strServiceName;
public string strRecId;
パブリック リスト<FRSHEATServiceReqTemplateParam> lstParameters;
}FRSHEATServiceReqTemplateListItem クラスには次のフィールドがあります。
- strSubscriptionRecId: 現在のユーザーに対して提供されているリクエストに対応するサブスクリプション ID。
- strDateSubscribed: 申請項目が公開およびサブスクライブ済みとしてマークされた日付。
- strOrgUnitId: 申請項目が関連付けられている組織単位の RecID。
- strName: 申請項目の名前。
- strDescription: 申請項目の説明値。
- strServiceName: 申請項目が関連付けられているサービスの名前。
- strRecId: 申請項目の RecID。
- lstParameters: FRSHEATServiceReqTemplateParam オブジェクトのリスト。各項目は申請項目内のパラメータを表します。
FRSHEATServiceReqTemplateParam クラスは次のように定義されます。
パブリッククラス FRSHEATServiceReqTemplateParam
{
public string strName;
public string strLabel;
パブリック文字列 strDescription;
public string strType;
パブリック bool bAllowSelectByUser;
パブリック bool bDBValidated;
public string strRequiredExpression;
パブリック bool isCalculated;
空の場合にのみ autoFillOnly を public bool で指定します。
public string strValidationListRecId;
public string strValidationListTableRef;
パブリック bool bIsHidden;
public string strRecId;
パブリック リスト<ValidationConstraint> validationConstraints;
public string strValidationConstraints;
パブリック文字列 strAutoFillExpression;
パブリック リスト<string> triggerFields;
public string strTriggerFields;
パブリック文字列 strDefaultValue;
}FRSHEATServiceReqTemplateListItem クラスには次のフィールドがあります。
- strName: パラメータの名前。
- strLabel: パラメータのラベル。
- strDescription: パラメータの説明。
- strType: パラメータの型。
- bAllowSelectByUser: ユーザーがパラメータを選択できるかどうかを示すフラグ。
- bDBValidated: パラメータが検証されているかどうかを示すフラグ。
- strRequiredExpression: パラメータが(条件付きで)必須であるかどうかを示す式。
- isCalculated: パラメータが計算されるかどうか (つまり、ユーザーからの入力を受け取らないかどうか) を示すフラグ。
- autoFillOnlyWhenEmpty: パラメータが最初に空の場合に、パラメータの自動入力が行われるかどうかを示すフラグ。
- strValidationListRecId: パラメータがドロップダウン選択の場合、名前付き検証リスト (選択リストなど) の RecID。
- strValidationListTableRef: ドロップダウン選択のドロップダウン値が取得されるビジネス オブジェクトの名前。
- bIsHidden: パラメータが非表示かどうかを示すフラグ。
- strRecId: リクエスト提供パラメータの RecID。
- validationConstraints: パラメータに現在設定されている検証制約を表すために使用される検証制約オブジェクトのリスト。
- strValidationConstraints: validationConstraints メンバーのテキスト表現。
- strAutoFillExpression: 自動入力式のテキスト表現。
- triggerFields: 現在のパラメータが依存する依存パラメータのリスト。
- strTriggerFields: triggerFields メンバーのテキスト表現。
- strDefaultValue: パラメータのデフォルト値のテキスト表現。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | 申請項目の詳細を正常に取得しました。 このリストは、 srSubscription フィールドで使用できます。 |
見つかりません | テナントには、指定されたサブスクリプション ID を持つ申請項目が含まれていません。 申請項目のサブスクリプション ID が正しく入力されていることを確認します。 GetSubscriptionId Web メソッドは、現在のユーザーに対応するサブスクリプション ID を返すために使用されることに注意してください。 |
エラー | この Web メソッドの実行中にエラーが発生しました。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 |
例
FRSHEATGetPackageDataResponse getPackageDataResponse = frSvc.GetPackageData(authSessionKey, tenantId, strSubscrRecId);
FRSHEATServiceReqSubscription scsrs;
if (getPackageDataResponse.status == "成功")
{
scsrs = getPackageDataResponse.srSubscription;
// 先に進み、申請項目から興味のある関連プロパティにアクセスします。
}