有効なレベル一覧¶
GET /api/v1/issue-level/valid/list
概要¶
インシデント管理で使用するレベルとその識別子を一覧表示します。
呼び出し前の準備と使用手順¶
対象の UUID をワークスペース一覧から取得して workspaceUUID に渡します。名前とソースに基づいてレベルを選択し、レベルの識別子が必要な後続の操作では uuid を使用します。サイトの統一レベルが有効な場合は、サイトレベルのみが返されます。無効な場合は、ワークスペースのカスタムレベル、およびワークスペースで無効化されていないシステム既定レベルが返されます。
例では External API の署名バージョン v20240417 を使用します。対象サイトの External API アドレス、Access Key、Secret Key をそれぞれ DF_EXTERNAL_API_URL、DF_EXTERNAL_ACCESS_KEY、DF_EXTERNAL_SECRET_KEY に設定します。例の ID は実際の値に置き換えてください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 署名バージョン。以下の例では v20240417 を使用します。 例: v20240417取得または入力方法: 例のとおりに入力し、署名アルゴリズムに対応させます。 |
|
| X-Df-Access-Key | string | Y | リクエストの AK 情報 例: <access-key>取得または入力方法: External API 管理者によって割り当てられます。 |
| X-Df-Signature | string | Y | 署名情報 例: <hex-signature>取得または入力方法: Secret Key を使用し、GET、nonce、リクエストパスと元のクエリ文字列、タイムスタンプ、空文字列で構成されるテキストに HMAC-SHA256 を適用して、16 進数の結果を取得します。 |
| X-Df-Timestamp | string | Y | リクエスト時のタイムスタンプ 例: 1785456000取得または入力方法: 呼び出し時の現在の Unix 秒を入力します。たとえば date +%s を実行します。 |
| X-Df-Nonce | string | Y | リクエスト時に生成する一時コード 例: b53b47e12e514616ad8cb1f17cb66dce取得または入力方法: リクエストごとに新しいランダム値を生成します。たとえば uuid.uuid4().hex です。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| workspaceUUID | string | 対象ワークスペースの UUID。 例: wksp_example取得または入力方法: ワークスペース一覧のレスポンスにある content.data[].uuid から取得し、元の値を使用します。 |
パラメータ補足説明¶
現在の対象サイトに割り当てられた External API 署名資格情報を使用します。
リクエスト例¶
import hmac
import os
import time
import uuid
from urllib.parse import urlencode
import requests
server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/issue-level/valid/list"
query = {'workspaceUUID': 'wksp_example'}
if query:
path += "?" + urlencode(query)
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = " ".join(("GET", nonce, path, timestamp, ""))
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload.encode(), "sha256").hex()
headers = {
"X-Df-Access-Key": os.environ["DF_EXTERNAL_ACCESS_KEY"],
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-SVersion": "v20240417",
"X-Df-Signature": signature,
}
result = requests.get(server + path, headers=headers, timeout=15)
result.raise_for_status()
data = result.json()["content"]
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> |
このページの結果。レコードがない場合は空配列です。 |
| content[].uuid | string | レベルの識別子。返された元の値を使用します。 |
| content[].name | string | レベル名。 |
| content[].color | string | 表示色。 |
| content[].description | string | レベルの説明。 |
| content[].isDefault | boolean | システム既定レベルにはこのフラグが付きます。 |
| content[].isManage | boolean | 管理バックエンドで設定されたサイトレベルには、このフラグが付く場合があります。 |
| content[].status | integer | レベルレコードのステータス。システム既定の項目では、このフィールドが含まれない場合があります。 |
{
"code": 200,
"content": [
{
"uuid": "issue_level_example",
"name": "高",
"color": "#d93434",
"description": "需要关注",
"status": 0
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータが渡された場合 | メッセージに無効なパラメータが示されます。 | パラメータ表に記載されていないフィールドを削除します。 |