UpdateObject Web メソッドの使用
この Web メソッドは、フィールド値を変更することで単一のオブジェクトを更新し、他のオブジェクトとの関係を確立したり解除したりすることもできます。 自動入力、計算、保存、およびビジネス ルールは更新中に実行され、追加のフィールド変更がトリガーされる可能性があります。 検証ルールも実行され、結果のオブジェクト フィールド値が検証に合格しない場合は更新操作がブロックされる可能性があります。
更新中も操作の順序は保持されます。
リクエスト構文
FRSHEATIntegrationUpdateBOResponse UpdateObject(string sessionKey, string tenantId, ObjectCommandData commandData)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- commandData: 作成要求に関する情報を含む構造体。
戻り値
FRSHEATIntegrationUpdateBOResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATIntegrationUpdateBOResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック文字列 recId { 取得; 設定; }
public WebServiceBusinessObject obj { get; set; }
}FRSHEATIntegrationUpdateBOResponse クラスには次のフィールドがあります。
- ステータス: 操作の状態に関するステータスを提供します。 以下の表には、使用可能なステータス値の詳細な説明が記載されています。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- recId: Web メソッドのステータスが「€œsuccess」€ の場合、更新されたレコードの Rec ID。
- obj: ビジネス オブジェクト レコードが正常に更新された場合、更新されたレコードを WebServiceBusinessObject オブジェクトとして返します。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | ビジネス オブジェクトが正常に更新されました。 応答オブジェクトの recId フィールドには、新しく作成されたレコードの Rec ID が含まれます。 obj フィールドは、新しく作成された WebServiceBusinessObjectを参照します。 |
エラー | ビジネス オブジェクトを作成できません。 recId および obj フィールドが null です。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 典型的なエラーの 1 つは、「 テーブルが見つかりません」です。これは、指定されたビジネス オブジェクトがテナント内に存在しない場合に発生します。 ビジネス オブジェクトの名前が正しく入力されていることを確認します。 もう 1 つの一般的なエラーは、指定されたフィールドがビジネス オブジェクトに存在しないことです。 エラーメッセージは次のとおりです: ObjectTableMap: フィールド <FieldName> がテーブル <Business Object>に見つかりません フィールド名が正しく入力されていること、および指定されたビジネス オブジェクトに対して定義されていることを確認します。 もう 1 つのよくあるエラーは、関連付けられている検証リストに存在しないフィールドの値を指定することです。 エラーメッセージは次のとおりです: <BusinessObject>.<Field>:`<FieldValue>` は検証リストにありません |
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
例
次の例では、 Search Web メソッドを使用して既存の変更レコードと CI.Computer レコードを検索し、 UpdateObject Web メソッドを使用して 2 つのレコードをリンクします。
// まず、ChangeNumberを使用して更新する変更レコードを検索します
// (例: 変更 21)
ObjectQueryDefinition changeQuery = new ObjectQueryDefinition();
// 変更レコードの RecId フィールドのみを取得します
FieldClass[] changeFieldObjects = new FieldClass[] {
新しいフィールドクラス()
{
名前 = "RecId"、
タイプ = "テキスト"
}
};
changeQuery.Select = 新しい SelectClass();
changeQuery.Select.Fields = changeFieldObjects;
変更クエリ.From = 新しい FromClass();
// Change オブジェクトに対してレコードを検索します
changeQuery.From.Object = "変更";
changeQuery.Where = 新しいルールクラス[] {
new RuleClass()
{
// 変更を検索するための条件を指定します
// ここでは、ChangeNumberで変更を検索します
条件 = "="、
フィールド = "ChangeNumber"、
値 = "21"
}
};
// クエリのObjectQueryDefinitionを渡します
FRSHEATIntegrationSearchResponse changeSearchResponse = frSvc.Search(authSessionKey, tenantId, changeQuery);
WebServiceBusinessObject[][] changeList = changeSearchResponse.objList;
// 変更レコードが一意に識別されると仮定すると、
// ChangeNumber、そして上記のクエリは他のクエリと結合しないため
// テーブルにアクセスすることで、変更レコードを見つけることができるはずです。
// changeList[0][0]、WebServiceBusinessObjectsのリストのリスト内
WebServiceBusinessObjectの変更 = changeList[0][0];
文字列 changeRecId = change.RecID;
// CI.Computerレコードを見つけて、既存のChangeとリンクします。
// ここではCI.Computerレコードを検索します。
// "APAC-DEPOT-SERV01" の名前とその RecId を取得します
ObjectQueryDefinition ciQuery = new ObjectQueryDefinition();
// 一致する結果の CI の RecId フィールドのみを取得します
FieldClass[] ciFieldObjects = new FieldClass[] {
新しいフィールドクラス()
{
名前 = "RecId"、
タイプ = "テキスト"
}
};
ciQuery.Select = new SelectClass();
ciQuery.Select.Fields = ciFieldObjects;
ciQuery.From = new FromClass();
// CI.Computer メンバー オブジェクトに対してレコードを検索します
ciQuery.From.Object = "CI.Computer";
ciQuery.Where = new RuleClass[]
{
// CI.Computer を名前で検索する
new RuleClass()
{
条件 = "="、
フィールド = "名前"、
値 = "EMEA-EXCH-SERV01"
}
};
// クエリのObjectQueryDefinitionを渡します
FRSHEATIntegrationSearchResponse ciSearchResponse = frSvc.Search(authSessionKey, tenantId, ciQuery);
WebServiceBusinessObject[][] cilist = ciSearchResponse.objList;
// CIレコードが名前によって一意に識別され、
// 上記のクエリは他のテーブルと結合しないので、
// cilist[0][0]にアクセスすることでCIレコードを見つけることができる。
// WebServiceBusinessObjects のリストのリスト
WebServiceBusinessObject ci = cilist[0][0];
// CIのRecIdフィールドのみを取得するため、
// フィールドのリストの最初の項目として、つまり ci.FieldValues[0]
文字列 ciRecId = (文字列)ci.FieldValues[0].Value;
// この時点で、変更レコードとCIレコードのRecIdが取得できました。
// 更新を続行できます
// ObjectCommandDataの場合は、
// 上で決定された、更新するレコードを検索するためのもの
ObjectCommandData data = new ObjectCommandData();
data.ObjectType = "Change#";
data.ObjectId = changeRecId;
List<ObjectCommandDataFieldValue> dataFields = new List<ObjectCommandDataFieldValue>();
辞書<string, object> fields = 新しい辞書<string, object>();
// 既存のフィールド値を更新できることを示すために、
// 既存の変更レコードの緊急度を「高」にする
fields["緊急度"] = "中";
// CABVoteExpirationDateTime を特定の日付/時刻値に更新します
fields["CABVoteExpirationDateTime"] = "2013-03-26 18:38:30";
foreach (fields.Keys 内の文字列キー)
{
dataFields.Add(新しいObjectCommandDataFieldValue()
{
名前 = キー、
値 = fields[キー].ToString()
});
}
data.Fields = dataFields.ToArray();
data.LinkToExistent = new LinkEntry[]
{
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "",
関連オブジェクトタイプ = "CI
関連オブジェクトID = ciRecId
}
};
FRSHEATIntegrationUpdateBOResponse response = frSvc.UpdateObject(authSessionKey, tenantId, data);
if (response.exceptionReason != null)
{
Console.WriteLine("レコードの更新中に次のエラーが発生しました: {0}", response.exceptionReason);
}