--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # LeadAPIProcessUtilOOB - スコープ指定 # LeadAPIProcessUtilOOB - スコープ指定 {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：11分 LeadAPIProcessUtilOOB スクリプトインクルードは、リードレコードとそれに関連するリード品目レコードを取得するためにリード REST API によって呼び出されるメソッドを提供します。 [リード API](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-api "リード API は、インスタンスからマーケティングリードとそれに関連するリード品目を作成、更新、およびクエリ/取得できるようにするエンドポイントを提供します。") メソッドが呼び出されたときにリードレコードを取得する方法をカスタマイズする場合は、LeadAPIProcessUtil スクリプトインクルードのこのスクリプトインクルードのメソッドを上書きします。LeadAPIProcessUtil スクリプトインクルードで上書きするメソッドの名前は、LeadAPIProcessUtilOOB スクリプトインクルードファイル内のものと同じである必要があります。 この API は、 `sn_lead_mgmt_core` 名前空間内で提供されます。API にアクセスするには、リード管理データモデル (sn_lead_mgmt_core) プラグインをインスタンスでアクティブ化する必要があり、呼び出し元ユーザーには sn_lead_mgmt_core.lead_integrator ロールが必要です。 リード管理の詳細については、「[Using Lead Management](https://www.servicenow.com/docs/access?context=lead-management-using&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 ## LeadAPIProcessUtilOOB - processCreateLead (オブジェクト requestBody) {#ariaid-title2} 要求本文を処理し、渡されたパラメーターに基づいてリードとそれに関連するすべての品目を作成します。 レコードは次のテーブルに挿入されます。 * リード \[sn_lead_mgmt_core_lead\] * リード品目 \[sn_lead_mgmt_core_lead_line_item\] {#LAPU-processCreateLead_O__table_sxx_crr_ydc__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | requestBody | オブジェクト | 作成するリードとそれに関連するリード品目の要求本文。 このオブジェクトの内容の詳細については、「 [リード:投稿 /sn_lead_mgmt_core/リード](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-POST-lead "指定されたパラメーターを使用して、リードレコードとそれに関連するリード品目を作成します。")」を参照してください。 | [表 : 1. パラメーター] {#LAPU-processCreateLead_O__table_sxx_crr_ydc} {#LAPU-processCreateLead_O__table_txx_crr_ydc__entry__2} | タイプ | 説明 | |-|-| | JSON オブジェクト | 保存されたリードおよびリード品目レコードの詳細。 データタイプ: オブジェクト { "body": {Object}, "status": "String" } | | \.body | 応答本文。 応答成功:要求されたリードレコード内のすべてのフィールドと、関連するリード品目レコード内のすべてのフィールド。返されるフィールドの説明については、「 [リード:投稿 /sn_lead_mgmt_core/リード](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-POST-lead "指定されたパラメーターを使用して、リードレコードとそれに関連するリード品目を作成します。")」を参照してください。 エラー応答:要求の処理を試行したときに検出されたエラーのリスト。これらのエラーメッセージは、 LeadAPIConstants スクリプトインクルードで定義されています。 データタイプ: オブジェクト | | \.status | 応答ステータスコード。 これらのステータスコードは、 LeadAPIConstants スクリプトインクルードで定義されます。 データタイプ：文字列 | [表 : 2. 返される内容] {#LAPU-processCreateLead_O__table_txx_crr_ydc} 次のコード例は、LeadAPIProcessUtil スクリプトインクルードの processCreateLead() メソッドのカスタムコードを追加する場所を示しています。 var LeadAPIProcessUtil = Class.create(); LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { // Define overriding functions here processCreateLead: function(requestBody) { // Add your custom code }, type: 'LeadAPIProcessUtil' }); ## LeadAPIProcessUtilOOB - processGetAllLeads (オブジェクト queryParams、文字列 requestUrl) {#ariaid-title3} 渡されたフィルター基準に基づいて、すべてのリードレコードと関連する品目レコードを取得します。このメソッドは、関連するレコード内のすべてのフィールドを返します。 レコードの詳細は、次のテーブルからフェッチされます。 * リード \[sn_lead_mgmt_core_lead\] * リード品目 \[sn_lead_mgmt_core_lead_line_item\] {#LAPU-processGetAllLeads_O_S__table_igt_klr_ydc__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | queryParams | オブジェクト | リードレコードを取得するときに適用するクエリパラメーターを含むオブジェクト。これらは、 [lead:GET /sn_lead_mgmt_core/lead](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-GET-lead "クエリパラメーターで渡されたフィルター基準に基づいて、すべてのリードと関連するリード品目を取得します。") エンドポイントで渡されるクエリパラメーターです。 例： { "sysparm_fields":["first_name,last_name,sys_id,lead_line_items"], "sysparm_query":["lead_type=new_business"], "sysparm_offset":["2"],"sysparm_limit":["25"] } | | requestUrl | 文字列 | 要求 URL。ページネーションされた応答を処理するときにこの URL を渡して、メソッドが応答内のすべてのページへのリンクを持つようにします。 | [表 : 3. パラメーター] {#LAPU-processGetAllLeads_O_S__table_igt_klr_ydc} {#LAPU-processGetAllLeads_O_S__table_jgt_klr_ydc__entry__2} | タイプ | 説明 | |-|-| | JSON オブジェクト | 要求されたリードおよびリード品目レコードの詳細。 データタイプ: オブジェクト { "body": [Array], "contentRange": "String", "links": "String", "status": "String", "totalCount": "Number" } 要求の処理中にエラーが発生した場合、JSON オブジェクトには `本文` と `ステータス` のパラメーターのみが含まれます。 | | \.body | 応答本文。 成功した応答:リードレコードと関連するすべてのリード品目レコードを含む各オブジェクトを含むオブジェクトのアレイ。要求されたリードレコード内のすべてのフィールドと、関連するリード品目レコード内のすべてのフィールドが返されます。返されるフィールドの説明については、「 [lead:GET /sn_lead_mgmt_core/lead](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-GET-lead "クエリパラメーターで渡されたフィルター基準に基づいて、すべてのリードと関連するリード品目を取得します。")」を参照してください。 エラー応答:要求の処理を試行したときに検出されたエラーのリスト。これらのエラーメッセージは、 LeadAPIConstants スクリプトインクルードで定義されています。 データタイプ：オブジェクトのアレイ | | \.contentRange | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、offset=2 で limit=3 の場合、このパラメーターの値はアイテム 3 から 5 です。 データタイプ：文字列 | | \.links | ページネーションされた応答の場合は、応答に含まれる各ページへのカンマ区切りのリンク。 例： ;rel="self", ;rel="last", ;rel="next" データタイプ：文字列 | | \.status | 応答ステータスコード。 これらのステータスコードは、 LeadAPIConstants スクリプトインクルードで定義されます。 データタイプ：文字列 | | \.totalCount | メソッドから返されたリードレコードの合計数。 データタイプ:数値 (整数) | [表 : 4. 返される内容] {#LAPU-processGetAllLeads_O_S__table_jgt_klr_ydc} 次のコード例は、LeadAPIProcessUtil スクリプトインクルードの processGetAllLeads() メソッドのカスタムコードを追加する場所を示しています。 var LeadAPIProcessUtil = Class.create(); LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { // Define overriding functions here processGetAllLeads: function(queryParams, requestUrl) { // Add your custom code here }, type: 'LeadAPIProcessUtil' }); ## LeadAPIProcessUtilOOB - processGetLeadById (文字列 ID) {#ariaid-title4} 指定されたリードレコードとそれに関連する品目レコードを取得します。このメソッドは、関連するレコード内のすべてのフィールドを返します。 レコードの詳細は、次のテーブルからフェッチされます。 * リード \[sn_lead_mgmt_core_lead\] * リード品目 \[sn_lead_mgmt_core_lead_line_item\] {#LAPU-processGetLeadById_S__table_fvz_qcl_ydc__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | ID | 文字列 | 取得するリードレコードのSys_id。 テーブル:リード \[sn_lead_mgmt_core_lead\] | [表 : 5. パラメーター] {#LAPU-processGetLeadById_S__table_fvz_qcl_ydc} {#LAPU-processGetLeadById_S__table_gvz_qcl_ydc__entry__2} | タイプ | 説明 | |-|-| | JSON オブジェクト | 要求されたリードおよびリード品目レコードの詳細。 データタイプ: オブジェクト { "body": {Object}, "status": "String" } | | \.body | 応答本文。 応答成功:要求されたリードレコード内のすべてのフィールドと、関連するリード品目レコード内のすべてのフィールド。返されるフィールドの説明については、「 [lead:GET /sn_lead_mgmt_core/lead/{sys_id}](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-GET-lead-sys_id "指定されたsys_idのリードレコードと関連するすべてのリード品目を返します。")」を参照してください。 エラー応答:要求の処理を試行したときに検出されたエラーのリスト。これらのエラーメッセージは、 LeadAPIConstants スクリプトインクルードで定義されています。 データタイプ: オブジェクト | | \.status | 応答ステータスコード。 これらのステータスコードは、 LeadAPIConstants スクリプトインクルードで定義されます。 データタイプ：文字列 | [表 : 6. 返される内容] {#LAPU-processGetLeadById_S__table_gvz_qcl_ydc} 次のコード例は、LeadAPIProcessUtil スクリプトインクルードの processGetLeadById() メソッドのカスタムコードを追加する場所を示しています。 var LeadAPIProcessUtil = Class.create(); LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { // Define overriding functions here processGetLeadById: function(id) { // Add your custom code here }, type: 'LeadAPIProcessUtil' }); ## LeadAPIProcessUtilOOB - processUpdateLead (オブジェクト requestBody、文字列 ID) {#ariaid-title5} 要求本文を処理し、渡されたパラメーターに基づいて、指定されたリードとそれに関連するすべての品目を更新します。 次のテーブルのレコードが更新されます。 * リード \[sn_lead_mgmt_core_lead\] * リード品目 \[sn_lead_mgmt_core_lead_line_item\] {#LAPU-processUpdateLead_O_S__table_n24_k5r_ydc__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | requestBody | オブジェクト | 更新するリードの要求本文とそれに関連するリード品目フィールド。 このオブジェクトの内容の詳細については、「 [リード - PATCH /sn_lead_mgmt_core/lead/{sys_id}](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-PATCH-lead "指定されたリードレコードとそれに関連するリード品目を更新します。このエンドポイントを使用して、指定したリードに新しいリード品目を関連付けることもできます。")」を参照してください。 | | ID | 文字列 | 更新するリードレコードのSys_id。 テーブル:リード \[sn_lead_mgmt_core_lead\] | [表 : 7. パラメーター] {#LAPU-processUpdateLead_O_S__table_n24_k5r_ydc} {#LAPU-processUpdateLead_O_S__table_o24_k5r_ydc__entry__2} | タイプ | 説明 | |-|-| | JSON オブジェクト | 保存されたリードおよびリード品目レコードの詳細。 データタイプ: オブジェクト { "body": {Object}, "status": "String" } | | \.body | 応答本文。 応答成功:更新されたリードレコードのすべてのフィールドと、関連するリード品目レコードのすべてのフィールド (更新済みかどうか)。返されるフィールドの説明については、「 [リード - PATCH /sn_lead_mgmt_core/lead/{sys_id}](https://servicenow-prod.fluidtopics.net/SBBDQjGMRWqTI2truK5nnw#lead-PATCH-lead "指定されたリードレコードとそれに関連するリード品目を更新します。このエンドポイントを使用して、指定したリードに新しいリード品目を関連付けることもできます。")」を参照してください。 エラー応答:要求の処理を試行したときに検出されたエラーのリスト。これらのエラーメッセージは、 LeadAPIConstants スクリプトインクルードで定義されています。 データタイプ: オブジェクト | | \.status | 応答ステータスコード。 これらのステータスコードは、 LeadAPIConstants スクリプトインクルードで定義されます。 データタイプ：文字列 | [表 : 8. 返される内容] {#LAPU-processUpdateLead_O_S__table_o24_k5r_ydc} 次のコード例は、LeadAPIProcessUtil スクリプトインクルードの processUpdateLead() メソッドのカスタムコードを追加する場所を示しています。 var LeadAPIProcessUtil = Class.create(); LeadAPIProcessUtil.prototype = Object.extendsObject(LeadAPIProcessUtilOOB, { // Define overriding functions here processUpdateLead: function(requestBody, id) { // Add your custom code here }, type: 'LeadAPIProcessUtil' });