Método api_get()

Devuelve una lista de todos los proyectos de la instancia de Diligent One en los que está trabajando:

hcl.api_get("projects")

Devuelve una lista de todas las colecciones de Resultados de la instancia de Diligent One en las que está trabajando:

hcl.api_get("collections")

Devuelve una lista de todos los asuntos del proyecto con el identificador 19756:

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

Devuelve una lista de todos los asuntos del proyecto con el identificador 19756 y devuelve únicamente los campos especificados para cada asunto:

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

Normalmente, debe manipular el objeto de respuesta devuelto por el servidor de la API de HighBond para poder trabajar con los datos que contiene.

Devuelve un objeto de respuesta que incluye una lista de todos los asuntos del proyecto con el identificador 19756:

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

Usa el método .json() de la biblioteca de solicitudes de Python para extraer la parte con codificación JSON del objeto de respuesta en un diccionario de Python. Ahora puede trabajar con los datos de los asuntos en un script Python/HCL.

import requests
hb_issues_dict = response_object.json()

También puede realizar las dos operaciones anteriores en un solo paso:

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

Puede imprimir el diccionario de Python en la pantalla para ver el contenido. Si no se aplica ningún formato adicional, el diccionario se muestra sin saltos de línea y sin sangría para compensar los elementos anidados:

print(hb_issues_dict)

Usa el método .dumps() de la biblioteca JSON de Python para aplicar formato adicional a fin de que el contenido del diccionario se lea mejor:

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

Ejemplo de salida con formato:

{
    "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
    }
}