ウェブメソッド
以下のセクションでは、これらの詳細について説明します。
サービス申請の登録に関する重要なお知らせ
API 経由でさまざまなサービス カタログ Web メソッドにアクセスする場合、ほとんどの Web メソッドは、申請項目自体の ID ではなく、 サービス申請 サブスクリプション レコードの ID に基づいて呼び出されることに注意してください。
申請項目を定義するときに、ユーザーはそれを「公開およびサブスクライブ」として構成するか、「公開」として構成するかを指定する必要があることに注意してください。

- 公開およびサブスクライブとして構成すると、指定された組織単位およびそれ以下の組織単位に属するユーザーが申請項目にアクセスできます。
- 公開済みとして構成すると、ユーザーは、所属する組織単位のサービス レベル契約 (SLA) に基づいて、申請項目にアクセスできるようになります。
ServiceReqSubscription レコード (サービス カタログによって内部的に使用) には、申請項目に関連付けられている組織単位に関する情報と、SLA に関連して構成されている場合は SLA 情報が含まれます。
次のセクションでは、いくつかの Web メソッドが ServiceReqSubscription レコードの Id 値 を使用します。 このため、 GetSubscriptionId() というヘルパー Web メソッドを使用してサブスクリプション ID を取得し、その後の SubmitRequest() などの操作で使用することができます。
カテゴリーを取得
サービス カタログで利用可能なカテゴリのリストを取得します。
リクエスト構文:
パブリック FRSHEATGetCategoriesResponse GetCategories(文字列セッションキー、文字列テナント ID)パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント。
戻り値:
次のように定義される FRSHEATGetCategoriesResponse オブジェクト:
public class FRSHEATGetCategoriesResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック リスト<FRSHEATServiceReqCategory> srCategories { get; set; }
}
FRSHEATIntegrationFindBOResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- srCategories – FRSHEATServiceReqCategory オブジェクトのリスト。各オブジェクトはサービス カタログ内のカテゴリ値を表します。
FRSHEATServiceReqCategory クラスは次のように定義されます。
public class FRSHEATServiceReqCategory
{
パブリック文字列 strRecId;
パブリック文字列 strName;
パブリック文字列 strDescription;
}
FRSHEATServiceReqCategory クラスは次のフィールドで構成されます。
- strRecId – カテゴリ値に対応する RecId
- strName – カテゴリの名前
- strDescription – カテゴリの説明
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | サービス カタログ内のカテゴリのリストは正常に取得でき、srCategories リストから利用できます。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
FRSHEATGetCategoriesResponse getCategoriesResponse = frSvc.GetCategories(authSessionKey, tenantId);
if (getCategoriesResponse.status == "Success")
{
foreach (FRSHEATServiceReqCategory srCategory in getCategoriesResponse.srCategories)
{
Console.WriteLine("Category: ", srCategory.strName);
}
}
カテゴリテンプレートの取得
指定されたカテゴリに属するサービスカタログ内のリクエストオファリングのリストを取得します。
リクエスト構文:
パブリック FRSHEATGetTemplatesResponse GetCategoryTemplates(文字列セッションキー、文字列テナント ID、文字列カテゴリ ID、文字列検索文字列)パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント。
- categoryId: GetCategories Webメソッドを介して取得されたサービスカタログ内のカテゴリのRecId
- searchString: 一致するリクエストオファリングを決定するための部分文字列
戻り値:
次のように定義される FRSHEATGetTemplatesResponse オブジェクト:
public class FRSHEATGetTemplatesResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック リスト<FRSHEATServiceReqTemplateListItem> srtList { 取得; 設定; }
}
FRSHEATGetTemplatesResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- srtList – FRSHEATServiceReqTemplateListItem オブジェクトのリスト。各オブジェクトは検索条件に一致する申請項目を表します。
FRSHEATServiceReqTemplateListItem クラスは次のように定義されます。
public class FRSHEATServiceReqTemplateListItem
{
パブリック文字列 strRecId;
パブリック文字列 strName;
パブリック文字列 strDescription;
パブリック文字列 strSubscriptionId;
}
FRSHEATServiceReqTemplateListItem クラスは次のフィールドで構成されます。
- strRecId – リクエストオファリングに対応するRecId
- strName – リクエストオファリングの名前
- strDescription – リクエストオファリングの説明
- strSubscriptionId – サブスクリプションID
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | サービス カタログ内の一致する申請項目のリストは正常に取得でき、srtList メンバーを介して利用できます。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
FRSHEATGetTemplatesResponse getTemplatesResponse = frSvc.GetCategoryTemplates(authSessionKey, tenantId, categoryid, searchString);
if (getTemplatesResponse.status == "Success")
{
foreach (FRSHEATServiceReqTemplateListItem srTemplateListItem in getTemplatesResponse.srtList)
{
Console.WriteLine("Request Offering: ", srTemplateListItem.strSubscriptionId, srTemplateListItem.strName);
}
}
すべてのテンプレートを取得
サービスカタログでリクエストオファリングの完全なリストを取得します
リクエスト構文:
パブリック FRSHEATGetTemplatesResponse GetAllTemplates(文字列セッションキー、文字列テナント ID)
パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント。
戻り値:
次のように定義される FRSHEATGetTemplatesResponse オブジェクト:
public class FRSHEATGetTemplatesResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック リスト<FRSHEATServiceReqTemplateListItem> srtList { 取得; 設定; }
}
FRSHEATGetTemplatesResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- srtList – FRSHEATServiceReqTemplateListItem オブジェクトのリスト。各オブジェクトは検索条件に一致する申請項目を表します。
FRSHEATServiceReqTemplateListItem クラスは次のように定義されます。
public class FRSHEATServiceReqTemplateListItem
{
パブリック文字列 strRecId;
パブリック文字列 strName;
パブリック文字列 strDescription;
パブリック文字列 strSubscriptionId;
}
FRSHEATServiceReqTemplateListItem クラスは次のフィールドで構成されます。
- strRecId – リクエストオファリングに対応するRecId
- strName – リクエストオファリングの名前
- strDescription – リクエストオファリングの説明
- strSubscriptionId – サブスクリプション ID
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | サービス カタログ内の一致する申請項目のリストは正常に取得でき、srtList メンバーを介して利用できます。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
FRSHEATGetTemplatesResponse getTemplatesResponse = frSvc.GetAllTemplates(authSessionKey, tenantId);
if (getTemplatesResponse.status == "Success")
{
foreach (FRSHEATServiceReqTemplateListItem srTemplateListItem in getTemplatesResponse.srtList)
{
Console.WriteLine("Request Offering: ", srTemplateListItem.strSubscriptionId, srTemplateListItem.strName);
}
}
サブスクリプションIDの取得
現在のユーザーのリクエストオファリングに対応するサブスクリプションIDを取得します
リクエスト構文:
パブリック FRSHEATGetSubscriptionIdResponse GetSubscriptionId(文字列セッションキー、文字列テナント ID、文字列名)パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント。
- 名前: リクエストオファリングの名前
戻り値:
次のように定義される FRSHEATGetSubscriptionIdResponse オブジェクト:
public class FRSHEATGetSubscriptionIdResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック文字列サブスクリプションID { 取得; 設定; }
}
FRSHEATGetSubscriptionIdResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- subscriptionId – 現在のユーザーの申請項目に対応するサブスクリプション ID。
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | 指定されたリクエストオファリングのサブスクリプションIDは、subscriptionIdメンバーを介してアクセスできます。 |
見つかりません | テナント内に指定された名前で利用可能な申請項目がありません。申請項目の名前が正しく入力されていることを確認してください。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
FRSHEATGetSubscriptionIdResponse subscriptionIdResponse = frSvc.GetSubscriptionId(authSessionKey, tenantId, offeringName);
string offeringname = "Domain Password Reset";
if (subscriptionIdResponse.status == "Success")
{
string subscriptionId = subscriptionIdResponse.subscriptionId;
Console.WriteLine("\\"\\" 申請項目のサブスクリプション ID は "、offeringName、subscriptionId);
}
パッケージデータを取得
指定されたリクエストオファリングの詳細を取得します
リクエスト構文:
パブリック FRSHEATGetPackageDataResponse GetPackageData(文字列 sessionKey、文字列 tenantId、文字列 strSubscrRecId)パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント。
- strSubscrRecId: 現在のユーザーの申請項目に対応するサブスクリプション ID
戻り値:
次のように定義される FRSHEATGetPackageDataResponse オブジェクト:
public class FRSHEATGetPackageDataResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
public FRSHEATServiceReqSubscription srSubscription { get; set; }
}
FRSHEATGetPackageDataResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- srSubscription – 申請項目の詳細 (パラメータの詳細など) を含む FRSHEATServiceReqSubscription オブジェクト
FRSHEATServiceReqSubscription クラスは次のように定義されます。
public class FRSHEATServiceReqSubscription
{
パブリック文字列 strSubscriptionRecId;
パブリック文字列 strDateSubscribed;
パブリック文字列 strOrgUnitId;
パブリック文字列 strName;
パブリック文字列 strDescription;
パブリック文字列 strServiceName;
パブリック文字列 strRecId;
パブリック リスト<FRSHEATServiceReqTemplateParam> lstParameters;
}
FRSHEATServiceReqTemplateListItem クラスは次のフィールドで構成されます。
- strSubscriptionRecId – 現在のユーザーの申請項目に対応するサブスクリプション ID
- strDateSubscribed – 申請項目が公開済みおよびサブスクライブ済みとしてマークされた日付
- strOrgUnitId – 申請項目が関連付けられている OrganizationalUnit の RecId
- strName – リクエストオファリングの名前
- strDescription – リクエストオファリングの説明値
- strServiceName – 申請項目が関連付けられているサービスの名前
- strRecId – 申請項目の RecId
- lstParameters – FRSHEATServiceReqTemplateParam オブジェクトのリスト。各項目は申請項目のパラメータを表します。
FRSHEATServiceReqTemplateParam クラスは次のように定義されます。
public class FRSHEATServiceReqTemplateParam
{
パブリック文字列 strName;
パブリック文字列 strLabel;
パブリック文字列 strDescription;
パブリック文字列 strType;
パブリック bool bAllowSelectByUser;
パブリック bool bDBValidated;
パブリック文字列 strRequiredExpression;
パブリック bool isCalculated;
空の場合にのみ autoFillOnly を public bool で指定します。
パブリック文字列 strValidationListRecId;
パブリック文字列 strValidationListTableRef;
パブリック bool bIsHidden;
パブリック文字列 strRecId;
パブリック リスト<ValidationConstraint> validationConstraints;
パブリック文字列 strValidationConstraints;
パブリック文字列 strAutoFillExpression;
パブリック リスト<string> triggerFields;
パブリック文字列 strTriggerFields;
パブリック文字列 strDefaultValue;
}
FRSHEATServiceReqTemplateListItem クラスは次のフィールドで構成されます。
- strName – パラメータの名前
- strLabel – パラメータのラベル
- strDescription – パラメータの説明
- strType – パラメータの型
- bAllowSelectByUser – パラメータをユーザーが選択できるかどうかを示すフラグ
- bDBValidated – パラメータが検証されているかどうかを示すフラグ
- strRequiredExpression – パラメータが(条件付きで)必須であるかどうかを示す式
- isCalculated – パラメータが計算されているかどうかを示すフラグ(つまり ユーザーからの入力は受け付けません)
- autoFillOnlyWhenEmpty – パラメータが最初に空の場合に、パラメータの自動入力が行われるかどうかを示すフラグ
- strValidationListRecId – 名前付き検証リストのRecId(つまり パラメータがドロップダウン選択の場合、選択リスト
- strValidationListTableRef – ドロップダウン選択のドロップダウン値が取得されるビジネスオブジェクトの名前
- bIsHidden – パラメータが非表示かどうかを示すフラグ
- strRecId – 申請項目 パラメータの RecId
- validationConstraints – ValidationConstraint オブジェクトのリスト。パラメータに現在設定されている検証制約を表すために使用されます。
- strValidationConstraints – validationConstraints メンバーのテキスト表現
- strAutoFillExpression – オートフィル式のテキスト表現
- triggerFields – 現在のパラメータが依存する依存パラメータのリスト
- strTriggerFields – triggerFields メンバーのテキスト表現
- strDefaultValue – パラメータのデフォルト値のテキスト表現
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | リクエストオファーの詳細は正常に取得でき、srSubscriptionメンバーを介してアクセスできます。 |
見つかりません | テナント内に指定されたサブスクリプション ID で利用できる申請項目がありません。申請項目の ID が正しく指定されていることを確認してください。 GetSubscriptionId Webメソッドは、現在のユーザーに対応するサブスクリプションIDを取得するために使用されることを思い出してください。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
FRSHEATGetPackageDataResponse getPackageDataResponse = frSvc.GetPackageData(authSessionKey, tenantId, strSubscrRecId);
FRSHEATServiceReqSubscription scsrs;
if (getPackageDataResponse.status == "Success")
{
scsrs = getPackageDataResponse.srSubscription;
// 先に進み、申請項目から興味のある関連プロパティにアクセスします。
}
ユーザーアクセスリクエストの提供
現在のユーザーが指定されたリクエストオファーにアクセスする権限を持っているかどうかを確認します
リクエスト構文:
public FRSHEATUserCanAccessReqOfferingResponse UserCanAccessRequestOffering(string sessionKey, string tenantId, string loginId, string reqOfferingName)パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント。
- loginId: ユーザーのログインID
- reqOfferingName: 申請項目の名前
戻り値:
次のように定義される FRSHEATUserCanAccessReqOfferingResponse オブジェクト:
public class FRSHEATUserCanAccessReqOfferingResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック bool canAccess { 取得; 設定; }
}
FRSHEATUserCanAccessReqOfferingResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- canAccess – ユーザーが指定されたリクエストオファーにアクセスする権限があるかどうかを示すブールフィールド
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | 指定されたユーザーと申請項目はテナント内で正常に見つかります。その後、canAccess フィールドをチェックして、指定されたユーザーが申請項目にアクセスする権限があるかどうかを判断できます。 |
ユーザーが見つかりません | 指定された LoginID 値を持つユーザー レコードがテナント内に見つかりません。 渡されたLoginID値を確認し、正しいスペルであることを確認します。 |
提供が見つかりません | 指定された名前の申請項目が見つかりません。 渡されたリクエストオファリングの名前をチェックして、正しいスペルであることを確認します。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
string loginId = "ASimon";
string reqOfferingName = "Domain Password Reset";
FRSHEATUserCanAccessReqOfferingResponse canAccessReqOfferingResponse = frSvc.UserCanAccessRequestOffering(sessionKey, tenantId, loginId, reqOfferingName);
if (canAccessReqOfferingResponse.status == "Success")
{
(canAccessReqOfferingResponse.canAccess) の場合
{
Console.WriteLine("User can access the Request Offering ", loginId, reqOfferingName);
}
それ以外
{
Console.WriteLine("User has no access to the Request Offering ", loginId, reqOfferingName);
}
}
リクエストを送信
特定のユーザーに代わってサービス申請を作成して送信します。
リクエスト構文:
パブリック FRSHEATSubmitRequestResponse SubmitRequest(文字列セッションキー、文字列テナント ID、文字列サブスクリプション ID、リスト<FRSHEATServiceReqParam> srparameters、文字列ログイン ID)パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント
- subscriptionId: 現在のユーザーの申請項目に対応するサブスクリプション ID
- srparameters: サービス申請の送信用のパラメータのキー/値を表す FRSHEATServiceReqParam オブジェクトのリスト
- loginId: ユーザーのログインID
FRSHEATServiceReqParam クラスは次のように定義されます。
public class FRSHEATServiceReqParam
{
パブリック文字列 strName;
パブリック文字列 strValue;
}
FRSHEATServiceReqParam クラスは次のフィールドで構成されます。
strName: パラメータの名前
strValue: パラメータの値
戻り値:
次のように定義される FRSHEATSubmitRequestResponse オブジェクト:
public class FRSHEATSubmitRequestResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
public FRSHEATServiceReqRequest reqData { get; set; }
}
FRSHEATSubmitRequestResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- reqData – 正常に送信されたサービス申請を含む FRSHEATServiceReqRequest オブジェクト
FRSHEATServiceReqRequest クラスは次のように定義されます。
public class FRSHEATServiceReqRequest
{
パブリック文字列 strRequestRecId;
パブリック文字列 strRequestNum;
公開小数点 fTotalPrice;
公開小数点 fTotalRecurPrice;
パブリック文字列 strByEmployee;
パブリック文字列 strFulfillmentPlanType;
パブリック文字列 strUrgency;
公開日時ですか? 提出日;
公開日時ですか? DateUpdated;
パブリック文字列 strUpdatedBy;
公開日時ですか? 配達日;
パブリック文字列 strSubscriptionRecId;
パブリック bool isFulfilled;
パブリック文字列 strName;
パブリック文字列 strDescription;
公開小数点fPrice;
公開小数点 fRecurPrice;
パブリック int nRecurPeriod;
パブリック int nDeliveryCommitment;
パブリック文字列 strStatus;
パブリック文字列 strCreatedBy;
パブリック文字列 strRecId;
パブリック リスト<FRSHEATServiceReqTemplateParam> lstParameters;
}
FRSHEATServiceReqRequest クラスは次のフィールドで構成されます。
- strRequestRecId – サービス申請のRecId
- strRequestNum – サービス申請のID
- fTotalPrice – サービス申請の合計非定期価格
- fTotalRecurPrice – サービス申請の合計定期価格
- strByEmployee - サービス申請のリクエスト者のログインID
- strFulfillmentPlanType – フルフィルメントのタイプ
- strUrgency – サービス申請の緊急度の値
- DateSubmitted – サービス申請が送信された日付
- DateUpdated - サービス申請が最後に更新された日付
- strUpdatedBy – サービス申請を最後に更新したユーザーのログインID
- DateDelivery – サービス申請の配達日
- strSubscriptionRecId – サービス申請に対応するサブスクリプションのRecId
- isFulfilled – サービス申請が満たされたかどうかを示すフラグ
- strName – サービス申請が作成されたリクエストオファリングの名前
- strDescription – サービス申請の説明
- fPrice – サービス申請の価格
- fRecurPrice – サービス申請の定期料金
- nRecurPeriod – サービス申請の繰り返し期間
- nDeliveryCommitment – サービス申請の配信コミットメント期間
- strStatus – サービス申請のステータス
- strCreatedBy - サービス申請を作成したユーザーのログインID
- strRecId – サービス申請のRecId
- lstParameters – FRSHEATServiceReqTemplateParam オブジェクトのリスト。リスト内の各項目はサービス申請のパラメータ値を表します。
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | サービス カタログ内の一致する申請項目のリストは正常に取得でき、srtList メンバーを介して利用できます。 |
ユーザーが見つかりません | 指定された LoginID 値を持つユーザー レコードがテナント内に見つかりません。 渡されたLoginID値を確認し、正しいスペルであることを確認します。 |
要求パラメータが満たされていない | 1 つ以上の必須パラメータが入力されていません。 exceptionReason メンバーをチェックして、どの必須パラメータが正しく入力されていないかを判断します。 |
検証値の不一致 | ドロップダウン選択パラメータに渡された値は、検証リストに属していません。 たとえば、Departments 検証リストに対して検証されるドロップダウン選択パラメータがあるとします。 SubmitRequest Web メソッドに「Billing」という値が指定されているが、検証リストに「Billing」が存在しない場合は、この場合の返されるステータスは「ValidationValuesMismatch」になります。 exceptionReasonメンバーをチェックして、検証されたどのパラメータに適切な値が入力されていないかを判断します。 |
パラメータタイプの不一致 | 1 つ以上のパラメータに、基になるパラメータ データ型に適さない値が指定されました。 たとえば、テキスト フィールド パラメータ タイプを使用して、さまざまな種類の値を保存できます。 パラメータのデータ型が Number で、パラメータにテキスト値が指定されている場合、この場合の戻りステータスは「ParameterTypeMismatch」になります。 exceptionReason メンバーをチェックして、どの特定のパラメータに誤った型の値が指定されたかを判断します。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
サービス申請の送信の検証
サービス申請を送信する前に、SubmitRequest Web メソッドは次の 3 種類の検証を実行します。
- 必須パラメータ – 必須としてマークされたすべてのパラメータが入力されていることを確認します。 現在、コードは、無条件の必須パラメータと、単純な条件付き必須パラメータを処理します。 1 つ以上の必須パラメータが正しく入力されていない場合、SubmitRequest Web メソッドはステータス値「ReqParamsNotFilled」を返します。 このような場合、exceptionReason メンバーを参照して、どの特定のパラメータ値が入力されていないかを確認できます。
- 検証値 – 検証リスト テーブル内の既存のレコードに基づいて、指定された値が許容値であることを確認します。 現在、コードは通常の検証(つまり 単一のフィールドに対する検証)と単純な制約付き検証(つまり 以前のフィールドの値に基づいて制約される検証)。 検証を満たさないパラメータが 1 つ以上ある場合、SubmitRequest Web メソッドは「ValidationValuesMismatch」というステータス値を返します。 このような場合、exceptionReason メンバーを参照して、検証リストと一致しない特定のパラメータ値を判断できます。
- パラメータ型のチェック – 指定された値が指定されたパラメータのデータ型に対して適切であることを確認します。 対応するパラメータ タイプと一致しない値が 1 つ以上ある場合、SubmitRequest Web メソッドは「ParameterTypeMismatch」というステータス値を返します。 このような場合、exceptionReason メンバーを参照して、どの特定のパラメータ値が対応するデータ型と一致しないかを判断できます。 これについては次のセクションで詳しく定義します。
サービス申請のパラメータの型チェック
サービス申請を送信する前に、SubmitRequest Web メソッドは、それぞれのパラメータのデータ型に関して値のデータ型チェックを実行します。
次の表は、さまざまなパラメータ タイプをまとめたものです。 データ型の検証が実行された場合、詳細セクションでこの情報がさらに詳しく説明されます。
データタイプ | 詳細 |
|---|---|
文章 | 現在検証されていません (現在のサービス カタログの動作と一致します) |
チェックボックス | 許可される値は、true または false として解析できる値です。 チェックボックスの値が有効かどうかを判断するために、.NET の Boolean.TryParse() メソッドを使用します。 |
日付 / 時刻 / 日時 | 許可される値は、日付/時刻値として解析できる値です。 .NET の DateTime.TryParse() メソッドを使用して、日付 / 時刻 / 日時の値が有効かどうかを判断します。 日付/時刻の値を指定するには、文字列値を ISO 8601 形式を使用して指定し、値自体は UTC を基準にする必要があります。 したがって、日付/時刻の値は次の 2 つの方法のいずれかで指定できます。 または 日付と時刻の値を区切るには、スペース文字または「T」文字を使用できます。 以下は、上記の 2 つの形式を基準にして、2013 年 3 月 26 日 18:38 UTC の日付/時刻値を指定する 2 つの例です。 2013-03-26 18:38 2013-03-26T18:38 |
数字 / お金 | 許可される値は、小数値として解析できる値です。 数値が有効かどうかを判断するために、.NET の Decimal.TryParse() メソッドを使用します。 |
電話 | 許可される値は米国の電話番号と一致する電話番号です。例: (415)555-1212 これは現在のサービス カタログの動作と一致します。 国際電話番号の検証にはこのパラメータ タイプを使用しないでください。 |
社会保障番号 | 許可される値は米国の社会保障番号です。例: 123-45-6789 |
メール | 現在検証されていません (現在のサービス カタログの動作と一致します) |
メールアドレス | 現在検証されていません (現在のサービス カタログの動作と一致します) |
例
string strSubscrRecId = frSvc.GetSubscriptionId(authSessionKey, tenantId, "Domain Password Reset").subscriptionId;
List<FRSHEATServiceReqParam> srparamListItems = new List<FRSHEATServiceReqParam>();
srparamListItems.Add(new FRSHEATServiceReqParam
{
strName = "RequesterDepartment",
strValue = "IT"
});
srparamListItems.Add(new FRSHEATServiceReqParam
{
strName = "Requester",
strValue = "Ashley Simon"
});
FRSHEATSubmitRequestResponse srResponse = frSvc.SubmitRequest(authSessionKey, tenantId, strSubscrRecId, srparamListItems.ToArray(), loginId);
FRSHEATServiceReqRequest srres;
if (srResponse.status == "Success")
{
srres = srResponse.reqData;
}
それ以外
{
(srResponse.exceptionReason != null) の場合
{
Console.WriteLine("Error: " + srResponse.exceptionReason);
}
}
リクエストデータの取得
指定されたサービス申請のデータを取得します
リクエスト構文:
パブリック FRSHEATGetRequestDataResponse GetRequestData(文字列セッションキー、文字列テナント ID、文字列 strReqNumber)
パラメータ:
sessionKey: 以前の接続要求で受信したキー
tenantId: キーが認証されるテナント。
strReqNumber: サービス申請の数値ID値
戻り値:
次のように定義される FRSHEATGetRequestDataResponse オブジェクト:
public class FRSHEATGetRequestDataResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
public FRSHEATServiceReqRequest reqData { get; set; }
}
FRSHEATGetRequestDataResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- reqData – 正常に送信されたサービス申請を含む FRSHEATServiceReqRequest オブジェクト
FRSHEATServiceReqRequest クラスの定義については、前の SubmitRequest セクションを参照してください。
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | 指定された数値 ID を持つ サービス申請は検索可能であり、reqData メンバーを介して利用できます。 |
見つかりません | 指定された数値 ID を持つ サービス申請が見つかりません。 サービス申請の数値 ID が正しく指定されていることを確認します。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
FRSHEATGetRequestDataResponse getRequestDataResponse = frSvc.GetRequestData(authSessionKey, tenantId, strReqRecId);
FRSHEATServiceReqRequest srRequest;
if (getRequestDataResponse.status == "Success")
{
srRequest = getRequestDataResponse.reqData;
// 先に進み、 サービス申請から関連するプロパティにアクセスします。
}
サービス要求検証リストデータの取得
指定されたサービス申請パラメータの許容検証リストデータを取得します。
リクエスト構文:
パブリック FRSHEATFetchSRValListDataResponse FetchServiceReqValidationListData(文字列 sessionKey、文字列 tenantId、文字列 offeringName、文字列 paramName、FRSHEATDepValItem depvalItem = null、文字列 subStrMatch = "")パラメータ:
- sessionKey: 以前の接続要求で受信したキー
- tenantId: キーが認証されるテナント。
- offeringName: 申請項目の名前
- paramName: リクエストオファリング内のパラメータの名前
- depValItem: 依存検証項目を表す FRSHEATDepValItem オブジェクト
- substrMatch: 返された検証リスト項目と一致する部分文字列
戻り値:
次のように定義される FRSHEATFetchSRValListDataResponse オブジェクト:
public class FRSHEATFetchSRValListDataResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック リスト<FRSHEATValListValue> validationValuesList { get; set; }
}
FRSHEATFetchSRValListDataResponse クラスは次のフィールドで構成されます。
- ステータス – このフィールドには、操作が成功したかどうかを示すステータス値が表示されます。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason – Connect WebMethod の実行中に例外がスローされた場合、例外情報はこのフィールドにキャプチャされます。
- validationValuesList – FRSHEATValListValue オブジェクトのリスト。各項目は、指定された検索条件に基づいて、基礎となる検証リストから返されたレコードを表します。
FRSHEATValListValue クラスは次のように定義されます。
public class FRSHEATValListValue
{
パブリック文字列 strRecId;
パブリック文字列 strStoredValue;
パブリック文字列 strDisplayValue;
}
FRSHEATValListValue クラスは次のフィールドで構成されます。
- strRecId – 検証リストレコードのRecId
- strStoredValue – 検証リストレコードの保存された値(例: 「ASimon」(検証リストのレコードが「Ashley Simon」従業員レコードに対応する場合)
- strDisplayValue - 検証リストレコードの表示値(例: 「Ashley Simon」、検証リストのレコードが「Ashley Simon」従業員レコードに対応する場合)
次の表に、使用可能なステータス値と、それらの解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | 指定された数値 ID を持つ サービス申請は検索可能であり、reqData メンバーを介して利用できます。 |
見つかりません | 指定された数値 ID を持つ サービス申請が見つかりません。 サービス申請の数値 ID が正しく指定されていることを確認します。 |
エラー | この Web メソッドの実行中にエラーが発生しました。Web メソッドが失敗した理由を特定するには、対応する exceptionReason メンバーを検査する必要があります。 |
例
// 「ドメイン パスワード リセット」申請項目で、リクエスト元に一致する検証リスト レコードを取得します。
// リクエスターは「RequesterDeparment」パラメータによって制約されるため、これをWebメソッドへの入力パラメータとして指定する必要があります。
string offeringName = "Domain Password Reset";
string paramName = "Requester";
FRSHEATDepValItem depValItem = new FRSHEATDepValItem()
{
strParName = "RequesterDepartment",
strParValue = "IT"
};
FRSHEATFetchSRValListDataResponse validationValuesResponse = frSvc.FetchServiceReqValidationListData(authSessionKey, tenantId, offeringName, paramName, depValItem, subStrQuery);
FRSHEATValListValue[] valListValues;
if (validationValuesResponse.status == "Success")
{
valListValues = validationValuesResponse.validationValuesList;
Console.WriteLine("一致する検証リスト レコードは次のとおりです:\n");
foreach (FRSHEATValListValue valListItem in valListValues)
{
Console.WriteLine("Stored Value: \"\"\t\tDisplay Value: \"\"", valListItem.strStoredValue, valListItem.strDisplayValue);
}
}
付録 A: Visual Studio を使用してテスト コンソール アプリケーションを作成する
前述の「概要」セクションで説明したように、FRSHEATIntegration Web サービスは標準の Web サービス テクノロジを使用し、Microsoft .NET、Java などのさまざまなプログラミング言語/プラットフォームを使用して使用できます。
このセクションでは、Visual Studio 2010 を使用してテスト コンソール アプリケーションを作成する方法、特に SOAP ベースの FRSHEATIntegration API にアクセスするための Web 参照を作成する方法について説明します。
ここで紹介したのと同じ概念を使用して、WPF、ASP.NET、Windows フォーム クライアントなどの代替の .NET ベースのクライアントも作成できることに注意してください。
Visual Studio で新しいテスト コンソール アプリケーションを作成するには、次の手順に従います。
- Visual Studio 2010を起動し、新しいVisual Cを作成します。

- ソリューション エクスプローラーで、[参照] フォルダーを右クリックし、コンテキスト メニューから [ サービス参照の追加 ] を選択します。

サービス参照の追加 ダイアログ ボックスが表示されます。

- 左下隅の [ 詳細設定 ] をクリックして、[ サービス参照設定 ] ダイアログ ボックスを起動します。

- 左下隅の [ Web 参照の追加 ] をクリックして、[ Web 参照の追加 ] ダイアログ ボックスを起動します。
この時点で、FRSHEATIntegration Web サービスを実行するために必要なコードを作成する準備が整いました。
