Web サービス メソッド
このセクションでは、使用できる サービス マネージャ Web サービス メソッドを一覧表示します。 これらのメソッドは JavaScript に基づいています。
クイック アクション スクリプトでは、次の Web サービス メソッドがサポートされています。
- URLからWebサービスを取得
- Webサービスを取得する
- クイックアクションの実行
- 作成する
- 得る
- 検索
- Webリクエストの実行
- HtmlEncode
- HtmlDecode
- 16進数からバイト数
- バイトから文字列へ
- ロードXML
- 文化情報を取得
- タイムゾーン情報を取得する
- ハッシュ
- キー付きハッシュ
外部ビジネス オブジェクト スクリプトでは、次の Web サービス メソッドがサポートされています。
- URLからWebサービスを取得
- Webサービスを取得する
- 戻りデータの設定
- 条件の戻りデータの設定
- 得る
- 検索
- Webリクエストの実行
- すべての熱データを同期する
- すべての熱データを関連データと同期する
- 熱データの同期
- 熱データを関連データと同期する
- HtmlEncode
- HtmlDecode
- 16進数からバイト数
- バイトから文字列へ
- ロードXML
- 文化情報を取得
- タイムゾーン情報を取得する
- ハッシュ
- キー付きハッシュ
変数
ヒートコンテキスト
説明
このコンテキスト変数は、 SetReturnData および同期スクリプトで使用できます。 このオブジェクトには、スクリプトが実行される理由に関する情報が含まれています。
パラメータ
ロケール | 「en-US」などのロケール識別子が含まれます。 スクリプトがユーザーアクションの結果として呼び出される場合は、ユーザーセッションに関連付けられたロケールが含まれます。 |
|---|---|
テナントID | テナント識別子。 |
ビジネスオブジェクト | スクリプトが関連付けられているビジネス オブジェクトに関する情報。 |
UIビジネスオブジェクト | スクリプトが検証リスト ビジネス オブジェクトに関連付けられている場合、その検証リスト ビジネス オブジェクトの選択リストがワークスペースで使用されると、その選択リストにはワークスペースに関連付けられたビジネス オブジェクトが含まれます。 たとえば、選択リストが Incident ワークスペースで参照されている場合、その選択リストには Incident ビジネス オブジェクトに関する情報が含まれます。 |
ピックリスト | 選択リストの値を取得するためにスクリプトが呼び出される場合は、選択リストの詳細が含まれます。 選択リストが検証プロバイダーの選択リストであり、サービス カタログで使用されている場合、以下の引数には検証パラメータ名とその値が含まれます。 |
引数 | 外部ソースから最新のデータを取得するためにスクリプトが呼び出されると、次の情報が取得されます。 リスト: 次の情報を保持するオブジェクトが含まれます。
ExecuteScript() を使用して別のスクリプトからスクリプトが呼び出されると、この関数の Arguments パラメータに渡された値が含まれます。 スクリプトが呼び出されてサービス カタログに検証プロバイダーの選択リストが入力されると、検証パラメータ情報が含まれます。 |
方法
致命的
説明
致命的なメッセージをサーバー ログに書き込みます。
意味
console.fatal(文字列ログメッセージ)パラメータ
ログメッセージ | ログに記録されるメッセージ文字列。 |
|---|
例
次のスクリプトを使用して致命的なメッセージをログに記録できます。
console.fatal("これは致命的なメッセージです!");方法
エラー
説明
エラー メッセージをサーバー ログに書き込みます。
意味
console.error(文字列 ログメッセージ)パラメータ
ログメッセージ | ログに記録されるメッセージ文字列。 |
|---|
例
次のスクリプトを使用してエラー メッセージをログに記録できます。
console.error("これはエラーメッセージです!")方法
警告
説明
警告メッセージをサーバー ログに書き込みます。
意味
console.warn(文字列ログメッセージ)パラメータ
ログメッセージ | ログに記録されるメッセージ文字列。 |
|---|
例
次のスクリプトを使用して警告メッセージをログに記録できます。
console.warn("これは警告メッセージです!")方法
情報提供
説明
情報メッセージをサーバー ログに書き込みます。
意味
console.info(文字列ログメッセージ)パラメータ
ログメッセージ | ログに記録されるメッセージ文字列。 |
|---|
例
次のスクリプトを使用して情報メッセージをログに記録できます。
console.info("これは情報メッセージです!");方法
デバッグ
説明
デバッグ メッセージをサーバー ログに書き込みます。
意味
console.debug(文字列 logMessage)パラメータ
ログメッセージ | ログに記録されるメッセージ文字列。 |
|---|
例
次のスクリプトを使用してデバッグ メッセージをログに記録できます。
console.debug("これはデバッグメッセージです!");方法
ログ
説明
ログ メッセージをサーバー ログに書き込みます。
意味
console.log(文字列ログメッセージ)パラメータ
ログメッセージ | ログに記録されるメッセージ文字列。 |
|---|
例
次のスクリプトを使用してログ メッセージを記録できます。
console.log("これはログメッセージです!");方法
URLからWebサービスを取得
説明
Web サービスを呼び出す Web サービス インスタンス オブジェクトを取得します。
意味
オブジェクト GetWebServiceFromUrl(文字列 serviceUrl、文字列 serviceName、文字列 userName、文字列 password)オブジェクト GetWebServiceFromUrl(文字列 serviceUrl、文字列 serviceName、文字列 userName、文字列 password、文字列 wsdlPath)パラメータ
サービスURL | Web サービスが配置されている URL。 |
|---|---|
サービス名 | Web サービスの名前。 |
ユーザ名 | Web サービス インスタンスを取得するために必要な資格情報のユーザ名。 |
パスワード | ユーザ名に関連するパスワード。 |
wsdlパス | Web サービスが WSDL ドキュメントのクエリをサポートしていない場合、このパラメータには Web サービスの WSDL が利用可能な場所が含まれます。 これは、 WSDL およびスクリプト リポジトリ ワークスペースにリストされている WSDL ドキュメントの名前です。 |
戻り値の型
メソッドを呼び出すことができる Web サービス インスタンスであるオブジェクトを返します。
例
var serviceInstance = GetWebServiceFromUrl("http://wsf.cdyne.com/WeatherWS/Weather.asmx", "Weather", null, null);var serviceInstance = GetWebServiceFromUrl("http://www.webservicex.net/uszip.asmx", "USZip", null, null);var serviceInstance = GetWebServiceFromUrl("http://sap.local:8000/sap/bc/srt/rfc/sap/ict_service_desk_api/100/ict_service_desk_api/ict_service_desk_api", "ICT_SERVICE_DESK_API", null, null, 'Name of SAP WSDL document in the repository');var serviceInstance = GetWebServiceFromUrl(null, "USZip", null, null, "http://www.webservicex.net/uszip.asmx?wsdl");var serviceInstance = GetWebServiceFromUrl('http://www.webservicex.net/uszip.asmx', "USZip", null, null, "http://www.webservicex.net/uszip.asmx?wsdl");方法
Webサービスを取得する
説明
Web サービスを呼び出すために必要な Web サービス インスタンス オブジェクトを取得します。
意味
GetWebService(文字列サービス参照名、文字列サービス名)パラメータ
サービス参照名 | サービス参照の名前。 名前はスクリプトごとに一意である必要があります。 スクリプト内のサービス アドレス URL を識別します。 |
|---|---|
サービス名 | Web サービスの名前。 |
戻り値の型
メソッドを呼び出すことができる Web サービス インスタンスであるオブジェクトを返します。
例
var serviceReferenceName = "TestIntegration";var wsdlAddress = "TestIntegration.TestIntegration.Address";var userId = "TestIntegration.TestIntegration.Login";var pwd = "TestIntegration.TestIntegration.Password";var serviceName = "FRSHEATIntegration";var serviceInstance = GetWebService (TestIntegration, FRSHEATIntegration);方法
呼び出しメソッド
説明
指定された Web サービス メソッドを呼び出します。
意味
オブジェクト service.InvokeMethod(文字列 methodName, オブジェクト[] 引数);オブジェクト service.InvokeMethod(文字列 methodName、オブジェクト arguments);パラメータ
メソッド名 | 呼び出す Web メソッドの名前。 |
|---|---|
引数 | Web メソッドの入力パラメータ。 位置引数の配列、またはパラメータの名前と値を含むオブジェクトのいずれか。 |
戻り値の型
Web サービス呼び出しの結果をオブジェクトとして返します。
例
var serviceInstance = GetWebServiceFromUrl("http://www.webservicex.net/uszip.asmx", "USZip", null, null);var xmlDoc = serviceInstance.InvokeMethod("GetInfoByState", [ state ]);var xmlDoc = serviceInstance.InvokeMethod("GetInfoByState", { 'USState' : state });方法
Cookie値を取得する
説明
ユーザ名とパスワードを認証するときに使用される、Cookie 内の認証トークンにアクセスします。
意味
GetCookieValue(文字列 URL、文字列名)パラメータ
メールアドレス | アクセスされている Cookie に関連付けられた URL。 |
|---|---|
名前 | 値を取得する必要がある Cookie の名前。 |
戻り値の型
認証トークンの値を返します。
例
次のスクリプトを使用して、AuthToken という Cookie を取得できます。
var wsdlAddress = "SunRise.WebServiceXSunRise.Address";var userId = "SunRise.WebServiceXSunRise.Login";var pwd = "SunRise.WebServiceXSunRise.Password";var serviceCall = "SunSetRiseService";var serviceInstance = GetWebServiceFromUrl(wsdlAddress, serviceCall, userId,pwd);var result = serviceInstance.InvokeMethod(methodCall, paramValues);var authToken = serviceInstance.GetCookieValue('/', 'AuthToken');方法
クイックアクションの実行
説明
特定のクイックアクションを実行します。
このメソッドは、オプションの引数を使用して、指定された RecID に影響を与える指定されたビジネス オブジェクトで定義された特定のクイック アクションを実行します。
意味
ExecuteQuickAction(文字列アクション名)ExecuteQuickAction(文字列 actionName、文字列 tableRef、文字列 recId)パラメータ
アクション名 | クイックアクションの名前。 |
|---|---|
テーブル参照 | レコードが作成されるテーブルのテーブル参照。 |
受信ID | データが必要なレコードの RecID。 |
例
アプリケーションは、インシデントビジネス オブジェクトの現在のオブジェクト コンテキストでインシデント所有者への問題回避策通知クイック アクションを実行します。
ExecuteQuickAction("インシデント所有者への問題回避策通知");アプリケーションは、指定されたインシデントに対して、インシデント所有者 の 問題回避策通知クイック アクションを実行します。ここで、IncidentRecId は、ターゲット インシデントの RecID で初期化されるスクリプト変数です。
ExecuteQuickAction("インシデント所有者への問題回避策通知", "インシデント方法
スクリプトの実行
説明
指定された外部ビジネス オブジェクトに関連付けられたスクリプトを実行します。
意味
ExecuteScript(文字列 boDesignerName、オブジェクト引数)パラメータ
boデザイナー名 | 外部ビジネス オブジェクトの名前。 |
|---|---|
引数 | boDesignerName パラメータによって指定された外部ビジネス オブジェクトの入力パラメータ。 |
戻り値の型
SetReturnData Web メソッドを使用して返される JSON オブジェクト。
例
var boDesignerName = RELATED_BO_FRS_WS_DSM_SOFTWAREREVISION_DESIGNER_NAME;var arguments = { Requester: { BOName: CURRENT_CONTEXT_BO_DESIGNER_NAME } };var scriptReturn = ExecuteScript(boDesignerName, arguments);方法
戻りデータの設定
説明
この値を使用して、選択リストのデータまたは別の同期スクリプトから呼び出されたデータを返します。
このメソッドを複数回呼び出すと、アプリケーションは最後の呼び出しで設定された値を使用します。
意味
SetReturnData(オブジェクト)SetReturnData(オブジェクト[] jsonObject)パラメータ
jsonオブジェクト | ExecuteScript Web メソッドを使用して別のスクリプトから呼び出された場合、これはスクリプトが呼び出し元のスクリプトに返す JSON データです。 選択リストのレコードを取得するために呼び出された場合、これはキーと値のペアの配列になります。 例えば: |
|---|
戻り値の型
選択リストの場合、戻り値の型は、外部ビジネス オブジェクトで定義されたフィールドを含むオブジェクトの配列です。
同期スクリプトの場合、戻り値の型は任意の型にすることができます。
例
// http://www.webservicex.net/uszip.asmx関数 ZipInfo(市、州、郵便番号、エリアコード、タイムゾーン){this.City = 都市;this.State = 状態;zip ファイルを解凍します。this.AreaCode = エリアコード;this.TimeZone = タイムゾーン;}関数 getCities(state){if (!状態)return [];var serviceInstance = GetWebService("USZip", "USZip");var xmlDoc = serviceInstance.InvokeMethod("GetInfoByState", [ state ]);var list = xmlDoc.ChildNodes;if (!リスト)return [];var cities = {};var count = list.Count;(i = 0; i < count; i ) の場合{試す {var node = list[i];var info = new ZipInfo(node["CITY"].InnerText, node["STATE"].InnerText, node["ZIP"].InnerText,node["AREACODE"].InnerText、node["TIMEZONE"].InnerText);都市[info.City.toUpperCase()] = 情報;} catch (error){console.log("都市の処理中にエラーが発生しました。");}}var result = [];(都市内の都市)result.push(cities[city]);結果を返します。}var state = null;if (!!HeatContext.PickList){試す {状態 = HeatContext.PickList.Constraint.Conditions[0].Value;} catch (error) {コンソールにログ出力します。}// 選択リストにこのデータを返します条件に一致するデータを設定します。 [] : getCities(state), { State : state});}そうでない場合 (!!HeatContext.Arguments !!HeatContext.Arguments.Synchronize !!HeatContext.Arguments.State){ state = HeatContext.Arguments.State;HeatData を同期します (HeatContext.BusinessObject.DesignerName、["State", "City"]、getCities(state)、{ State : state});}そうでない場合 (!!HeatContext.Arguments !!HeatContext.Arguments.State){// ExecuteScript を通じて呼び出されると、指定された州の都市のリストが返されます。状態 = HeatContext.Arguments.State;SetReturnData(!state ? [] : getCities(state));}方法
条件の戻りデータの設定
説明
選択リストのデータを返します。
このメソッドを複数回呼び出すと、アプリケーションは最後の呼び出しで設定された値を使用します。
意味
SetReturnDataForCondition(オブジェクト[] レコード、オブジェクト whereCondition)パラメータ
記録 | 選択リストのレコードを取得するために呼び出された場合、これはキーと値のペアの配列になります。 例えば: |
|---|---|
条件 | 操作対象となるデータの範囲を定義します。 たとえば、 戻りデータの設定の例では、外部ソースからデータが取得される現在の状態コードです。 |
戻り値の型
外部ビジネス オブジェクトで定義されたフィールドを含むオブジェクトの配列。
例
S戻りデータの設定例を参照してください。
方法
作成する
説明
サービス マネージャに新しいレコードを作成します。
意味
DbObject 作成(文字列テーブル参照)パラメータ
テーブル参照 | レコードが作成されるテーブルのテーブル参照。 |
|---|
例
次のスクリプトを使用して新規インシデントを作成できます。
var newIncident = Create('Incident#');方法
得る
説明
指定されたテーブル参照からレコード ID を使用して、既存のレコードのオブジェクトを取得します。
意味
Get(文字列テーブル参照、文字列recId)Get(文字列テーブル参照、文字列フィールド名、オブジェクト値)パラメータ
テーブル参照 | レコードが作成されるテーブルのテーブル参照。 |
|---|---|
受信ID | データが必要なレコードの RecID。 |
フィールド名 | 現在のビジネス オブジェクト内のフィールドの名前。 |
価値 | fieldName パラメータで指定されたフィールドの値。 |
例
次のスクリプトを使用して、 CurrentUserRecId という組み込み関数を呼び出して、現在のユーザーの姓などのデータを読み取ります。
var employee = Get('Employee#', '$(CurrentUserRecId())')var lastName = employee.Fields['LastName'];次の例では、インシデント番号が 100001 のインシデントを取得します。
Get("インシデント方法
アップデート
説明
レコードを更新します。
意味
更新(オブジェクトデータ)パラメータ
データ | このメソッドが呼び出されるレコード オブジェクト (DbObject) で更新されるキーと値のペアを含む JSON のようなオブジェクト ({<key1>: '<value>'€™, <key2>: '<value2>'™, ...})。 |
|---|
例
このメソッドを使用して、レコードを編集または更新できます。 たとえば、2 つのフィールドを編集するには、次のスクリプトを使用します。このスクリプトは、現在のインシデントの番号と RecID を取得し、 Impact と Symptomという 2 つのフィールドを更新します。
var incident = Get('Incident#', '$(RecId)');インシデント.更新({影響度: 「中」、詳細: 「問題」});もう 1 つの使用例としては、ドメイン アカウントがロックされるたびに、フィールドが自動入力された新規インシデントを自動的に作成することが挙げられます。 例えば、以下のスクリプトは新しいインシデントを作成し、その後、そのインシデントを新しいフィールド値で更新し、詳細に「ドメインアカウントがロックされている」と明確に記述します。
var newIncident = Create('Incident#');新規インシデント.更新({カテゴリ: 「アカウントロックアウト」、影響度: 「中」、プロファイルリンクレコードID: '$(CurrentUserRecId())',サービス: 「デスクトップ サービス」ステータス: 「アクティブ」、件名: 「Windowsにログインできません」詳細: 「顧客が3回以上Windowsにログインできず、ドメインアカウントがロックされています」緊急度: 「中」});方法
リンクWebサービス
説明
Web サービスは、2 つの異なるビジネス オブジェクトをリンクするために使用されます。
意味
AddLink(文字列 tableRef、文字列 id、文字列 otherTableRef、文字列 otherId、文字列 relationshipTag)パラメータ
文字列テーブル参照 | ビジネス オブジェクト名。 |
|---|---|
文字列ID | ビジネス オブジェクト レコード ID。 |
その他のテーブル参照 | リンクするビジネス オブジェクト名。 |
文字列その他のID | リンクする必要があるビジネス オブジェクト レコード ID。 |
文字列関係タグ | 2 つのビジネス オブジェクトの関係。 |
例
インシデントと変更のリンク:
AddLink('インシデント問題をインシデントにリンクする:
AddLink('インシデント更新フィールド
方法
更新フィールド
説明
レコードのフィールドを更新します。
意味
UpdateField(文字列フィールド名、文字列フィールド値)パラメータ
フィールド名 | 更新するフィールドの名前。 |
|---|---|
フィールド値 | フィールドの値。 |
例
次のスクリプトを使用して、 件名 フィールドを編集します。
incident.UpdateField('Subject', '新しいレコードを開いてください');
方法
検索
説明
検索条件なしでコレクションを取得します。
意味
検索(文字列テーブル参照)検索(文字列 tableRef、文字列 savedSearch)検索(文字列 tableRef、オブジェクト simpleSearch)返品
2 セットの機能を提供するオブジェクトを返します。
- 最初の関数セットは、検索動作を作成、結合、カスタマイズします。
- 現在のビジネス オブジェクトにアクセスしたり、関連アイテムを結合したりするには、 RelatedItems プロパティを使用します。 結合条件を構築するには、 RelatedItems を通じてリレーションシップ名を使用します。
- 関連するビジネス オブジェクトに条件を追加するには、 Where(object simpleSearch) を使用します。
- 検索関数に個別の動作を追加するには、 Distinct() を使用します。
- 取得する必要があるレコードの数を制限するには、 Top(nRecords) を使用します。
- 2 番目の関数セットは、検索操作の結果を列挙します。
- TableRef: 検索結果のビジネス オブジェクト名。
- First(): 最初のビジネス オブジェクトを返します。結果が空の場合は 'null' を返します。 返されるビジネス オブジェクトには、フィールドとその値のオブジェクトである Fields というプロパティがあります。
- 現在: MoveNext() が true を返す場合、現在のビジネス オブジェクトを返します。 返されるビジネス オブジェクトには、フィールドとその値のオブジェクトである Fields というプロパティがあります。
- MoveNext(): 存在する場合はカーソルを次のビジネス オブジェクトに移動し、true を返します。 それ以外の場合は、アクセスするビジネス オブジェクトがもう存在しないことを示す false を返します。
- Reset(): カーソルを結果リストの先頭にリセットします。
- Close(): 結果セットを閉じて、検索で使用されたリソースを解放します。
結果の処理を開始する前に、検索条件と動作を完全に定義する必要があります。 結果の処理を開始したら、結果セット全体を処理する必要があります。 そうしないと、さらにデータベース操作を行うとエラーが発生し、例外がスローされる可能性があります。 結果セットを完全に処理するには、 MoveNext() 関数を使用してすべてのビジネス オブジェクトを列挙し、false を返すまで続けるか、 Close() 関数を呼び出します。•
パラメータ
テーブル参照 | 結果が取得されるテーブルのテーブル参照。 |
|---|---|
保存済み検索 | 保存された検索の名前。 |
シンプル検索 | 追加の検索フィルター。 |
例
検索条件なしでコレクションを取得するには、次のスクリプトを使用します。
検索('インシデントステータス以下は、コレクションを取得するスクリプトの別の例です。
検索('インシデントステータス: 「アクティブ」、プロファイルリンクレコードID: '$(CurrentUserRecId())'});番号 10424 のインシデントを取得するには、次のいずれかのスクリプトを使用します。
• var インシデント = Get('インシデント• var インシデント = Get('インシデント• var incident = Search('Incident#', { IncidentNumber : 10424 }).First();これは別の例です:
var incident = null;var result = Search('Incident#', { Status: 'Active' });(result.MoveNext()) の間 {var obj = result.Current;if (obj.Fields["IncidentNumber"] == 100) {インシデント = obj;壊す;}}結果.Close();関係に基づいてレコードを検索するには、次のスクリプトを使用します。 この例では、スクリプトは指定されたインシデントのタスクを取得します。
var tasks = Get('Incident#', '$(RecId)').RelatedItems['Task#Assignment.Rev3'];var votes = Search('Change#', {Status: 'Scheduled'}).RelatedItems['FRS_Approval#.'].RelatedItems['FRS_ApprovalVoteTracking#.'];方法
どこ
説明
意味
DbObjectCollection Where(文字列条件)パラメータ
状態 | 出力の基準となる条件式。 |
|---|
例
タスクのステータスが「拒否」であるレコードを選択するには、次のスクリプトを使用します。
var rejectingItems = Search('Task#Assignment').Where({ステータス: '拒否'})検証済みのフィールドのセットを使用してレコードを検索するには、次のスクリプトを使用します。 この例では、スクリプトは拒否ステータスのタスクを持つチーム メンバーを取得します。
var rejectingTeams = Search('Task#Assignment').Where({Status: 'Rejected'}) // タスクのステータスが拒否されたレコードを選択.RelatedItems['Owner => Employee#'].RelatedItems['Team => StandardUserTeam#'].Distinct() // 重複のない一意のレコードを選択します.Top(20); // 上位20件のレコードを選択する方法
Webリクエストの実行
説明
HTTP Web 申請を実行し、要求の応答を返します。
意味
ExecuteWebRequest(文字列メソッド、文字列 URL、文字列 postData、オブジェクト設定);ExecuteWebRequest(文字列メソッド、文字列URL、byte[] postData、オブジェクト設定);パラメータ
方法 | GET、POST、HEAD、DELETE などの有効な HTTP リクエスト メソッド。 |
|---|---|
メールアドレス | クエリ文字列値を含む HTTP リクエスト URL。 |
投稿データ | リクエストの一部として送信される、適切にフォーマットされ、文字列または byte[] でエンコードされた投稿データが含まれます。 |
設定 | オプション。 JSON オブジェクトが含まれます。 メンバーも任意です。 ヘッダー: 顧客ヘッダーを含む追加の HTTP リクエスト ヘッダーを含む JSON オブジェクト。 例えば: クッキー: JSON オブジェクトであり、オプションです。 渡された場合、Cookie 名がプロパティ名として使用され、その値がプロパティ値として使用されます。 例えば: SkipServerCertificateValidation: HTTPS 要求呼び出し中に証明書エラーを処理する方法を制御するブール値。 ServerCertificateHash: オプション。 文字列値。 指定すると、証明書のハッシュ値がこの値と一致する場合に証明書エラーがスキップされます。 AllowAutoRedirect: リクエスト呼び出しのリダイレクトを自動的に処理し、リダイレクト要求の応答を返します。 ユーザ名: オプション。 資格情報のユーザ名。 パスワード: オプション。 資格情報のパスワード。 |
返品
HTTP リクエスト呼び出しからの応答を返します。 この戻り値は、次のプロパティを含む JSON オブジェクトです。
- StatusCode: 応答ステータスコードの数値。 https://msdn.microsoft.com/en-us/library/system.net.httpstatuscode(v=vs.110).aspxを参照してください。
- StatusDescription: ステータス コードの説明。
- CharacterSet: 応答データの文字セット名。
- ContentType: 応答コンテンツのタイプ。
- ContentLength: 応答コンテンツの長さ。
- 前回の変更: 応答の最後に変更されたヘッダー。
- クッキー: 応答に関連するクッキーを含む JSON オブジェクト。
- データ: 文字列 (テキスト コンテンツの場合) または byte[] (テキスト以外のコンテンツの場合)。
例
// REST API をラップする JavaScript オブジェクト関数 CustomService(ホスト、ユーザ名、パスワード){'use strict';// プライベートメンバーvar Host = host;var UserName = userName;var Password = password;var Cookies = null;var SessionInfo = null;var getWWWFormUrlEncodedData = function (obj){var encoded = '', separator = '';(var キー in obj){var value = obj[key];var encodedKey = HeatUtility.HtmlEncode(key.toString());if (typeof 値 === 'undefined' || null == 値)エンコード = セパレーター エンコードキー;そうでない場合 (配列のインスタンスの値){(var i = 0; i < 値.長さ; i ) の場合{エンコード = セパレーター エンコードキー '=' HeatUtility.HtmlEncode(value[i] '');セパレータ = '';}}それ以外エンコード = セパレーター エンコードキー '=' HeatUtility.HtmlEncode(value.toString());セパレータ = '';}エンコードされた値を返します。};var getRequestSettings = function (){戻る {ヘッダー: {},クッキー: クッキー、SkipServerCertificateValidation: true、ユーザ名: null、パスワード: null、自動リダイレクトを許可: false};};var getJsonRequestSettings = function (){戻る {ヘッダー: { 'Content-Type': 'application/json' },クッキー: クッキー、SkipServerCertificateValidation: true、ユーザ名: null、パスワード: null、自動リダイレクトを許可: false};};var isAuthenticated = function (){!!SessionInfo !!SessionInfo.tenantID を返します。};var login = function (){var url = Host + '/patchweb/tenant/v1/login?' + getWWWFormUrlEncodedData({ username: UserName, password: Password });var response = ExecuteWebRequest('GET', url, null, getRequestSettings());if ((レスポンス != null) (response.StatusCode == 200) (response.ContentType == 'application/json')){クッキー = response.Cookies;var sessionInfo = JSON.parse(response.Data);if (!!セッション情報 !!セッション情報.テナントID){セッション情報 = セッション情報;true を返します。}}false を返します。};var getAllEndPoints = function (groups){if (!isAuthenticated())throw 'ログインに失敗したか、ログインしてください。';var url = Host + '/patchweb/patchmanagement/v1/' + SessionInfo.tenantID + '/endpointpatchstates?groups=' + HeatUtility.HtmlEncode(groups);var response = ExecuteWebRequest('GET', url, null, getRequestSettings());if ((レスポンス != null) (response.StatusCode == 200) (response.ContentType == 'application/json'))JSON.parse(response.Data) を返します。console.error(応答);};// パブリック関数this.isAuthenticated = isAuthenticated;this.login = ログイン;this.getAllEndPoints = getAllEndPoints;}var service = new CustomService('https://www.example.com', 'userName', 'password');サービスにログインします。(サービスが認証されている場合){var endpoints = service.getAllEndPoints('default,excluded');console.debug(エンドポイント);}それ以外console.error('ユーザーuserNameのログインに失敗しました。');方法
すべての熱データを同期する
説明
次の操作を実行して、提供されたレコードをアプリケーション内のビジネス オブジェクトのすべてのレコードと同期します。
- 提供されたレコードに見つからない、アプリケーション (ビジネス オブジェクト) 内のレコードをすべて削除します。
- 提供されたレコード内で見つかったが、アプリケーションにまだ存在しないレコードを (ビジネス オブジェクトの) アプリケーションに挿入します。
- 提供されたレコードに対して、アプリケーション内のレコード (ビジネス オブジェクトのレコード) を更新します。
戻り値の型
この関数は、レコードの RecID の配列を返します。
意味
object[] SynchronizeAllHeatData(string designerName, string[] primaryKey, object[] records)パラメータ
デザイナー名 | 同期されるビジネス オブジェクトの名前。 |
|---|---|
プライマリキー | 各レコードを一意に識別するフィールドの配列。 |
記録 | フィールドとそれに対応する値を含む JSON キーと値のペアのリスト。 |
例
関数 State(名前、コード){this.Name = 名前;this.Code = コード;}var result = [];result.push(new State('Alabama', 'AL'));result.push(new State('Montana', 'MT'));result.push(new State('Alaska', 'AK'));result.push(new State('Nebraska', 'NE'));result.push(new State('Arizona', 'AZ'));result.push(new State('Nevada', 'NV'));result.push(new State('Arkansas', 'AR'));result.push(new State('New Hampshire', 'NH'));result.push(new State('California', 'CA'));result.push(new State('New Jersey', 'NJ'));result.push(new State('Colorado', 'CO'));result.push(new State('New Mexico', 'NM'));result.push(new State('Connecticut', 'CT'));result.push(new State('New York', 'NY'));result.push(new State('Delaware', 'DE'));result.push(new State('North Carolina', 'NC'));result.push(new State('Florida', 'FL'));result.push(new State('North Dakota', 'ND'));result.push(new State('Georgia', 'GA'));result.push(new State('Ohio', 'OH'));result.push(new State('Hawaii', 'HI'));result.push(new State('Oklahoma', 'OK'));result.push(new State('Idaho', 'ID'));result.push(new State('Oregon', 'OR'));result.push(new State('Illinois', 'IL'));result.push(new State('Pennsylvania', 'PA'));result.push(new State('Indiana', 'IN'));result.push(new State('Rhode Island', 'RI'));result.push(new State('Iowa', 'IA'));result.push(new State('South Carolina', 'SC'));result.push(new State('Kansas', 'KS'));result.push(new State('South Dakota', 'SD'));result.push(new State('Kentucky', 'KY'));result.push(new State('Tennessee', 'TN'));result.push(new State('Louisiana', 'LA'));result.push(new State('Texas', 'TX'));result.push(new State('Maine', 'ME'));result.push(new State('Utah', 'UT'));result.push(new State('Maryland', 'MD'));result.push(new State('Vermont', 'VT'));result.push(new State('Massachusetts', 'MA'));result.push(new State('Virginia', 'VA'));result.push(new State('Michigan', 'MI'));result.push(new State('Washington', 'WA'));result.push(new State('Minnesota', 'MN'));result.push(new State('West Virginia', 'WV'));result.push(new State('Mississippi', 'MS'));result.push(new State('Wisconsin', 'WI'));result.push(new State('Missouri', 'MO'));result.push(new State('Wyoming', 'WY'));if (!!HeatContext.PickList){// 選択リストにこのデータを返しますSetReturnData(結果);}そうでない場合 (!!HeatContext.Arguments !!HeatContext.Arguments.WebService){(HeatContext.Arguments.WebService.Synchronize == '選択済み') の場合{// 指定された結果リスト/配列で使用可能なレコードのみを同期します。// こことデータベース内に存在するすべてのレコードが更新されます。// ここに存在し、データベースに存在しないレコードは挿入されますHeatData を同期します (HeatContext.BusinessObject.DesignerName、['コード']、結果)。}そうでない場合 (HeatContext.Arguments.WebService.Synchronize == 'All'){// 指定された結果リスト/配列で使用可能なレコードのみを同期します。// こことデータベース内に存在するすべてのレコードが更新されます。// ここに存在し、データベースに存在しないレコードは挿入されます// データベース内のレコードのうちこのリストに含まれていないものは削除されますSynchronizeAllHeatData(HeatContext.BusinessObject.DesignerName、['コード']、結果);}そうでない場合 (HeatContext.Arguments.WebService.Synchronize == 'Clear'){// 指定されたリストが空なので、データベース内のすべてのレコードが削除されます。すべてのHeatDataを同期します(HeatContext.BusinessObject.DesignerName、['コード']、[]);}}方法
すべての熱データを関連データと同期する
説明
次の操作を実行して、提供されたレコードを、アプリケーション内のビジネス オブジェクトおよび関連するビジネス オブジェクトのすべてのレコードと同期します。
- 提供されたレコードに見つからないアプリケーション内のレコード (ビジネス オブジェクトおよび関連するビジネス オブジェクト) を削除します。
- 提供されたレコード内で見つかったが、アプリケーションにまだ存在しないレコード (ビジネス オブジェクトおよび関連するビジネス オブジェクト) をアプリケーションに挿入します。
- 提供されたレコードに対して、アプリケーション内のレコード (ビジネス オブジェクトおよび関連するビジネス オブジェクト) を更新します。
戻り値の型
この関数は、レコードの RecID の配列を返します。
意味
object[] SynchronizeAllHeatDataWithRelated(string designerName, string[] primaryKey, object[] records, object keysOfRelatedObjects)パラメータ
デザイナー名 | 同期されるビジネス オブジェクトの名前。 |
|---|---|
プライマリキー | 各レコードを一意に識別するフィールドの配列。 |
記録 | フィールドとそれに対応する値を含む JSON キーと値のペアのリスト。 |
関連オブジェクトのキー | 次のように構築される JSON オブジェクト: { リレーションシップ名: 文字列[] プライマリキー } |
例
関数 getExternalData(ctx){// 外部ソースからデータを取得するためのコードreturn [];}関数 ToHeatRecords(softwareList, sofrwareType, schemaTagToSoftwareType){var arrFinalizedSoftwareList = [];var isOptionalSoftware = (sofrwareType == 'OptionalSoftware');(ソフトウェアリスト内の変数項目){var srcObject = softwareList[item];var dsmSoftwareGUID = srcObject.UniqueKey.UniqueId;var softwareRevision = '';var isLastReleasedRev = false;var uninstallSupported = false;var reinstallSupported = false;(srcObject.PropGroupList 内の var idx) の場合{var tmpObjPropGrp = srcObject.PropGroupList[idx];(tmpObjPropGrp.PropertyList の var idx2) の場合{var tmpObjProp = tmpObjPropGrp.PropertyList[idx2];if (tmpObjProp.Tag == 'ソフトウェアリビジョン')ソフトウェアリビジョン = tmpObjProp.InternalValue;if ((tmpObjProp.Tag == 'IsLastReleasedRev') (tmpObjProp.InternalValue === true))isLastReleasedRev = true;if ((tmpObjProp.Tag == 'SupportsUninstall') (tmpObjProp.InternalValue === true))アンインストールサポート = true;if ((tmpObjProp.Tag == 'SupportsReinstall') (tmpObjProp.InternalValue === true))再インストールサポート = true;}}// ソフトウェア リビジョンとヒート ソフトウェア (FRSDSMSOFTWARE) を作成/更新しますvar relatedObjList = {'FRS_WS_DSM_SoftwareContainsFRS_WS_DSM_SoftwareRevision': [{DSMソフトウェアID: srcObject.ID、DSMソフトウェアGUID: dsmソフトウェアGUID、DSM作成日: srcObject.CreationDate、DSMModifiedDate: srcObject.ModificationDate、グループタイプ: srcObject.GroupType、ソフトウェア名: srcObject.Name、親コンテナID: srcObject.ParentContID、リビジョン: softwareRevision、スキーマタグ: srcObject.SchemaTag、ソフトウェアタイプ: ソフトタイプ、最終リリース日: 最終リリース日、アンインストール不可: uninstallSupported、再インストール可能: reinstallSupported}],'FRS_WS_DSM_SoftwareContainsFRS_DSM_Software': {ソフトウェアパッケージがリリースされているかどうか: true}};// ソフトウェア パッケージの作成/更新var finalizedSoftware = {フィールド: {DSMソフトウェアGUID: dsmソフトウェアGUID、HEATSMソフトウェアタイプ: ソフトウェアタイプ},関連: relatedObjList};var softType = (!!srcObject.SchemaTag && !!schemaTagToSoftwareType[srcObject.SchemaTag]) ? schemaTagToSoftwareType[srcObject.SchemaTag].SoftwareType : 'Undefined';if (isLastReleasedRev) {FinalizedSoftware.Fields.Name = srcObject.Name;finalizedSoftware.Fields.IsOptionalSoftware = isOptionalSoftware;finalizedSoftware.Fields.SchemaTag = srcObject.SchemaTag;最終化されたソフトウェア.Fields.SoftwareType = softType;finalizedSoftware.Fields.LastReleasedSoftwareID = srcObject.ID;}arrFinalizedSoftwareList.push(finalizedSoftware);}arrFinalizedSoftwareList を返します。}関数 GetSoftwareGUID(ソフトウェアリスト){if (Object.prototype.toString.call(softwareList) !== '[オブジェクト配列]')null を返します。var array = [];(var i = 0; i < softwareList.length; i ) の場合配列.push(softwareList[i].Fields.DSMSoftwareGUID);return array;}関数 SynchronizeHeatSM(isAll, sofrwareType, schemaTagToSoftwareType){if (すべて){var arrFinalizedSoftwareList = [];Array.prototype.push.apply(arrFinalizedSoftwareList、ToHeatRecords(getExternalData('AvailableSoftware')、'AvailableSoftware'、schemaTagToSoftwareType));Array.prototype.push.apply(arrFinalizedSoftwareList、ToHeatRecords(getExternalData('OptionalSoftware')、'OptionalSoftware'、schemaTagToSoftwareType));return SynchronizeAllHeatDataWithRelated('FRS_WS_DSM_Software', ['DSMSoftwareGUID'], arrFinalizedSoftwareList,{'FRS_WS_DSM_SoftwareContainsFRS_WS_DSM_SoftwareRevision': ['DSMSoftwareGUID'],'FRS_WS_DSM_SoftwareContainsFRS_DSM_Software': []});}それ以外{var arrFinalizedSoftwareList = ToHeatRecords(getExternalData(sofrwareType), sofrwareType, schemaTagToSoftwareType);var arrDSMSoftwareGUIDList = GetDSMSoftwareGUID(arrFinalizedSoftwareList);return SynchronizeHeatDataWithRelated('FRS_WS_DSM_Software', ['DSMSoftwareGUID'], arrFinalizedSoftwareList,{'FRS_WS_DSM_SoftwareContainsFRS_WS_DSM_SoftwareRevision': ['DSMSoftwareGUID'],'FRS_WS_DSM_SoftwareContainsFRS_DSM_Software': []},{DSMソフトウェアGUID: arrDSMソフトウェアGUIDList});}}方法
熱データの同期
説明
次の操作を実行して、アプリケーション内のビジネス オブジェクトについて、提供されたレコードを特定の条件を満たすすべてのレコードと同期します。
- 提供されたレコードに見つからない、アプリケーション内のレコード (ビジネス オブジェクトの特定の条件を満たすもの) を削除します。
- 提供されたレコード内で見つかったが、アプリケーション内にまだ存在しないレコード (ビジネス オブジェクトの特定の条件を満たすレコード) をアプリケーションに挿入します。
- 提供されたレコードに対して、アプリケーション内のレコード (ビジネス オブジェクトの特定の条件を満たすレコード) を更新します。
戻り値の型
この関数は、レコードの RecID の配列を返します。
意味
object[] SynchronizeHeatData(string designerName, string[] primaryKey, object[] records, object syncDataCondition)パラメータ
デザイナー名 | 同期されるビジネス オブジェクトの名前。 |
|---|---|
プライマリキー | 各レコードを一意に識別するフィールドの配列。 |
記録 | フィールドとそれに対応する値を含む JSON キーと値のペアのリスト。 |
同期データ条件 | データをいつ同期するかを指定します。 |
例
Sすべての熱データを同期する例を参照してください。
方法
熱データを関連データと同期する
説明
次の操作を実行して、アプリケーション内のビジネス オブジェクトおよび関連するビジネス オブジェクトについて、提供されたレコードを特定の条件を満たすすべてのレコードと同期します。
- 提供されたレコードに見つからない、アプリケーション内のレコード (ビジネス オブジェクトおよび関連するビジネス オブジェクトの特定の条件を満たすもの) を削除します。
- 提供されたレコード内で見つかったが、アプリケーション内にまだ存在しないレコード (ビジネス オブジェクトおよび関連するビジネス オブジェクトの特定の条件を満たすもの) をアプリケーションに挿入します。
- 提供されたレコードに対して、アプリケーション内のレコード (ビジネス オブジェクトおよび関連するビジネス オブジェクトについて、特定の条件を満たすレコード) を更新します。
戻り値の型
この関数は、レコードの RecID の配列を返します。
意味
object[] SynchronizeHeatDataWithRelated(string designerName, string[] primaryKey, object[] records, object keysOfRelatedObjects, object syncDataCondition)パラメータ
デザイナー名 | 同期されるビジネス オブジェクトの名前。 |
|---|---|
プライマリキー | 各レコードを一意に識別するフィールドの配列。 |
記録 | フィールドとそれに対応する値を含む JSON キーと値のペアのリスト。 |
関連オブジェクトのキー | 次のように構築される JSON オブジェクト: { リレーションシップ名: 文字列[] プライマリキー } |
同期データ条件 | データをいつ同期するかを指定します。 |
例
Sすべての熱データを関連データと同期する例を参照してください。
方法
HeatUtility.HtmlEncode
説明
渡されたパラメータ文字列にある ?、、 <, >などの HTML 特殊文字をエンコードします。 詳細については、 https://msdn.microsoft.com/en-us/library/73z22y6h(v=vs.110).aspx を参照してください。
返品
エンコードされた HTML 文字列。
意味
文字列 HeatUtility.HtmlEncode(文字列 s);パラメータ
S | エンコードされる HTML 特殊文字を含む文字列。 |
|---|
例
HeatUtility.HtmlEncode ("<script>安全ではありません</script>");
方法
HeatUtility.Htmlデコード
説明
渡されたパラメータ文字列にある ?、、 <, >などの HTML 特殊文字をデコードします。 詳細については、 https://msdn.microsoft.com/en-us/library/7c5fyk1k(v=vs.110).aspx を参照してください。
返品
デコードされた HTML 文字列。
意味
文字列 HeatUtility.HtmlDecode(文字列 s);パラメータ
S | デコードする HTML 特殊文字を含む文字列。 |
|---|
例
HeatUtility.HtmlDecode ("lt;scriptgt;unsafelt;/scriptgt;");方法
HeatUtility.HexToBytes
説明
16 進数でエンコードされたバイト ストリームをバイトに変換します。
返品
16 進数から変換されたバイト。
意味
byte[] HeatUtility.HexToBytes(文字列 16進数);パラメータ
16進数 | 16 進文字を含む文字列。 |
|---|
例
HeatUtility.HexToBytes("0123456789ABCDEFabcdef");方法
HeatUtility.BytesTo 文字列
説明
バイト ストリームを文字列に変換します。 詳細については、 https://msdn.microsoft.com/en-us/library/744y86tc(v=vs.110).aspx を参照してください。
返品
バイトから変換された文字列。
意味
文字列 HeatUtility.BytesToString(byte[] データ、文字列エンコーディング);パラメータ
データ | エンコードされたバイトのストリーム。 |
|---|---|
エンコーディング | エンコードされた形式。 ASCII、UTF7、UTF8、UTF16、UTF16BE、UTF32 のいずれかになります。 |
例
HeatUtility.BytesToString([48, 49, 50, 51, 52, 53, 54, 55, 56, 57], 'UTF8');方法
HeatUtility.LoadXml
説明
指定された XML テキストから XML ドキュメント オブジェクトを作成します。 詳細については、 https://msdn.microsoft.com/en-us/library/system.xml.xmldocument.loadxml(v=vs.110).aspx を参照してください。
返品
指定された XML 文字列から作成された XML ドキュメント オブジェクト。
意味
XmlElement HeatUtility.LoadXml(string xml);パラメータ
テキスト | 文字列形式の XML。 |
|---|
例
HeatUtility.LoadXml("<Books><Book name="Author Name"Publisher="Some publisher"></Book></Books>");方法
HeatUtility.GetCultureInfo
説明
指定されたカルチャ ID またはロケール ID のカルチャ インスタンスを取得します。 詳細については、 yck8b540(v=vs.110).aspx または w4deeh00(v=vs.110).aspx を参照してください。
返品
指定されたカルチャまたはロケールの CultureInfo オブジェクト。
意味
文化情報 HeatUtility.GetCultureInfo(文字列 ID);CultureInfo HeatUtility.GetCultureInfo(int lcid);パラメータ
ID | 文化 ID。 例は、us en-US です。 |
|---|---|
液晶 | 文化ロケール ID。 例は 0x0409 です。 |
例
HeatUtility.GetCultureInfo("en-US");HeatUtility.GetCultureInfo(0x0409);HeatUtility.GetCultureInfo(1033);方法
HeatUtility.GetTimeZoneInfo
説明
指定された Microsoft Windows タイム ゾーンまたは IANA タイム ゾーンのタイム ゾーン情報を取得します。 詳細については、 system.timezoneinfo.findsystemtimezonebyid(v=vs.110).aspx を参照してください。
返品
指定されたタイムゾーンの TimeZoneInfo オブジェクト。 TimeZoneInfo オブジェクトには、 TImezones ワークスペースからのデータが含まれています。 タ日付、時刻、タイムゾーンの操作ワークスペースの詳細については、「 日付、時刻、およびタイムゾーンの操作 」を参照してください。
意味
TimeZoneInfo HeatUtility.GetTimeZoneInfo(文字列 ianaOrWindowsTimeZone);パラメータ
ianaまたはWindowsタイムゾーン | Microsoft Windows または IANA のタイム ゾーン。 |
|---|
例
HeatUtility.GetTimeZoneInfo("太平洋標準時");HeatUtility.GetTimeZoneInfo("アメリカ/ロサンゼルス");方法
HeatUtility.ハッシュ
説明
指定されたアルゴリズムを使用して、指定された文字列テキストのハッシュ値を生成します。 詳細については、 https://msdn.microsoft.com/en-us/library/wet69s13(v=vs.110).aspx を参照してください。
返品
生成されたハッシュ値。
意味
byte[]HeatUtility.Hash(文字列ハッシュアルゴリズム、文字列データ);byte[]HeatUtility.Hash(文字列ハッシュアルゴリズム、byte[]データ);パラメータ
ハッシュアルゴリズム | 使用するハッシュ アルゴリズム。 |
|---|---|
データ | ハッシュされるデータ。 |
例
HeatUtility.Hash("SHA1","このメッセージは署名が必要です。");HeatUtility.Hash("SHA1", [100, 101,102,103, 104, 105, 200]);方法
HeatUtility.KeyedHash
説明
指定されたアルゴリズムとキーを使用して、指定された文字列テキストのハッシュ値を生成します。 詳細については、 https://msdn.microsoft.com/library/s5zz2x4d(v=vs.100).aspx を参照してください。
返品
生成されたハッシュ値。
意味
byte[]HeatUtility.KeyedHash(文字列ハッシュアルゴリズム、byte[]キー、文字列データ);byte[]HeatUtility.KeyedHash(文字列ハッシュアルゴリズム、byte[]キー、byte[]データ);パラメータ
ハッシュアルゴリズム | 使用するハッシュ アルゴリズム。 |
|---|---|
鍵 | キーを含むバイトの配列。 |
データ | ハッシュされるデータ。 |
例
HeatUtility.KeyedHash ("HMACSHA1, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "このメッセージには署名が必要です。");HeatUtility.KeyedHash ("HMACSHA1、[1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、16]、[100、101、102、103、104、105、200]);