Método api_put()

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

Cuidado

Os métodos da API do HighBond interagem com os dados de produção do Diligent One da sua organização. Se você tiver as permissões adequadas, conseguirá alterar ou excluir dados que podem ser importantes. Considere cuidadosamente as consequências de suas ações quando usar a API do HighBond.

Observação

Alguns recursos do Diligent One aceitam PATCH, alguns aceitam PUT e outros aceitam os dois tipos de solicitação. Para obter mais informações, consulte a referência da API do HighBond.

Sintaxe

hcl.api_put("Detalhes da solicitação de API do HighBond", data = carga_de_solicitação)

Parâmetros

Nome	Descrição
Detalhes da solicitação de API do HighBond	Os detalhes da solicitação para o recurso do Diligent One. hcl.api_put fornece automaticamente a parte padrão dos detalhes da solicitação em segundo plano. Você não precisa especificar explicitamente esses elementos da solicitação, a menos que queira substituir um valor padrão: informações do host Região do Diligent One ID da instância do Diligent One (ID da organização) informações do cabeçalho Para ver a sintaxe de solicitação de um recurso específico do Diligent One, consulte a referência da API do HighBond. Observação Se você especificar explicitamente as informações do host, deverá usar o protocolo HTTPS para se conectar com a API do HighBond. Por exemplo: https://apis-us.highbond.com
data = carga_de_solicitação	Os dados que serão enviados ao servidor da API do Diligent One. Os dados da carga devem estar formatados como JSON.

Nome

Descrição

Detalhes da solicitação de API do HighBond

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

hcl.api_put fornece automaticamente a parte padrão dos detalhes da solicitação em segundo plano. Você não precisa especificar explicitamente esses elementos da solicitação, a menos que queira substituir um valor padrão:

informações do host
Região do Diligent One
ID da instância do Diligent One (ID da organização)
informações do cabeçalho

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

Observação

Se você especificar explicitamente as informações do host, deverá usar o protocolo HTTPS para se conectar com a API do HighBond. Por exemplo: https://apis-us.highbond.com

data = carga_de_solicitação

Os dados que serão enviados ao servidor da API do Diligent One.

Os dados da carga devem estar formatados como JSON.

Retorna

Objeto de resposta do servidor da API do HighBond.

Observações

Autenticação

Todas as solicitações de API do HighBond exigem autenticação. Para acessar a API, você precisa ser um Administrador do Sistema em pelo menos uma instância do Diligent One.

Para autenticar, use o Launchpad para criar um token de API do HighBond para sua conta. O token é uma cadeia que autentica você, permitindo que você acesse a API do HighBond com segurança. Para obter ajuda na criação do token, consulte Criando e gerenciando tokens de acesso da Diligent One.

Usar um token de API do HighBond com métodos da API do HighBond

Para usar um token de API do HighBond com métodos da API do HighBond, você precisa atribuir o token a uma variável do HCL chamada v_hb_token. Depois que é atribuído, o token é usado automaticamente para autenticação em segundo plano, sem precisar ser especificado explicitamente no script do Diligent One. Para obter informações sobre a atribuição do token à variável, consulte Use a janela Variáveis para definir uma variável HCL.

Token de usuário de sistema

Os clientes que compraram kits de ferramentas específicos do Diligent One também podem autenticar usando um token genérico de usuário de sistema, em vez de um token associado a uma conta de usuário específica.

Especificação apenas da parte única da URL do recurso

Quando você usa um método da API do HighBond, precisa especificar apenas a parte única, ou ponto de extremidade, da URL do recurso do Diligent One. Não é preciso especificar a parte comum (URL base) ou o ID da instância do Diligent One em que você está trabalhando. Essas informações são fornecidas automaticamente em segundo plano.

Por exemplo, se você está trabalhando em uma instância do Diligent One com ID 1000236, ambas as solicitações de API retornam a mesma resposta. As duas solicitações listam todos os problemas do projeto 19756.

hcl.api_get("projects/19756/issues")

hcl.api_get("https://apis.highbond.com/v1/orgs/1000236/projects/19756/issues")

Consulte a referência da API do HighBond

A sintaxe de solicitação de cada recurso do Diligent One está disponível na referência da API do HighBond. Por exemplo, esta é a sintaxe de solicitação para obter a lista de problemas de um projeto.

Se você está usando um método do HCL para fazer a solicitação, pode começar a especificar a sintaxe em projects/....

Se você está fazendo a solicitação de fora do Diligent One, precisa especificar a URL completa do recurso, começando pelo protocolo (https://...).

Usar uma variável na URL do recurso

Em vez de especificar um ID literal em um URL do recurso, você pode ter código que exige o uso de uma variável no URL. O URL do recurso é formatado como cadeia. Portanto, para incorporar uma variável na cadeia, você precisa usar uma das técnicas do Python mostradas a seguir.

Você pode usar uma f-string Python:

v_project_id = "19756"
hcl.api_get(f"projects/{v_project_id}/issues")

Você pode usar a concatenação de cadeias do Python:

v_project_id = "19756"
hcl.api_get("projects/" + v_project_id + "/issues")