SubmitRequest Web メソッドの使用
指定されたユーザーに代わって サービス申請を作成して送信します。
リクエスト構文
パブリック FRSHEATSubmitRequestResponse SubmitRequest(文字列セッションキー、文字列テナント ID、文字列サブスクリプション ID、リスト<FRSHEATServiceReqParam> srparameters、文字列ログイン ID)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- subscriptionId: 現在のユーザーに対して提供されているリクエストに対応するサブスクリプション ID。
- srparameters: サービス申請を送信するためのパラメータのキー値を表す FRSHEATServiceReqParam オブジェクトのリスト。
- loginId: ユーザーのログイン ID。
FRSHEATServiceReqParam クラスは次のように定義されます。
パブリッククラス FRSHEATServiceReqParam
{
public string strName;
public string strValue;
}FRSHEATServiceReqParam クラスには次のフィールドがあります。
- strName: パラメータの名前。
- strValue: パラメータの値。
戻り値
FRSHEATSubmitRequestResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATSubmitRequestResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック FRSHEATServiceReqRequest 要求データ { 取得; 設定; }
}FRSHEATSubmitRequestResponse クラスには次のフィールドがあります。
- ステータス: 接続の状態に関するステータスを提供します。 以下の表には、使用可能なステータス値の詳細な説明が記載されています。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- reqData: 正常に送信された サービス申請を含む FRSHEATServiceReqRequest オブジェクトが含まれます。
FRSHEATServiceReqRequest クラスは次のように定義されます。
パブリッククラス FRSHEATServiceReqRequest
{
public string strRequestRecId;
public string strRequestNum;
公開小数点 fTotalPrice;
公開小数点 fTotalRecurPrice;
パブリック文字列 strByEmployee;
パブリック文字列 strFulfillmentPlanType;
public string strUrgency;
公開日時ですか? 提出日;
公開日時ですか? DateUpdated;
public string strUpdatedBy;
公開日時ですか? 配達日;
public string strSubscriptionRecId;
パブリック bool isFulfilled;
public string strName;
パブリック文字列 strDescription;
公開小数点fPrice;
公開小数点 fRecurPrice;
パブリック int nRecurPeriod;
パブリック int nDeliveryCommitment;
public string strStatus;
パブリック文字列 strCreatedBy;
public string strRecId;
パブリック リスト<FRSHEATServiceReqTemplateParam> lstParameters;
}FRSHEATServiceReqRequest クラスには次のフィールドがあります。
- DateDelivery: サービス申請の配信日。
- strSubscriptionRecId: サービス申請に対応するサブスクリプションの RecID。
- isFulfilled: サービス申請が満たされたかどうかを示すフラグ。
- strName: サービス申請が作成された申請項目の名前。
- strDescription: サービス申請の説明。
- fPrice: サービス申請の価格。
- fRecurPrice: サービス申請の定期価格。
- nRecurPeriod: サービス申請の繰り返し期間。
- nDeliveryCommitment: サービス申請の配信コミットメント期間。
- strStatus: サービス申請のステータス。
- strCreatedBy: サービス申請を作成したユーザーのログイン ID。
- strRecId: サービス申請の RecID。
- lstParameters: FRSHEATServiceReqTemplateParam オブジェクトのリスト。リスト内の各項目は、 サービス申請のパラメータ値を表します。
- strRequestRecId: サービス申請の RecID。
- strRequestNum: サービス申請の ID。
- fTotalPrice: サービス申請の合計非定期価格。
- fTotalRecurPrice: サービス申請の合計定期価格。
- strByEmployee: サービス申請を要求したユーザーのログイン ID。
- strFulfillmentPlanType: フルフィルメントのタイプ。
- strUrgency: サービス申請の緊急度の値。
- DateSubmitted: サービス申請が送信された日付。
- DateUpdated: サービス申請が最後に更新された日付。
- strUpdatedBy: サービス申請を最後に更新したユーザーのログイン ID。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | サービス カタログ内の申請項目のリストを正常に取得しました。 このリストは srtList フィールドで使用できます。 |
ユーザーが見つかりません | テナントには、指定されたログイン ID を持つユーザー レコードが含まれていません。 ログイン ID が正しく入力されていることを確認してください。 |
要求パラメータが満たされていない | 1 つ以上の必須パラメータが入力されていません。 exceptionReason フィールドをチェックして、どのパラメータが正しく入力されなかったかを判断します。 |
検証値の不一致 | ドロップダウン選択パラメータに渡された値は検証リストに属していません。 たとえば、部門検証リストに対して検証されるドロップダウン選択パラメータがあり、 SubmitRequest Web メソッドに「€Billing」という値が指定されているが、検証リストに「€Billing」が存在しない場合、Web メソッドはこのステータスを返します。 exceptionReason フィールドをチェックして、どのパラメータが正しく入力されなかったかを判断します。 |
パラメータタイプの不一致 | 1 つ以上のパラメータに、基になるパラメータ データ型に適さない値が指定されました。 たとえば、テキスト フィールドであるパラメーターがあり、入力が数値 (非テキスト フィールド) である場合、Web メソッドはこのステータスを返します。 exceptionReason フィールドをチェックして、どのパラメータが誤って指定されたかを判断します。 |
エラー | この Web メソッドの実行中にエラーが発生しました。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 |
サービス申請送信の検証について
サービス申請を送信する前に、 SubmitRequest Web メソッドは次の 3 種類の検証を実行します。
- 必須パラメータ: 必須としてマークされたすべてのパラメータが入力されていることを確認します。
現在、コードは無条件の必須パラメータと単純な条件付き必須パラメータを処理します。 1 つ以上の必須パラメータが正しく入力されていない場合、 SubmitRequest Web メソッドは ReqParamsNotFilledのステータスを返します。 exceptionReason フィールドをチェックして、どのパラメータが正しく入力されなかったかを判断します。
- 検証値: 検証リスト テーブル内の既存のレコードに基づいて、指定された値が許容値であることを確認します。
現在、コードは、通常の検証 (つまり、単一のフィールドに対する検証) と単純な制約付き検証 (つまり、以前のフィールドの値に基づいて制約される検証) を処理します。 検証を満たさないパラメータが 1 つ以上ある場合、 SubmitRequest Web メソッドは ValidationValuesMismatchのステータスを返します。 exceptionReason フィールドをチェックして、どのパラメータが正しく入力されなかったかを判断します。
- パラメータ型のチェック: 指定されたパラメータのデータ型に対して、提供された値が適切であることを確認します。
対応するパラメータ タイプと一致しない値が 1 つ以上ある場合、 SubmitRequest Web メソッドは ParameterTypeMismatchのステータスを返します。 exceptionReason フィールドをチェックして、どのパラメータが誤って指定されたかを判断します。
サービス申請のパラメータの型チェック
サービス申請を送信する前に、 SubmitRequest Web メソッドは、値のデータ型をそれぞれのパラメータのデータ型と比較します。
次の表は、さまざまなパラメータ タイプをまとめたものです。 データ型の検証が実行された場合、詳細セクションでこの情報がさらに詳しく説明されます。
データタイプ | 詳細 |
|---|---|
文章 | 現在検証されていません。 これは現在のサービス カタログの動作と一致します。 |
チェックボックス | 許可される値は、true または false として解析できる値です。 Microsoft .NET の Boolean.TryParse() メソッドを使用して、チェックボックスの値が有効かどうかを判断します。 |
日付 / 時刻 / 日時 | 許可される値は、DateTime 値として解析できる値です。 Microsoft .NET の DateTime.TryParse() メソッドを使用して、日付、時刻、または DateTime の値が有効かどうかを判断します。 DateTime 値を指定するには、ISO 8601 形式を使用して文字列値を指定します。 値は UTC を基準にする必要があります。 DateTime 値は、次の 2 つの方法のいずれかで指定できます。 yyyy-mm-dd 時:mm yyyy-mm-dd木:mm 日付と時刻の値を区切るには、スペース文字または「€œT」€ 文字を使用します。 以下は、上記の 2 つの形式を使用して、2013 年 3 月 26 日 18:38 UTC の DateTime 値を指定する 2 つの例です。 2013-03-26 18:38 2013-03-26T18:38 |
数字 / お金 | 許可される値は、小数値として解析できる値です。 数値が有効かどうかを判別するには、Microsoft .NET の Decimal.TryParse() メソッドを使用します。 |
電話 | 許可される値は、(415) 555-1212 などの米国の電話番号に一致する電話番号です。 これは現在のサービス カタログの動作と一致します。 国際電話番号の検証にはこのパラメータ タイプを使用しないでください。 |
社会保障番号 | 許可される値は、123-45-6789 など、米国の社会保障番号の形式に一致する数字です。 |
メール | 現在検証されていません。 これは現在のサービス カタログの動作と一致します。 |
メールアドレス | 現在検証されていません。 これは現在のサービス カタログの動作と一致します。 |
例
文字列 strSubscrRecId = frSvc.GetSubscriptionId(authSessionKey, tenantId, "ドメイン パスワード リセット").subscriptionId;
リスト<FRSHEATServiceReqParam> srparamListItems = newList<FRSHEATServiceReqParam>();
srparamListItems.Add(newFRSHEATServiceReqParam
{
strName = "RequesterDepartment",
strValue = "IT"
});
srparamListItems.Add(newFRSHEATServiceReqParam
{
strName = "Requester",
strValue = "Ashley Simon"
});
FRSHEATSubmitRequestResponse srResponse = frSvc.SubmitRequest(authSessionKey、tenantId、strSubscrRecId、srparamListItems.ToArray()、loginId);
FRSHEATServiceReqRequest srres;
if (srResponse.status == "成功")
{
srres = srResponse.reqData;
}
それ以外
{
(srResponse.exceptionReason != null) の場合
{
Console.WriteLine("エラー: " srResponse.exceptionReason);
}
}