api_delete() メソッド
HighBond API に DELETE 要求を送信します。
注意
HighBond API メソッドは組織のライブ Diligent One データを操作します。適切なアクセス権が割り当てられている場合は、重要な可能性があるデータを変更または削除することができます。HighBond API を使用するときには、操作の結果について十分に検討してください。
構文
hcl.api_delete("HighBond API request details")パラメーター
| 名前 | 説明 |
|---|---|
| HighBond API 要求の詳細 | Diligent One リソースの要求詳細。 hcl.api_delete は要求詳細の標準部分を自動的にバックグラウンドで提供します。デフォルト値を上書きしたい場合を除き、これらの要求要素を明示的に指定する必要はありません。
特定の Diligent One リソースの要求構文については、HighBond API リファレンスを参照してください。 メモ ホスト情報を明示的に指定する場合、HighBond API との接続に HTTPS プロトコルを使用する必要があります。例：https://apis-us.highbond.com |
戻り値
HighBond API 状態コード。
備考
認証
すべての HighBond API 要求に認証が必要です。API にアクセスするには、少なくとも 1 つの Diligent One インスタンスのシステム管理者である必要があります。
認証するには、Diligent Oneプラットフォーム を使用して、アカウントの HighBond API トークンを作成します。トークンは、認証を行い、安全に HighBond API にアクセスできるようにする文字列です。トークン作成の詳細については、「 アクセス トークンを管理する」を参照してください。
HighBond API メソッドでの HighBond API トークンの使用
HighBond API メソッドで HighBond API トークンを使用するには、トークンを HCL 変数 v_hb_token に割り当てる必要があります。トークンが割り当てられた後は、自動的にバックグラウンドで認証に使用されます。Diligent One スクリプトで明示的に指定する必要はありません。変数へのトークン割り当ての詳細については、「 」を参照してください。
システム ユーザー トークン
特定の Diligent One ツールキットを購入されたお客様は、特定のユーザー アカウントに関連付けられたトークンではなく、汎用システム ユーザー トークンを使用して認証することもできます。
リソース URL の一意の部分のみを指定する
HighBond API メソッドを使用するときには、Diligent One リソース URL の一意の部分（最後の部分）のみを指定する必要があります。共通部分（ベース URL）や作業している Diligent One インスタンスの ID を指定する必要はありません。この情報はバックグラウンドで自動的に入力されます。
たとえば、Diligent One インスタンス ID 1000236 で作業している場合は、これらの API 要求のいずれも同じ応答を返します。これらはいずれもプロジェクト 19756 のすべての問題の一覧を出力します。
hcl.api_get("projects/19756/issues")hcl.api_get("https://apis.highbond.com/v1/orgs/1000236/projects/19756/issues")HighBond API リファレンスを参照する
すべての Diligent One リソースの要求構文については、HighBond API リファレンスを参照してください。たとえば、次に、プロジェクトの問題の一覧を取得する要求構文を示します。
HCL メソッドを使用して要求を作成している場合は、projects/... で構文の指定を開始できます。
Diligent One 外から要求を行っている場合は、リソース URL 全体を指定し、先頭にプロトコル（https://...）を指定する必要はありません。）で置換される。
リソース URL で変数を使用する
リソース URL でリテラル ID を指定するのではなく、URL で変数を使用する必要があるコードを作成することがあります。リソース URL の書式は文字列であるため、文字列に変数を組み込むには、次に示す Python 手法のいずれかを使用する必要があります。
Python f 文字列を使用できます。
v_project_id = "19756"
hcl.api_get(f"projects/{v_project_id}/issues")
Python 文字列連結を使用できます。
v_project_id = "19756"
hcl.api_get("projects/" + v_project_id + "/issues")
