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 Requests 库中的 .json() 方法，将响应对象的 JSON 编码部分提取到 Python 字典。此时便可以处理 Python/HCL 脚本中的问题数据。

import requests
hb_issues_dict = response_object.json()

还可以在单个步骤中执行上述两项操作：

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