api_get() メソッド

作業している Diligent One インスタンスのすべてのプロジェクトの一覧を返します。

hcl.api_get("projects")

作業している Diligent One インスタンス内のすべてのリザルトコレクションの一覧を返します。

hcl.api_get("collections")

ID 19756 のプロジェクトのすべての問題の一覧を返します。

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

ID 19756 のプロジェクトのすべての問題の一覧を返し、各問題の指定されたフィールドのみを返します。

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

通常、含まれるデータを処理できるように、HighBond API サーバーから返された応答オブジェクトを操作する必要があります。

ID 19756 のプロジェクトのすべての問題の一覧を含む応答オブジェクトを返します。

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

Python 要求ライブラリから .json() メソッドを使用して、応答オブジェクトの JSON エンコードされた部分を Python 辞書に抽出します。これで、Python/HCL スクリプトで問題データを処理できるようになりました。

import requests
hb_issues_dict = response_object.json()

また、上記の 2 つの操作を次のように単一のステップで行うこともできます。

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

Python 辞書を画面に出力して内容を確認できます。追加の書式設定がない場合、辞書は改行も、入れ子の要素を示すインデントもなしに表示されます。

print(hb_issues_dict)

Python JSON ライブラリから .dumps() メソッドを使用して、辞書の内容がより読みやすくなるように追加の書式設定を適用します。

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

書式設定された出力の例:

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