api_get()-Methode

Gibt eine Liste aller Projekte in der Diligent One-Instanz zurück, in der Sie arbeiten:

hcl.api_get("projects")

Gibt eine Liste aller Ergebnissammlungen in der Diligent One-Instanz zurück, in der Sie arbeiten:

hcl.api_get("collections")

Gibt eine Liste aller Probleme im Projekt mit der ID 19756 zurück:

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

Gibt eine Liste aller Probleme im Projekt mit der ID 19756 zurück, wobei bei jedem Problem nur die angegebenen Felder zurückgegeben werden:

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

In der Regel müssen Sie das vom HighBond API-Server zurückgegebene Antwortobjekt bearbeiten, damit Sie mit den enthaltenen Daten arbeiten können.

Gibt ein Antwortobjekt mit einer Liste aller Probleme im Projekt mit der ID 19756 zurück:

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

Verwendet die Methode .json() aus der Bibliothek Python-Anfragen, um den JSON-kodierten Teil des Antwortobjekts in ein Python-Wörterbuch zu extrahieren. Sie können jetzt mit den Problemdaten in einem Python/HCL-Skript arbeiten.

import requests
hb_issues_dict = response_object.json()

Sie können auch beide Abläufe in einem Schritt ausführen:

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

Sie können das Python-Wörterbuch auf dem Bildschirm ausgeben, um den Inhalt zu sehen. Ohne zusätzliche Formatierung wird das Wörterbuch ohne Zeilenumbrüche oder Einrückungen zum Abheben verschachtelter Elemente angezeigt:

print(hb_issues_dict)

Verwendet die Methode .dumps() aus der Python JSON-Bibliothek, um zusätzliche Formatierung anzuwenden, damit der Wörterbuchinhalt besser lesbar ist.

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

Beispiel der formatierten Ausgabe:

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