---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ja-JP
ft:publication_title :
- Xanadu API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# DevOpsOrchestrationToolIntegrationHandler - スコープ付き
# DevOpsOrchestrationToolIntegrationHandler - スコープ付き {#ariaid-title1}
* リリースバージョン: Xanadu
*
* 更新日 2024年08月01日
*
*  所要時間：5分
DevOpsOrchestrationToolIntegrationHandler API を使用すると、カスタム DevOps ツールからのペイロードを処理できます。
カスタム DevOps ツールは、DevOps との統合を持たないツールです。DevOps統合されているツールのリストについては、「[DevOps Change Velocity integrations](https://www.servicenow.com/docs/access?context=dev-ops-overview&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US)」を参照してください。
この API は、REST エンドポイント [DevOps - POST /devops/tool/{capability}](https://servicenow-prod.fluidtopics.net/4_G7IAvA3mmjYCahtODhOw#devops-POST-tool "カスタム DevOps サブフローで処理するために、渡されたペイロードを受信イベント [sn_devops_inbound] テーブルにポストします。") で使用されるペイロードの処理を有効にします。POST /devops/tool/{capability} エンドポイントを呼び出す前に、この API のメソッドをスクリプトインクルードに実装する必要があります。
この API は `sn_devops` 名前空間で実行されます。DevOps の詳細については、「[DevOps Config](https://www.servicenow.com/docs/access?context=devops-config-landing-page&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US)」を参照してください。
## DevOpsOrchestrationToolIntegrationHandler - getNativeIdForOrchestrationTask(オブジェクト payload) {#ariaid-title2}
POST /devops/tool/{capability} エンドポイントのペイロードから orchestrationTaskName パラメーターの値を返します。
REST エンドポイント [DevOps - POST /devops/tool/{capability}](https://servicenow-prod.fluidtopics.net/4_G7IAvA3mmjYCahtODhOw#devops-POST-tool "カスタム DevOps サブフローで処理するために、渡されたペイロードを受信イベント [sn_devops_inbound] テーブルにポストします。") を呼び出す前に、このメソッドをスクリプトインクルードに実装する必要があります。
{#DevOpsOrchToolIntH-getNIdOrchTask_O__table_mnx_hvm_ctb__entry__3}
| 名前 | タイプ | 説明 |
|-|-|-|
| payload | オブジェクト | REST エンドポイント POST /devops/tool/{capability} によって受け入れられるカスタムツールからのデータを含むペイロードです。ここで capability は orchestration です。 |
[表 : 1. パラメーター]
{#DevOpsOrchToolIntH-getNIdOrchTask_O__table_mnx_hvm_ctb} {#DevOpsOrchToolIntH-getNIdOrchTask_O__table_nnx_hvm_ctb__entry__2}
| タイプ | 説明 |
|-|-|
| 文字列 | ペイロードの orchestrationTaskName パラメーターの値です。 |
[表 : 2. 返される内容]
{#DevOpsOrchToolIntH-getNIdOrchTask_O__table_nnx_hvm_ctb}
この例では、DevOpsOrchestrationCustomToolIntegrationHandler という名前のスクリプトインクルードが、handleTool メソッドと getNativeIdForOrchestrationTask メソッドを実装しています。getNativeIdForOrchestrationTask メソッドは、POST /devops/tool/{capability} のペイロードから orchestrationTaskName パラメーターの値を返すために実装されています。
var DevOpsOrchestrationCustomToolIntegrationHandler = Class.create();
DevOpsOrchestrationCustomToolIntegrationHandler.prototype = {
handleTool: function(toolName) {
if (!gs.nil(toolName) && toolName == 'sn_devops_custom_tool')
return true;
return false;
},
getNativeIdForOrchestrationTask: function(payload) {
return payload.orchestrationTaskName;
},
type: 'DevOpsOrchestrationCustomToolIntegrationHandler'
};
## DevOpsOrchestrationToolIntegrationHandler - handleTool(文字列 toolName) {#ariaid-title3}
このハンドラーが、指定されたツールに対して有効かどうかを確認します。
[DevOps - POST /devops/tool/{capability}](https://servicenow-prod.fluidtopics.net/4_G7IAvA3mmjYCahtODhOw#devops-POST-tool "カスタム DevOps サブフローで処理するために、渡されたペイロードを受信イベント [sn_devops_inbound] テーブルにポストします。") を呼び出す前に、このメソッドをスクリプトインクルードに実装する必要があります。
{#DevOpsOrchToolIntH-handleTool_S__table_gtf_1vm_ctb__entry__3}
| 名前 | タイプ | 説明 |
|-|-|-|
| toolName | 文字列 | ツールの名前です。DevOps ツール統合 \[sn_devops_tool_integration\] テーブルの Tool Name フィールドにあります。 |
[表 : 3. パラメーター]
{#DevOpsOrchToolIntH-handleTool_S__table_gtf_1vm_ctb} {#DevOpsOrchToolIntH-handleTool_S__table_htf_1vm_ctb__entry__2}
| タイプ | 説明 |
|-|-|
| ブーリアン | このハンドラーが、指定されたツールに対して有効かどうかを示すフラグです。 可能な値： * true：このハンドラーは指定されたツールに使用できます。 * false：このハンドラーは指定されたツールに使用できません。 {#DevOpsOrchToolIntH-handleTool_S__ul_ovl_gb4_ctb} |
[表 : 4. 返される内容]
{#DevOpsOrchToolIntH-handleTool_S__table_htf_1vm_ctb}
この例では、DevOpsOrchestrationCustomToolIntegrationHandler という名前のスクリプトインクルードが、handleTool メソッドと getNativeIdForOrchestrationTask メソッドを実装しています。handleTool メソッドは、渡された名前が正しいツールのものであることを確認するために実装されています。`'sn_devops_custom_tool'` を、使用しているツールの名前に置き換えます。
var DevOpsOrchestrationCustomToolIntegrationHandler = Class.create();
DevOpsOrchestrationCustomToolIntegrationHandler.prototype = {
handleTool: function(toolName) {
if (!gs.nil(toolName) && toolName == 'sn_devops_custom_tool')
return true;
return false;
},
getNativeIdForOrchestrationTask: function(payload) {
return payload.orchestrationTaskName;
},
type: 'DevOpsOrchestrationCustomToolIntegrationHandler'
};