Método api_post()

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

Sintaxe

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

Parâmetros

Nome	Descrição
Solicitar Detalhes API do HighBond	Os detalhes da solicitação para o recurso do Diligent One. hcl.api_post 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 API do HighBond. Observação Para especificar explicitamente as informações do host, você 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

Solicitar Detalhes API do HighBond

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

hcl.api_post 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 API do HighBond.

Observação

Para especificar explicitamente as informações do host, você 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 API do HighBond.

Exemplos

Criar um problema em um projeto no

Crie uma carga de solicitação que usa formatação JSON e atribua essa carga à variável payload. Então, use o método hcl.api_post e faça referência à variável payload nele para criar um problema no projeto com o ID 19756.

Dica

Para criar a sintaxe de carga com rapidez, copie o bloco e da sintaxe da carga da Referência de API do API do HighBond. Após copiar o bloco da carga, você pode remover os pares de valor-chave que você pretende deixar em branco.

payload = {"data":
        { 
    "tipo": "problemas",
            "atributos": {
                "descrição": "Descrição da problema",
                "proprietário": "Jane Sleaman",
                "deficiency_type": "Deficiência",
                "título": "Retenção e cópia de segurança de dados",
                "gravidade": "Alto",
                "publicado": Verdadeiro,
                "identified_at": "2021-11-01T18:15:30Z"
                    }
                }
            }

hcl.api_post("projects/19756/issues", dados = payload)

Observações

Autenticação

Todos os pedidos de API do HighBond requerem autenticação. Para acessar a API, você precisa ser um Admin de Sistema em pelo menos uma instância do Diligent One.

Para autenticar, use o Plataforma Diligent One 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 para criar um token, consulte Gerenciando tokens de acesso .

Usando um token de API do HighBond com métodos de 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 como atribuir o token à variável, consulte .

Token de usuário do 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 do sistema, em vez de um token associado a uma conta de usuário específica.

Especifique apenas a parte única do URL do recurso

Quando você usa um método da API do HighBond, precisa especificar apenas a parte única, ou endpoint, do URL do recurso do Diligent One. Não é preciso especificar a parte comum (URL de 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 com 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")

Consultar 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 o URL do recurso completo, começando pelo protocolo (https://...). ).

Usando uma variável no 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")