Vinculando objetos a Serviços Web REST

Você pode adicionar o comportamento Serviço Web REST a um objeto com o Design de Objeto, a fim de fornecer uma ampla gama de opções para integração com outros aplicativos, como o Ivanti Automation.

Trata-se de um recurso avançado destinado a pessoas familiarizadas com o uso de tecnologias como REST, JSON, Postman e Swagger. Caso deseje suporte da Ivanti Professional Services para usar esse recurso, entre em contato com seu fornecedor.

Antes de configurar o Service Desk

Antes de começar a configurar o comportamento no Service Desk, recomendamos que você primeiro use ferramentas como Swagger e Postman para projetar e configurar a interação com o ponto de extremidade, no intuito de conduzir qualquer depuração necessária. Depois de testar as interações dessa maneira, você pode configurar o Service Desk para reproduzi-las.

Também recomendamos que você projete essas novas partes em uma instância de desenvolvimento, teste-as completamente e depois transfira esses designs para produção, ao invés de aplicar qualquer novo conteúdo diretamente no ambiente de produção. Para mais detalhes, consulte Promovendo designs REST em seus ambientes de produção.

Configurando o Service Desk

Após ter projetado e testado suas chamadas de API RESTful fora do Service Desk, reproduza essas interações nos designers do Service Desk. Esteja ciente de que a chamada REST é feita apenas quando se cria uma instância de objeto com o comportamento REST. Atualizar e salvar o objeto novamente não envia outra chamada REST.

A primeira etapa é adicionar o comportamento do serviço web REST ao objeto que você deseja usar para integrar com o ponto de extremidade.

Para adicionar o comportamento Serviço Web REST a um objeto:
  1. No Designer de Objeto, abra o objeto com o qual deseja usar o serviço web REST.
  2. Selecione o objeto no topo da árvore Atributos e, em seguida, na grade Propriedades, clique em ícone de reticências junto a Comportamentos.
    A caixa de diálogo Seleção de Comportamentos é exibida.
  3. Selecione Serviço Web REST na lista Itens disponíveis e clique em ícone de seta para a direita.
    O Serviço Web REST é movido para a litas Itens selecionados.
  4. Clique em OK e salve as alterações.
    O diálogo Seleção de Comportamento se fecha, e um novo item, Serviços Web REST, aparece na grade Propriedades.
    Além disso, quatro novos atributos são criados no objeto: Corpo da Solicitação de Criação do Serviço Rest, Status de Criação do Serviço Rest, URI da Solicitação de Criação do Serviço Rest e um relacionamento chamado Modelo de Corpo da Solicitação de Criação do Serviço Rest, que é um relacionamento com um novo objeto de lista de referência chamado ObjectBody. (Onde Objeto é o nome do objeto ao qual você adicionou o comportamento.)

    5. Você precisará criar janelas para todos os novos objetos criados.

  5. Na grade Propriedades, clique em ícone de reticências ao lado de Serviços Web REST.
    O diálogo Serviços Web REST é exibido.
  6. Na guia Solicitação, digite o URI do ponto de extremidade que você deseja usar no campo URI do Ponto de Extremidade.

    7. Você pode incluir variáveis ​​de espaço reservado no campo URI do Ponto de Extremidade. Isso geralmente é feito para PATCH.

  7. Selecione POST, PATCH ou DELETE conforme apropriado.
    Post é normalmente usado para criar itens, enquanto Patch é usado para atualizar itens existentes. Se você deseja criar um item usando o serviço web REST e, em seguida, atualizar o mesmo item usando o serviço web REST, precisará criar dois objetos: um para criar o item usando Post e outro para atualizar o item usando Patch.
  8. Na lista suspensa Tipo de Conteúdo, selecione o tipo de conteúdo que você está enviando.
  9. Na lista Tipo de Autenticação, selecione o tipo de autenticação necessário: Nenhum, Básico, Chave de API (cabeçalho), OAuth2 (credenciais do cliente)ou OAuth2 (senha), juntamente com os respectivos parâmetros adicionais.
  10. Clique em OK.

Pode haver momentos em que você queira desativar temporariamente o comportamento REST. Você pode fazer isso para um objeto específico desmarcando a caixa de seleção Habilitar, na caixa de diálogo Serviços Web REST.

Se você quiser executar outras ações no registro criado com o serviço web REST, precisará especificar o caminho para o identificador exclusivo retornado por seu aplicativo externo e o local no Service Desk onde deseja armazenar essas informações.

Para armazenar identificadores exclusivos:

  1. Na guia Mapeamento de Resposta da caixa de diálogo Seleção de Comportamento, no campo Origem insira o caminho para o identificador exclusivo retornado pelo seu aplicativo externo.
    Você pode usar notação de ponto para identificar itens na carga de origem. Insira * se quiser usar a resposta inteira.
  2. No campo Destino, insira o atributo tipo string em que você deseja armazenar o valor retornado no Service Desk.
    Isso estará no formato {_Request/Field}.
  3. Na lista suspensa Aceitar, selecione o tipo de conteúdo que espera receber.
    Se selecionar um formato XML, especifique Namespaces XML, separando os nomes dos vários namespaces com espaços. Por exemplo, xmlns:h="http://www.w3.org/TR/html4/" xmlns:r="http://www.example.com/example/"
  4. Clique em OK.

Agora que você configurou o link entre o objeto Service Desk e o ponto de extremidade, pode especificar o corpo da carga que deseja enviar. A carga deve ser JSON ou XML. Alguns pontos de extremidade aceitam várias cargas diferentes. Por exemplo, o Ivanti Automation fornece um único ponto de extremidade que aceita cargas para vários runbooks, com o runbook necessário especificado no corpo da carga.

É por isso que a relação Modelo de Corpo da Solicitação de Criação do Serviço Rest com o objeto de lista de referência ObjectBody é criada quando você adiciona o comportamento do serviço web REST. Isso lhe permite criar uma lista de referência (para obter detalhes, consulte Criar novas listas de referência) para armazenar os corpos das diferentes cargas e, em seguida, como parte do seu procedimento, fornecer um mecanismo para que a instância de lista de referência apropriada seja selecionada (por exemplo, usando o tipo de valor em uma ação automática; para obter detalhes, consulte Especificar valores dinâmicos para ações automáticas). Ao adicionar em seu ObjectBody espaços reservados semelhantes aos usados ​​na especificação de valores dinâmicos em ações automáticas, você pode incluir valores obtidos de instâncias de objetos no Service Desk para incluir na carga. Se você usa variáveis ​​de espaço reservado, adicione-as no contexto do objeto RESTful.

Cada objeto que tenha o comportamento REST deve ter pelo menos um item na lista de referência correspondente que contém o corpo da carga pertinente.

Você pode usar uma ferramenta como o Swagger para fazer uma chamada ao seu ponto de extremidade para ajudar a projetar essa carga.

Para ver um exemplo de como usar o serviço web REST para automatizar o cumprimento de solicitações usando o Ivanti Automation, consulte a Comunidade Ivanti.