Comando HB_API_PUT

Envia uma solicitação PUT à API do HighBond.

Sintaxe

HB_API_PUT URL_solicitação_API_HighBond HEADERS informações_cabeçalho DATA arquivo_carga PASSWORD número <TO arquivo_resposta>

Parâmetros

Nome Descrição
URL_solicitação_API_HighBond

Os detalhes da solicitação para o recurso do Diligent One.

Inclua os detalhes a seguir na URL de solicitação:

  • informações do host, incluindo a região do Diligent One

  • Número da versão da API (número da versão principal atual)

  • ID da instância do Diligent One (ID da organização)

  • Nome do endpoint da API do HighBond e detalhes adicionais do endpoint, como número de ID

Por exemplo:

"https://apis-us.highbond.com/v1/orgs/11594/robots"

Para ver a sintaxe de solicitação de um recurso específico do Diligent One, consulte a referência da API do HighBond.

HEADERS informações_cabeçalho

As informações do cabeçalho da solicitação.

No cabeçalho, especifique o tipo de conteúdo da solicitação da API do HighBond:

'{"content-type": "application/vnd.api+json"}'
DATA arquivo_carga

O nome do arquivo que contém a carga da solicitação.

A carga da solicitação são os dados que você deseja enviar ao Diligent One. Você coloca os dados em um arquivo JSON e usa DATA para fazer referência ao arquivo na solicitação de API do HighBond. Para orientações sobre a estrutura dos dados da carga de um recurso específico do Diligent One, consulte a referência da API do HighBond.

Especifique arquivo_carga como uma cadeia entre aspas com uma extensão de arquivo *.json. Por exemplo:

DATA "carga.json"

Nota

Para scripts que você deseja executar no Robôs, você deve também especificar uma tag //FILE no cabeçalho de análise que corresponda ao parâmetro DATA payload_file. Por exemplo:

COMMENT
//ANALYTIC Comandos de API do HB de teste
//FILE carga.json
END

Local onde salvar o arquivo JSON de carga

O local onde você deve salvar o arquivo JSON de carga depende de onde você pretende executar o script.

Executar o script no Analytics

Você pode salvar o arquivo JSON de carga na pasta contendo o projeto do Analytics, ou salvar em uma pasta diferente.

Se você salvar o arquivo em uma pasta que não seja a pasta do projeto, o arquivo_carga precisa incluir um caminho de arquivo com o nome do arquivo:

DATA "C:\Cargas de API do HighBond\carga.json"

Executar o script no Robôs

Carregue o arquivo JSON de carga na guia Entrada/Saída no robô que executará o script. O arquivo deve estar presente na guia antes de você executar o script.

Em arquivo_carga, especifique somente o nome do arquivo. Não especifique um caminho.

PASSWORD num

A definição de senha a ser usada.

PASSWORD num não é usado para solicitar ou especificar uma senha real. A definição de senha faz referência a uma senha previamente fornecida ou definida com o comando PASSWORD, o comando SET PASSWORD ou a tag de análise PASSWORD.

num é o número da definição de senha. Por exemplo, se as duas senhas foram previamente fornecidas ou definidas em um script, ou no agendamento de um script de análise, PASSWORD 2 especifica o uso da senha nº 2.

Para obter mais informações sobre o fornecimento ou a definição de senhas, consulte:

O valor de senha obrigatório é um token de acesso da Diligent One. Para obter mais informações, consulte Criação de uma definição de senha e especificação do valor da senha.

PASSWORD número pode ou não ser obrigatória, dependendo do ambiente em que o script é executado.

Ambiente onde o script é executado PASSWORD número é obrigatória
Analytics

(ativação on-line)

PASSWORD número não é obrigatória.

O token de acesso da Diligent One do usuário atual, armazenado no registro do Windows, é usado automaticamente.
Analytics

(ativação off-line)

PASSWORD número é obrigatória.
Robôs
TO arquivo_resposta

opcional

O nome do arquivo que contém a resposta à solicitação.

Especifique arquivo_resposta como uma cadeia entre aspas com uma extensão de arquivo *.json. Por exemplo:

TO "resposta.json"

Local onde salvar o arquivo JSON de resposta

O local onde o arquivo JSON de resposta é salvo depende de onde você executa o script.

Executar o script no Analytics

Por padrão, o arquivo JSON de resposta é salvo na pasta que contém o projeto do Analytics.

Inclua o caminho do arquivo no nome para salvar o arquivo em uma pasta existente diferente:

TO  "C:\Respostas de API do HighBond\resposta.json"

Executar o script no Robôs

Se você especificar uma tag //RESULT FILE no cabeçalho da análise, o arquivo JSON de resposta será salvo como saída com cada tarefa executada no robô.

Especifique somente o nome do arquivo. Não especifique um caminho.

Observações

Criação de uma definição de senha e especificação do valor da senha

Quando você executa um script no Robôs que envia uma solicitação para a API do HighBond, é preciso incluir uma definição de senha com o comando que envia a solicitação. A mesma exigência se aplica a scripts executados no Analytics se você usou a ativação off-line.

Independentemente do método usado para criar a definição de senha, o valor de senha obrigatório é um token de acesso da Diligent One, que você pode gerar no Launchpad. Para obter mais informações, consulte Adquira um token de acesso da Diligent One.

Métodos para definição de senha

Método Descrição

Tag de análise PASSWORD

(para scripts executados no Robôs)

Se você usar a tag de análise PASSWORD para criar a definição de senha numerada para conexão ao Diligent One, nenhum valor de senha será especificado no script. Quando você cria uma tarefa para ser executada no script no Robôs, um campo de entrada no Designer de tarefa permite que você ou outro usuário especifique a senha real.

Para obter mais informações, consulte Tag de análise PASSWORD.

Comando PASSWORD

(para scripts executados no Analytics com ativação off-line)

Se você usar o comando PASSWORD para criar a definição de senha numerada para conexão ao Diligent One, nenhum valor de senha será especificado no script. Um prompt de senha será exibido quando o script tentar se conectar.

Para obter mais informações, consulte Comando PASSWORD.

Comando SET PASSWORD

(para scripts executados no Analytics com ativação off-line)

Se você usar o comando PASSWORD para criar a definição da senha numerada para conexão com o Diligent One, um valor de senha será especificado no script, portanto, nenhum prompt de senha será exibido. Essa abordagem é apropriada para scripts criados para execução não assistida, mas ela expõe a senha real em texto não criptografado no script, o que pode não ser adequado para a sua situação.

Para obter mais informações, consulte Comando SET PASSWORD.

Adquira um token de acesso da Diligent One

Cuidado

O token de acesso gerado corresponde à conta usada para fazer login no Diligent One. Como um autor de scripts, pode não ser apropriado especificar seu próprio token de acesso em um script se ele for usado por outras pessoas.

Proteja os tokens de acesso como qualquer senha de conta.

Use um token existente, a menos que você tenha um motivo para criar um novo. Se o token existente não funcionar, crie um novo. O uso de um token existente reduz o número de tokens que você precisa gerenciar.

  1. Execute uma das seguintes ações:

    • No menu principal do Analytics, selecione Ferramentas > Token de Acesso da Diligent One.

    • No Editor de Script, clique com o botão direito e selecione Inserir > Token da Diligent One.

    A página Gerenciar tokens da API abre no navegador. Pode ser necessário primeiro fazer o login no Diligent One.

    O acesso à página Gerenciar Tokens da API por meio do Analytics é um recurso de conveniência. Você também pode fazer login no Diligent One e acessar a página por meio do seu perfil de usuário sem usar o Analytics.

  2. Execute uma das seguintes ações:

    • Usar um token existente

      1. Na coluna Token, clique no token parcialmente mascarado que deseja usar.

      2. Digite a senha da conta do Diligent One e clique em Confirmar.

        O token não mascarado é exibido.

      3. Clique em Copiar para copiar o token.

        Dica

        Não feche a caixa de diálogo que contém o token até colar corretamente o token.

    • Criar um novo token

      1. Clique em Adicionar token > Analytics.

      2. No painel lateral Novo token do Analytics, especifique estas informações:

        Campo ou opção Descrição
        Descrição

        Insira uma descrição que forneça informações úteis, como:

        • O propósito do token
        • Onde o token é usado – por exemplo, o nome e a localização do script do Analytics, ou o nome e a localização da tarefa do robô
        Expiração do token
        • Habilitada o token expira após um número de dias especificado
        • Desabilitada o token nunca expira

        Nota

        Sua organização pode ter uma política de segurança que exige a expiração de tokens após um determinado período. É recomendado criar tokens com expiração. O Diligent One enviará uma notificação automática por e-mail antes da data de expiração.
        Expiração em Especifique o número de dias até a expiração do token (1 a 365).
        Senha Digite a senha da conta do Diligent One.

      3. Clique em Gerar token.

      4. Clique em Copiar para copiar o token.

        Dica

        Não feche o painel lateral que contém o token até colar corretamente o token.

  3. Dependendo do método de definição de senha que você está usando, faça uma das seguintes opções:

    • Tag de análise PASSWORD No Designer de Tarefa em um robô ACL, cole o token copiado em um campo de parâmetro de senha.

    • Comando PASSWORD No Analytics, cole o token copiado em um prompt de senha exibido durante a execução de scripts.

    • Comando SET PASSWORD No Analytics, cole o token no ponto apropriado na sintaxe do comando SET PASSWORD em um script.

  4. No Launchpad, feche a caixa de diálogo ou o painel lateral que contém o token.

    Se tiver criado um novo token, uma versão parcialmente mascarada do token é adicionada ao início da lista de tokens.

    Para obter mais informações, consulte Criando e gerenciando tokens de acesso da Diligent One.