api_get() methode

Geeft een lijst weer van alle projecten in de Diligent One-instantie waarin u werkt:

hcl.api_get("projects")

Geeft een lijst weer van alle Resultaten-verzamelingen in de Diligent One-instantie waarin u werkt:

hcl.api_get("collections")

Geeft een lijst weer van alle problemen in het project met ID 19756:

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

Retourneert een lijst van alle problemen in het project met ID 19756 en retourneert alleen de opgegeven velden voor elk probleem:

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

Doorgaans moet u het antwoordobject dat door de HighBond API-server wordt geretourneerd manipuleren, zodat u kunt werken met de gegevens die het bevat.

Retourneert een antwoordobject dat een lijst bevat van alle problemen in het project met ID 19756:

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

Gebruikt de methode .json() van de Python Requests-bibliotheek om het JSON-gecodeerde deel van het antwoordobject naar een Python-dictionary te extraheren. U kunt nu met de probleemgegevens werken in een Python/HCL-script.

aanvragen importeren
hb_issues_dict = response_object.json()

U kunt beide bovenstaande bewerkingen ook in één stap uitvoeren:

aanvragen importeren
hb_issues_dict = hcl.api_get("projects/19756/issues").json()

U kunt het Python-woordenboek naar het scherm afdrukken om de inhoud te zien. Zonder enige extra opmaak wordt het woordenboek weergegeven zonder regeleinden of inspringingen om geneste elementen te onderscheiden:

print(hb_issues_dict)

Gebruikt de methode .dumps() van de Python JSON-bibliotheek om extra opmaak toe te passen zodat de inhoud van de dictionary beter leesbaar is:

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

Voorbeeld van opgemaakte uitvoer:

{
    "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>Er bestaat geen beleid voor gegevensbewaring en back-up</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
    }
}}