Método api_get()

Retorna uma lista de todos os projetos na instância do Diligent One em que você está trabalhando:

hcl.api_get("projects")

Retorna uma lista de todas as coleções do Resultados na instância do Diligent One em que você está trabalhando:

hcl.api_get("collections")

Retorna uma lista de todos os problemas no projeto com ID 19756:

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

Retorna uma lista de todos os problemas no projeto com ID 19756 e retorna apenas os campos especificados de cada problema:

hcl.api_get("projects/19756/issues?fields[issues]=title,description,creator_name,created_at,updated_at,owner")

Normalmente, você precisa manusear o objeto de resposta retornado pelo servidor da API do HighBond para poder trabalhar com os dados que ele contém.

Retorna um objeto de resposta que inclui uma lista de todos os problemas no projeto com o ID 19756:

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

Usa o método .json() da biblioteca Requests do Python para extrair a parte codificada com JSON do objeto de resposta para um dicionário Python. Agora, você pode trabalhar com os dados dos problemas em um script Python/HCL.

import requests
hb_issues_dict = response_object.json()

Também é possível realizar as duas operações acima em uma única etapa:

import requests
hb_issues_dict = hcl.api_get("projects/19756/issues").json()

Você pode imprimir o dicionário do Python na tela para ver o conteúdo. Sem formatação adicional, o dicionário é exibido sem quebras de linha nem indentação para iniciar elementos aninhados:

print(hb_issues_dict)

Usa o método .dumps() da biblioteca JSON do Python para aplicar formatação adicional, de modo que o conteúdo do dicionário se torne mais legível:

import json
hb_issues_dict_formatted = json.dumps(hb_issues_dict, indent=4)
print(hb_issues_dict_formatted)

Exemplo de saída formatada:

{
    "data": [
        {
            "id": "52983",
            "type": "issues",
            "attributes": {
                "title": "Data retention and backup",
                "description": null,
                "creator_name": null,
                "created_at": "2015-05-08T20:59:34Z",
                "updated_at": "2016-11-17T18:44:59Z",
                "position": 3,
                "owner": "Jane Sleaman",
                "recommendation": "",
                "deficiency_type": "Deficiency",
                "severity": "High",
                "published": true,
                "identified_at": "2015-05-08T20:59:34Z",
                "reference": null,
                "reference_prefix": "1-A",
                "risk": "<p>Data retention and backup policy does not exist</p>\r\n",
                "scope": null,
                "escalation": null,
                "cause": "",
                "effect": "",
                "cost_impact": 3000.0,
                "executive_summary": null,
                "executive_owner": null,
                "project_owner": null,
                "closed": false,
                "remediation_status": null,
                "remediation_plan": null,
                "remediation_date": null,
                "actual_remediation_date": null,
                "retest_deadline_date": null,
                "actual_retest_date": null,
                "retesting_results_overview": null,
                "custom_attributes": []
            },
            "relationships": {
                "project": {
                    "data": {
                        "id": "19756",
                        "type": "projects"
                    }
                },
                "owner_user": {
                    "data": {
                        "id": "HWF9X5jpXsS",
                        "type": "users"
                    }
                },
                "executive_owner_user": {
                    "data": null
                },
                "project_owner_user": {
                    "data": null
                },
                "creator_user": {
                    "data": null
                }
            }
        }
    ],
    "links": {
        "prev": null,
        "next": null
    }
}