UpsertObject Web メソッドの使用
この Web メソッドは、検索フィールドを使用して既存のビジネス オブジェクトを検索しようとします。 ビジネス オブジェクトが見つかった場合は、 UpdateObject Web メソッドの動作と同様に、既存のビジネス オブジェクトを更新します。 ビジネス オブジェクトが見つからない場合は、 CreateObject Web メソッドの動作と同様に、新しいビジネス オブジェクトが作成されます。
リクエスト構文
FRSHEATIntegrationUpsertBOResponse UpsertObject(文字列セッションキー、文字列テナントID、ObjectCommandDataコマンドデータ、文字列[]検索フィールド)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- commandData: upsert 要求に関する情報を含む構造体。
- searchFields: オブジェクトを一意に識別するために使用される値を持つフィールド名のリスト。
戻り値
FRSHEATIntegrationUpsertBOResponse オブジェクトは次のように定義されます。
パブリック クラス FRSHEATIntegrationUpsertBOResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック文字列 recId { 取得; 設定; }
public WebServiceBusinessObject obj { get; set; }
}FRSHEATIntegrationUpsertBOResponse クラスには次のフィールドがあります。
- ステータス: 操作が成功したかどうかを示すステータス値を提供します。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason: Connect Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- recId: ステータス フィールドの値が successの場合、更新または新しく作成されたレコードの RecID。
- obj: ステータス フィールドの値が successの場合、見つかった結果のリストが含まれます。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | ビジネス オブジェクトが正常に更新または作成されました。 obj フィールドからビジネス オブジェクト リストにアクセスすると、結果が WebServiceBusinessObjectsのリストとして返されます。 |
エラー | ビジネス オブジェクトを更新または作成できません。 recId および obj フィールドが null です。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 典型的なエラーの 1 つは、「 テーブルが見つかりません」です。これは、指定されたビジネス オブジェクトがテナント内に存在しない場合に発生します。 ビジネス オブジェクトの名前が正しく入力されていることを確認します。 もう 1 つの一般的なエラーは、指定されたフィールドがビジネス オブジェクトに存在しないことです。 エラーメッセージは次のとおりです: ObjectTableMap: フィールド <FieldName> がテーブル <Business Object>に見つかりません フィールド名が正しく入力されていること、および指定されたビジネス オブジェクトに対して定義されていることを確認します。 もう 1 つの一般的なエラーは、指定されたフィールドの値が、関連付けられた検証リストに存在しないことです。 エラーメッセージは次のとおりです: <BusinessObject>.<Field>:`<FieldValue>` は検証リストにありません |
例
次の例では、新入社員レコードを作成し、ユーザーをそれぞれの役割とチームにリンクします。 従業員がすでに存在する場合 (ログイン ID を使用して識別される)、アプリケーションは既存の情報を更新します。 パスワード値がプレーンテキストで指定されていることに注意してください。 アプリケーションは、レコードを保存するときに、それを内部ハッシュ値に自動的に変換します。
ObjectCommandData data = new ObjectCommandData();
data.ObjectType = "Profile#Employee";
List<ObjectCommandDataFieldValue> dataFields = new List<ObjectCommandDataFieldValue>();
辞書<string, object> fields = 新しい辞書<string, object>();
fields["ステータス"] = "アクティブ";
fields["FirstName"] = "ブライアン";
fields["LastName"] = "ウィルソン";
fields["ログインID"] = "BWilson";
フィールド["IsInternalAuth"] = true;
// 従業員のパスワードを設定する際、プレーンテキスト
// ここでパスワードが指定されます - ハッシュ値に変換されます
// レコードの保存時
fields["InternalAuthPasswd"] = "Manage1t";
fields["PrimaryEmail"] = "[email protected]";
fields["電話1"] = "14158665309";
// 新入社員のマネージャーとして機能する「管理者」ユーザーの RecId
フィールド["ManagerLink"] = "FB884D18F7B746A0992880F2DFFE749C";
// 新入社員の組織単位の「GMI」組織単位の RecId
フィールド["OrgUnitLink"] = "4A05123D660F408997A4FEE714DAD111";
fields["チーム"] = "IT";
fields["Department"] = "Operations";
fields["タイトル"] = "管理者";
foreach (fields.Keys 内の文字列キー)
{
dataFields.Add(新しいObjectCommandDataFieldValue()
{
名前 = キー、
値 = fields[キー].ToString()
});
}
data.Fields = dataFields.ToArray();
data.LinkToExistent = new LinkEntry[]
{
// まず、新入社員を「SelfService」にリンクし、
// RecID による「ServiceDeskAnalyst」ロール
// 関係の内部参照名
// Profile.EmployeeとFrsdefroleは空なので、そのままにしておきます
// この場合、LinkEntry の Relation 属性は空です
// 「SelfService」ロールへのリンク
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "",
関連オブジェクトタイプ = "Frsdefrole
関連オブジェクトID = "0a4724d8478b451abea3fb44d33db1b6"
},
// 「ServiceDeskAnalyst」ロールへのリンク
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "",
関連オブジェクトタイプ = "Frsdefrole
関連オブジェクトID = "06d780f5d7d34119be0d1bc8fc997947"
},
// 次に、新入社員を「IT」チームと「HR」チームにリンクします。
// 関係の内部参照名
// Profile.EmployeeとStandardUserTeamは「Rev2」なので、
// LinkEntryのRelation属性でこれを指定します
// 「IT」チームへのリンク
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "Rev2"、
関連オブジェクトタイプ = "StandardUserTeam
関連オブジェクトID = "10F60157A4F34A4F9DDB140E2328C7A6"
},
// 「HR」チームへのリンク
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "Rev2"、
関連オブジェクトタイプ = "StandardUserTeam
関連オブジェクト ID = "1FF47B9EDA3049CC92458CE3249BA349"
}
};
FRSHEATIntegrationCreateBOResponse 結果 = frSvc.UpsertObject(authSessionKey、tenantId、data、新しい文字列 ["LoginID" ]);
if (result.status == "Success")
{
Console.WriteLine("新入社員レコードが、recId が {0}で作成または更新されました "、result.recId);
}