---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DevOpsOrchestrationToolIntegrationHandler - Com escopo

# DevOpsOrchestrationToolIntegrationHandler - Com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

A API DevOpsOrchestrationToolIntegrationHandler permite o processamento de cargas de ferramentas DevOps personalizadas.

Uma ferramenta DevOps personalizada é qualquer ferramenta que não tenha uma integração com DevOps. Para obter uma lista de ferramentas que têm integrações DevOps, consulte [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).

Esta API permite o processamento de cargas úteis que são usadas pelo endpoint REST [DevOps - POST /devops/tool/{capability}](https://servicenow-prod.fluidtopics.net/GsqGtq0ePQcBgIpsi6XDQA#devops-POST-tool "Publica a carga passada na tabela de eventos de entrada [sn_devops_inbound] para processamento por um subfluxo DevOps personalizado."). Você deve implementar os métodos desta API em uma inclusão de script antes de chamar o endpoint POST /devops/tool/{capability}.

Esta API é executada no namespace `sn_devops`. Para obter mais informações sobre DevOps, consulte [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 (carga do objeto) {#ariaid-title2}

Retorna o valor do parâmetro orchestrationTaskName da carga para o endpoint POST /devops/tool/{capability}.
Você deve implementar este método em uma inclusão de script antes de chamar o endpoint REST [DevOps - POST /devops/tool/{capability}](https://servicenow-prod.fluidtopics.net/GsqGtq0ePQcBgIpsi6XDQA#devops-POST-tool "Publica a carga passada na tabela de eventos de entrada [sn_devops_inbound] para processamento por um subfluxo DevOps personalizado.").
{#DevOpsOrchToolIntH-getNIdOrchTask_O__table_mnx_hvm_ctb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| carga | Objeto | Carga que contém dados da ferramenta personalizada que são aceitos pelo endpoint REST POST /devops/tool/{capability}, em que capability é <kbd class="ph userinput">a orquestração</kbd>. |
[Tabela 1. Parâmetros]

{#DevOpsOrchToolIntH-getNIdOrchTask_O__table_mnx_hvm_ctb} {#DevOpsOrchToolIntH-getNIdOrchTask_O__table_nnx_hvm_ctb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor do parâmetro orchestrationTaskName da carga útil. |
[Tabela 2. Retorna]

{#DevOpsOrchToolIntH-getNIdOrchTask_O__table_nnx_hvm_ctb}  
Neste exemplo, uma inclusão de script chamada <kbd class="ph userinput">DevOpsOrchestrationCustomToolIntegrationHandler</kbd> implementa os métodos handleTool e getNativeIdForOrchestrationTask. O método getNativeIdForOrchestrationTask é implementado para retornar o valor do parâmetro orchestrationTaskName da carga para POST /devops/tool/{capability}.

    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(String toolName) {#ariaid-title3}

Verifica se este manipulador é válido para a ferramenta especificada.
Você deve implementar este método em uma inclusão de script antes de chamar [DevOps - POST /devops/tool/{capability}](https://servicenow-prod.fluidtopics.net/GsqGtq0ePQcBgIpsi6XDQA#devops-POST-tool "Publica a carga passada na tabela de eventos de entrada [sn_devops_inbound] para processamento por um subfluxo DevOps personalizado.").
{#DevOpsOrchToolIntH-handleTool_S__table_gtf_1vm_ctb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| toolName | Cadeia de caracteres | Nome da ferramenta. Localizado no campo Nome da ferramenta na tabela Integração da ferramenta de DevOps \[sn_devops_tool_integration\]. |
[Tabela 3. Parâmetros]

{#DevOpsOrchToolIntH-handleTool_S__table_gtf_1vm_ctb} {#DevOpsOrchToolIntH-handleTool_S__table_htf_1vm_ctb__entry__2}

| Tipo | Descrição |
|-|-|
| Booliano | Sinalizador que indica se este manipulador é válido para a ferramenta especificada. Valores possíveis: * verdadeiro: este manipulador pode ser usado para a ferramenta especificada. * falso: este manipulador não pode ser usado para a ferramenta especificada. {#DevOpsOrchToolIntH-handleTool_S__ul_ovl_gb4_ctb} |
[Tabela 4. Retorna]

{#DevOpsOrchToolIntH-handleTool_S__table_htf_1vm_ctb}  
Neste exemplo, uma inclusão de script chamada <kbd class="ph userinput">DevOpsOrchestrationCustomToolIntegrationHandler</kbd> implementa os métodos handleTool e getNativeIdForOrchestrationTask. O método handleTool é implementado para verificar se o nome passado é para a ferramenta correta. Substitua `"sn_devops_custom_tool"` pelo nome da ferramenta que você está usando.

    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' 

    };