DevOpsOrquestrationIntegrationHandler - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 2 min. de leitura
  • . DevOpsOrquestrationIntegrationHandler A API permite o processamento de cargas úteis de personalizadas DevOps ferramentas.

    Um personalizado DevOps ferramenta é qualquer ferramenta que não tenha uma integração com DevOps. Para obter uma lista de ferramentas que têm DevOps integrações, consulte DevOps Change Velocity integrations.

    Esta API permite o processamento de cargas que são usadas pelo endpoint REST DevOps - POST /devops/tool/ . Você deve implementar os métodos desta API em uma inclusão de script antes de chamar o. PUBLICAR /devops/tool/ endpoint.

    Esta API é executada no sn_devops namespace. Para obter mais informações sobre DevOps, consulte DevOps Config.

    DevOpsOrquestrationIntegrationHandler - getNativeIdForOrquestrationTask (carga do objeto)

    Retorna o valor de orchestrationTaskNameparâmetro da carga para PUBLICAR /devops/tool/ endpoint.

    Você deve implementar este método em uma inclusão de script antes de chamar o endpoint REST DevOps - POST /devops/tool/ .

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    carga Objeto Carga que contém dados da ferramenta personalizada que é aceita pelo endpoint REST PUBLICAR /devops/tool/ , em que capability. orquestração .
    Tabela 2. Retornos
    Tipo Descrição
    Cadeia de caracteres Valor de orchestrationTaskNameparâmetro da carga.

    Neste exemplo, uma inclusão de script chamada DevOpsOrquestrationCustomToolIntegrationHandler implementa os métodos HandleTool e. GetNativeIdForOrquestrationTask . . GetNativeIdForOrquestrationTask o método é implementado para retornar o valor de orchestrationTaskNameParâmetro da carga para POST /devops/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' 
    
    }; 

    DevOpsOrquestrationToolIntegrationHandler - handleTool(String toolName)

    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/ .

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    toolName Cadeia de caracteres Nome da ferramenta.

    Tabela: Nome da ferramenta Campo da tabela Integração da ferramenta DevOps [sn_devops_tool_integration]

    Tabela 4. Retornos
    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.

    Neste exemplo, uma inclusão de script chamada DevOpsOrquestrationCustomToolIntegrationHandler implementa os métodos HandleTool e. GetNativeIdForOrquestrationTask . . HandleTool o método é implementado para verificar se o nome passado é para a ferramenta correta. Substituir "n_devops_custom_tool" com o 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' 
    
    };