CreateObject Web メソッドの使用
この Web メソッドは、単一のビジネス オブジェクトの新しいインスタンスを作成し、他のオブジェクトとの関係を確立することもできます。 オブジェクトがユーザー インターフェイスを介して対話的に作成された場合は、最初に初期化ルールを実行し、次に指定された値をフィールドに適用し、同じ方法で自動入力、計算、保存、およびビジネス ルールを呼び出します。 検証ルールも実行され、結果のオブジェクト フィールド値が検証に合格しない場合は、保存操作が妨げられる可能性があります。
この Web メソッドは、指定された順序でフィールドを初期化します。
リクエスト構文
FRSHEATIntegrationCreateBOResponse CreateObject(string sessionKey, string tenantId, ObjectCommandData commandData)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- commandData: 作成要求に関する情報を含む構造体。
パブリッククラス ObjectCommandData
{
パブリック文字列 ObjectId;
パブリック文字列 ObjectType;
パブリック リスト<ObjectCommandDataFieldValue> フィールド;
パブリック リスト<LinkEntry> LinkToExistent;
}- ObjectId: 作成するオブジェクトの RecID。
- ObjectType: 作成するオブジェクトのタイプ。
- FieldValues: 入力する必要があるビジネス オブジェクトのフィールドのフィールド名と新しい値を含む名前と値のペアのリスト。
- LinkToExistent: このオブジェクトと他のオブジェクト間の関係を確立するかどうかを制御する LinkEntry クラスを参照します。
パブリッククラス LinkEntry
{
パブリック文字列アクション;
パブリック文字列リレーション;
パブリック文字列 RelatedObjectType;
パブリック文字列 RelationshipName;
パブリック文字列 RelatedObjectId;
パブリック リスト<SearchCondition> SearchCriteria;
}LinkEntry クラスには次のフィールドがあります。
- アクション: このオブジェクトを他のオブジェクトとリンクするかどうかを決定します。 値は link または unlink のいずれかになりますが、 CreateObject 操作では「€œlink」€ のみが意味を持ちます。
- 関係: 確立する関係タイプの関係タグ (構成コンソールで内部参照名として表示されます)。
- RelationshipName: 確立する関係タイプの関係名 (構成コンソールで表示名として表示されます)。
- RelatedObjectType: リンクされるオブジェクト参照表記法におけるビジネス オブジェクトのタイプ。
- RelatedObjectId: (オプション。 クラスには、 RelatedObjectId または SearchCriteria フィールドのいずれかが必要です。) リンクまたはリンク解除するビジネス オブジェクトの RecID。
- SearchCriteria: (オプション。 クラスには、 RelatedObjectId または SearchCriteria フィールドのいずれかが必要です。) このオブジェクトにリンクする必要がある一致するオブジェクトの検索条件を定義する構造体のリスト。
パブリッククラス SearchCondition
{
パブリック文字列 ObjectId;
パブリック文字列 ObjectDisplay;
パブリック文字列 JoinRule;
パブリック文字列条件;
public SearchConditionType ConditionType;
パブリック文字列フィールド名;
パブリック文字列 FieldDisplay;
パブリック文字列 FieldAlias;
パブリック文字列フィールドタイプ;
パブリック文字列 FieldValue;
パブリック文字列 FieldValueDisplay;
パブリック文字列 FieldValueBehavior;
パブリック文字列 FieldStartValue;
パブリック文字列 FieldEndValue;
パブリック リスト<SearchCondition> サブクエリ;
}- ObjectId: 一致させるオブジェクトの RecID。
- ObjectDisplay: 定義が存在しません。
- JoinRule: 個々の検索条件をどのように組み合わせるかを決定します。 可能な値は「€œand」および「€œor」です。
- 条件: フィールド値をどのように一致させるかを説明します。 可能な値は以下に記載されています。
オペレーター | 意味 |
|---|---|
= | 等しい |
!= | 等しくない |
> | より大きい |
< | 未満 |
>= | より大きいか等しい |
<= | 以下 |
-> | まずは |
{} | 含まれるもの |
!{} | 含まれていない |
0 | 空です |
!0 | 空ではありません |
() | リスト内 |
!() | リストにありません |
>< | 範囲内 |
- ConditionType: テキスト フィールドの検索方法を制御します。 0 (通常の Microsoft SQL フィールド検索 [SQL に類似、句を含む] を使用) または 1 (全文 Microsoft SQL フィールド検索を使用) にすることができます。
- FieldName: フィールド名。
- FieldValue: フィールド値。
- FieldValueBehavior: 単一またはリストのいずれか。
- FieldStartValue: 「範囲内」条件のみの開始値。
- FieldEndValue: 「範囲内」条件のみの終了値。
戻り値
FRSHEATIntegrationCreateBOResponse オブジェクトは次のように定義されます。
パブリック クラス FRSHEATIntegrationCreateBOResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック文字列 recId { 取得; 設定; }
public WebServiceBusinessObject obj { get; set; }
}FRSHEATIntegrationCreateBOResponse クラスには次のフィールドがあります。
- ステータス: Web メソッドが成功したかどうかを示すステータスが含まれます。 以下の表には、使用可能なステータス値の詳細な説明が記載されています。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- recId: 新しく作成されたレコードの Rec ID。
- obj: ビジネス オブジェクト レコードが正常に更新された場合、更新されたレコードを WebServiceBusinessObject オブジェクトとして返します。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | ビジネス オブジェクトが正常に作成されました。 応答オブジェクトの recId フィールドには、新しく作成されたレコードの RecID が含まれます。 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 レコードを検索し、 CreateObject Web メソッドを使用して 2 つのレコードをリンクします。
ObjectCommandData data = new ObjectCommandData();
data.ObjectType = "Change#";
List<ObjectCommandDataFieldValue> dataFields = new List<ObjectCommandDataFieldValue>();
辞書<string, object> fields = 新しい辞書<string, object>();
フィールド["リクエストリンク"] = "FB884D18F7B746A0992880F2DFFE749C";
fields["Subject"] = "ハードディスクを交換する必要があります";
fields["Description"] = "ハードドライブがクラッシュしました。ベンダーから新しいドライブに交換する必要があります";
fields["ステータス"] = "ログに記録されました";
fields["TypeOfChange"] = "Major";
fields["OwnerTeam"] = "運用";
fields["所有者"] = "管理者";
fields["影響"] = "中";
fields["緊急度"] = "中";
fields["CABVoteExpirationDateTime"] = "2013-03-26 18:38:30";
foreach (fields.Keys 内の文字列キー)
{
dataFields.Add(新しいObjectCommandDataFieldValue()
{
名前 = キー、
値 = fields[キー].ToString()
});
}
data.Fields = dataFields.ToArray();
// ここでCI.Computerレコードを識別し、
// 新しい変更レコード
// この例では、CI.Computerレコードを検索します
// 「APAC-DEPOT-SERV01」という名前で、そのRecIdを取得します
ObjectQueryDefinition ciQuery = new ObjectQueryDefinition();
// CI.Computer レコードの 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を検索するための条件を指定します
// ここでは、CI.Computerを名前で検索します
new RuleClass()
{
条件 = "="、
フィールド = "名前"、
値 = "APAC-DEPOT-SERV01"
}
};
// クエリのObjectQueryDefinitionを渡します
FRSHEATIntegrationSearchResponse searchResponse = frSvc.Search(authSessionKey, tenantId, ciQuery);
WebServiceBusinessObject[][] cilist = searchResponse.objList;
// CIレコードが名前によって一意に識別され、
// 上記のクエリは他のテーブルと結合しないので、
// cilist[0][0]にアクセスすることでCIレコードを見つけることができます。
// WebServiceBusinessObjects のリストのリスト
WebServiceBusinessObject ci = cilist[0][0];
文字列 ciRecId = ci.RecID;
// 新しい変更レコードを CI にリンクするための LinkEntry レコードを定義します
// 変更のRecId(つまり ciRecId), as
// 上記で決定
data.LinkToExistent = new LinkEntry[]
{
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "",
関連オブジェクトタイプ = "CI
関連オブジェクトID = ciRecId
}
};
// レコードの作成が成功した場合、結果変数には
// 新しい変更レコードの RecId。それ以外の場合は null になります
FRSHEATIntegrationCreateBOResponse result = frSvc.CreateObject(authSessionKey, tenantId, data);
if (result.status == "Success")
{
Console.WriteLine("A new Change record is created with RecId of {0}", result.recId);
}
次の例では、新しい Profile.Employee レコードを作成し、ユーザーをそれぞれの役割とチームにリンクします。 パスワード値はプレーンテキストで指定されていることに注意してください。レコードを保存すると、パスワード値は自動的に内部ハッシュ値に変換されます。
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()
{
アクション = "リンク"、
関係 = "",
RelatedObjectType = "Frs_def_role#",
RelatedObjectId = "0a4724d8478b451abea3fb44d33db1b6"
},
// 「ServiceDeskAnalyst」ロールへのリンク
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "",
RelatedObjectType = "Frs_def_role#",
RelatedObjectId = "06d780f5d7d34119be0d1bc8fc997947"
},
// 次に、新入社員を「IT」チームと「HR」チームにリンクします。
// 関係の内部参照名
// Profile.EmployeeとStandardUserTeamは「Rev2」なので、
// LinkEntryのRelation属性でこれを指定します
// 「IT」チームへのリンク
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "Rev2"、
RelatedObjectType = "StandardUserTeam#",
RelatedObjectId = "10F60157A4F34A4F9DDB140E2328C7A6"
},
// 「HR」チームへのリンク
新しいLinkEntry()
{
アクション = "リンク"、
関係 = "Rev2"、
RelatedObjectType = "StandardUserTeam#",
RelatedObjectId = "1FF47B9EDA3049CC92458CE3249BA349"
}
};
FRSHEATIntegrationCreateBOResponse result = frSvc.CreateObject(authSessionKey, tenantId, data);
if (result.status == "Success")
{
Console.WriteLine("新入社員レコードが recId {0}で作成されました ", result.recId);
}