取得¶
GET /api/v1/issue/{issue_uuid}/get
概要¶
Issue UUID を指定して、Issue の詳細、担当者、レベル、バインド済み添付ファイル、チャンネルを読み取ります。
呼び出し前の準備と使用手順¶
サイトレベルの External 認証情報を使用します(認証についてはExternal API 署名認証を参照)。Issue UUID に基づいてサイト全体から所属ワークスペースを検索します。ワークスペース OpenAPI Key のスコープ対象インターフェースではありません。信頼済みの連携にのみ、適切なデータスコープ権限を持つ External 認証情報を提供してください。まず Issue ページ/作成レスポンスから uuid を取得します。content.levelInfo と managerInfos を表示情報として解析します。履歴レベルは現在の書き込み可能な有効リストに含まれていない可能性があるため、後続でレベルを変更する場合は有効なレベルの一覧を再取得する必要があります。extend.channels/members.exists はサイト全体の削除されていないレコードのみを確認するものであり、対象ワークスペースでの有効な権限を意味しません。読み取りは Issue を変更せず、今回の変更通知もトリガーしません。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issue_uuid | string | Y | 必須の Issue UUID。通常は issue_ プレフィックスが付きます。イベント UUID やチャンネル UUID ではありません。この External エントリポイントでは workspaceUUID は不要で、Issue 自体から所属ワークスペースを取得します。 例: issue_example001取得または入力方法: 対象サイトの既存 Issue 詳細 URL、作成結果の content.uuid、または読み取り権限のある Issue 一覧から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョン。省略したまま本ページのアルゴリズムを継続使用することはできません。 例: v20240417取得または入力方法: 本ページの例ではこの固定バージョンを使用しており、サンプル署名アルゴリズムと対応しています。 |
|
| X-Df-Access-Key | string | Y | 読み取りインターフェースでは r または w の認証情報を使用でき、書き込みインターフェースでは w の認証情報が必要です。 例: <external-access-key>取得または入力方法: サイト管理者が割り当てた External API AK を使用します。ワークスペースの OpenAPI Key は使用できません。 |
| X-Df-Nonce | string | Y | 一時的なシリアル番号。失敗して再送する場合も新しい値を生成し、署名を再計算します。 例: 97d275ee9f774315a7885ba7347acbd9取得または入力方法: リクエストごとに uuid.uuid4().hex を再生成します。 |
| X-Df-Signature | string | Y | 大文字のメソッド、nonce、元の完全なパス、timestamp、元の UTF-8 リクエストボディをスペースで連結し、HMAC-SHA256 を適用して hex ダイジェストを取得します。 例: <hmac-sha256-hex>取得または入力方法: External API 署名認証に従い、対応する SK を使用して計算します。完全に実行可能なテンプレートは以下を参照してください。 |
| X-Df-Timestamp | string | Y | サイトで設定された署名有効時間枠内である必要があり、例の時刻を再利用できません。 例: 1785427200取得または入力方法: 送信時に str(int(time.time())) を使用して現在の Unix 秒文字列を生成します。 |
パラメータ補足¶
変更についてはIssue の変更を参照してください。書き込み可能なレベルは有効なレベルの一覧から取得します(query.workspaceUUID には本レスポンスの content.workspaceUUID を使用します)。このルートでは、存在しないまたは削除済みの Issue に対して現在 500 を返す可能性があります。他のエントリポイントの 404 契約から推測しないでください。
リクエスト例¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 対象サイトのアドレスおよび管理者が割り当てた External API AK/SK に置き換えます。
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'GET'
path = '/api/v1/issue/issue_example001/get'
query = {}
data = None
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
レスポンス¶
HTTP 200、application/json の標準 External エンベロープです。content は Issue および対応する追加資料であり、OpenAPI declaration には自動的に追加されません。フィールドは履歴ソース/拡張設定に応じて動的に出現します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | 保存済み Issue レコードの連番。操作には uuid を使用します。 |
| content.uuid | string | リソース UUID。 |
| content.workspaceUUID | string | 所属ワークスペース UUID。 |
| content.status | integer | レコードステータス。0 は正常、3 は削除済みです。Issue のビジネスステータスである statusType とは区別されます。 |
| content.creator | string | Issue の実際の作成アイデンティティ。extend.extra の表示情報によって変わりません。 |
| content.updator | string | 直近の更新アイデンティティ。External による変更時は SYS となり、未更新の場合は空になることがあります。 |
| content.createAt | integer | 作成時刻(Unix 秒)。 |
| content.updateAt | integer | 最終更新時刻(Unix 秒)。未更新の場合は -1 になることがあります。 |
| content.deleteAt | integer | 削除時刻(Unix 秒)。未削除の場合は -1 です。 |
| content.name | string | Issue のタイトル。 |
| content.level | string | レベル UUID。空文字列は未指定を表し、レベル名ではありません。 |
| content.statusType | integer | ステータス:10 Open、15 Working、20 Resolved、25 Closed、30 Pending。 |
| content.statusTypeUpdateRecord | array<string> |
ステータス変更履歴。各項目は Unix 秒&&ステータス名の形式です。 |
| content.statusTypeUpdateRecord[] | string | 単一のステータス変更レコード。 |
| content.description | string | Issue の説明。 |
| content.resourceType | string | ソースタイプ。event、dashboard、viewer など。自動作成の場合は checker、keyeventAutoDiscovery などになることもあります。 |
| content.resourceUUID | string | 関連ソースの識別子。具体的な意味はソースタイプによって異なります。 |
| content.resource | string | ソースモジュールまたは名前。例: LOG、TRACING、EVENTS、RUM。 |
| content.repeatType | string | 自動検出された問題の重複タイプ。new、repeat、regression のいずれかで、手動作成の場合は空になることがあります。 |
| content.subIdentify | string | ソースで定義された関連サブ識別子。手動作成の場合は通常空です。 |
| content.resolveAt | integer | 最後に Resolved または Closed に設定された時刻(Unix 秒)。一度も復旧していない場合は -1 です。再オープンしてもこの履歴時刻は自動的にクリアされません。 |
| content.eventCount | integer | 記録された関連イベント数。 |
| content.eventCountUpdateAt | integer | 関連イベント数の最終更新時刻(Unix 秒)。未記録の場合は -1 です。 |
| content.triggerRecord | object | 履歴互換フィールド。現在は通知トリガーの制御パラメータとして使用されません。 |
| content.extend | object | 保存された拡張コンテンツ。変更前にオブジェクト全体をコピーしてください。変更時に省略した場合は保持され、{} は一部の元コンテンツをクリアできます(旧作成者の表示情報は条件付きで保持されます)。動的フィールドの説明は変更ページを参照してください。 |
| content.extend.text | string | 長さチェック用のプレーンテキスト。最大 3000 文字です。 |
| content.extend.channels | array<object> |
説明内で参照されるチャンネル。uuid、name、type、exists を含みます。返却時、exists は現在のリソース存在性に基づいて更新されます。 |
| content.extend.channels[].uuid | string | チャンネル UUID。 |
| content.extend.channels[].name | string または null | 表示名。 |
| content.extend.channels[].type | string | チャンネル参照マーカー #。 |
| content.extend.channels[].exists | boolean | サイト全体の削除されていないチャンネルレコードに基づいて存在性を確認します。所属ワークスペース/アクティブ状態を完全には検証しません。これによって本ワークスペースでの正当な参照を証明することはできません。 |
| content.extend.members | array<object> |
説明内で @ されたメンバー参照。uuid、name、type、exists を含みます。 |
| content.extend.members[].uuid | string | メンバーアカウント UUID。 |
| content.extend.members[].name | string または null | 表示名。 |
| content.extend.members[].type | string | メンバー参照マーカー @。 |
| content.extend.members[].exists | boolean | サイト全体の削除されていないアカウントに基づいて存在性を確認します。無効化されたアカウントでも true になる可能性があります。本ワークスペースのアクティブメンバーであることを示すものではありません。 |
| content.extend.manager | array<string> |
担当者識別子の配列。Issue でのみ使用されます。メンバー/チーム/通知先/メールアドレスなどは有効性に基づいて正規化されます。 |
| content.extend.manager[] | string | 単一の担当者識別子。 |
| content.extend.linkList | array<object> |
業務参考リンク。 |
| content.extend.linkList[].name | string | リンクの表示名。 |
| content.extend.linkList[].link | string | 業務 URL。 |
| content.extend.sourceLink | string | クライアントが保存したソースリンク。通知の遷移に使用されるかどうかはソースタイプと通知テンプレートによって異なり、本インターフェースの検索範囲は変わりません。 |
| content.extend.extra | object | サードパーティ連携の表示情報。API の実際の認証アイデンティティは変わりません。 |
| content.extend.extra.creator | object | サードパーティの作成者表示情報。name、email を含む場合があります。 |
| content.extend.extra.creator.name | string | 作成者の表示名。 |
| content.extend.extra.creator.email | string | 作成者の表示メールアドレス。 |
| content.extend.extra.updator | object | サードパーティの更新者表示情報。name、email を含む場合があります。 |
| content.extend.extra.updator.name | string | 更新者の表示名。 |
| content.extend.extra.updator.email | string | 更新者の表示メールアドレス。 |
| content.extend.extra.managerInfos | object | 担当者のメールアドレスをキーとする表示情報のマップ。Issue でのみ使用されます。 |
| content.extend.extra.managerInfos.邮箱.name | string | 対応するメールアドレスの担当者の表示名。 |
| content.extend.其他字段 | JSON | クライアントが保存したその他の拡張情報。すべてがビジネス動作をトリガーするわけではありません。 |
| content.creatorInfo | object | 作成者の表示オブジェクト。GET では extend.extra.creator を優先して使用し、クライアント定義の JSON である可能性があります。変更レスポンスでは実際の作成アイデンティティのサマリーを使用し、この表示による上書きは適用されません。 |
| content.creatorInfo.name | string | 表示名。省略可能です。 |
| content.creatorInfo.email | string | メールアドレス。省略可能です。 |
| content.creatorInfo.uuid | string | アカウント UUID。省略可能です。 |
| content.updatorInfo | object | 更新者の表示オブジェクト。GET では extend.extra.updator を優先して使用します。変更レスポンスでは実際の SYS アイデンティティのサマリーを使用します。 |
| content.updatorInfo.name | string | 表示名。省略可能です。 |
| content.updatorInfo.email | string | メールアドレス。省略可能です。 |
| content.updatorInfo.uuid | string | アカウント UUID。省略可能です。 |
| content.levelInfo | object | 履歴レベルの表示情報。削除済みまたは現在の有効リストに含まれない旧レベルが含まれる場合があります。対応する設定がない場合は {} になることがあります。新規書き込みに使用できるかどうかは有効なレベルの一覧に従います。 |
| content.levelInfo.uuid | string | レベル UUID。Issue.level に引き続き使用できるかどうかは、現在の有効なレベルの一覧に従って判断してください。 |
| content.levelInfo.name | string | レベル名。ワークスペースの言語またはレベル設定に応じて表示されます。 |
| content.levelInfo.color | string | 色文字列。通常は #RRGGBB です。 |
| content.levelInfo.description | string | レベルの説明。 |
| content.managerInfos | array<object> |
解析済みの担当者表示情報。アカウント情報は実際に表示可能なフィールドに基づいて返されます。チーム/通知先は通常 uuid と name を含み、メールアドレスは uuid/email/name を含みます。 |
| content.managerInfos[].uuid | string | 担当者識別子。 |
| content.managerInfos[].name | string | 表示名。 |
| content.managerInfos[].email | string | メールアドレス担当者またはアカウントのメールアドレス。値がある場合に提供されます。 |
| content.ruleType | string | ソースが checker で、モニター設定が取得できた場合に提供されるタイプ。 |
| content.eventTimeRange | array<integer> |
関連イベント数が存在する場合に提供される開始/終了時刻(Unix ミリ秒)。 |
| content.eventTimeRange[] | integer | Unix ミリ秒のタイムスタンプ。 |
| content.eventConditions | string | 自動検出ソースに有効なルールが存在する場合に提供されるイベント検索条件。 |
| content.eventConditionsFilters | JSON | 自動検出ソースのフィルター編集データ。設定がある場合に提供されます。 |
| content.attachments | array<object> |
Issue にバインド済みの添付ファイル一覧。ダウンロードには添付ファイルのダウンロードを使用します。 |
| content.attachments[].uuid | string | 添付ファイル UUID。 |
| content.attachments[].fileName | string | 元のファイル名。 |
| content.attachments[].fileSuffix | string | ファイル拡張子。 |
| content.bindChannels | array<object> |
Issue にバインドされたチャンネル。 |
| content.bindChannels[].uuid | string | チャンネル UUID。 |
| content.bindChannels[].name | string | チャンネル名。 |
| content.creatorInfo.status | integer | アカウントレコードステータス。省略可能です。 |
| content.creatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるアカウントステータス。省略可能です。 |
| content.creatorInfo.username | string | ログイン名。省略可能です。 |
| content.creatorInfo.iconUrl | string | アカウントのアバター URL。省略可能です。 |
| content.creatorInfo.mobile | string | アカウントの電話番号。空または省略の場合があります。 |
| content.creatorInfo.countryCode | string | 電話番号の国/地域コード。省略可能です。 |
| content.creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能です。 |
| content.updatorInfo.status | integer | アカウントレコードステータス。省略可能です。 |
| content.updatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるアカウントステータス。省略可能です。 |
| content.updatorInfo.username | string | ログイン名。省略可能です。 |
| content.updatorInfo.iconUrl | string | アカウントのアバター URL。省略可能です。 |
| content.updatorInfo.mobile | string | アカウントの電話番号。空または省略の場合があります。 |
| content.updatorInfo.countryCode | string | 電話番号の国/地域コード。省略可能です。 |
| content.updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能です。 |
| content.managerInfos[].status | integer | アカウントレコードステータス。省略可能です。 |
| content.managerInfos[].wsAccountStatus | integer | 現在のワークスペースにおけるアカウントステータス。省略可能です。 |
| content.managerInfos[].username | string | ログイン名。省略可能です。 |
| content.managerInfos[].iconUrl | string | アカウントのアバター URL。省略可能です。 |
| content.managerInfos[].mobile | string | アカウントの電話番号。空または省略の場合があります。 |
| content.managerInfos[].countryCode | string | 電話番号の国/地域コード。省略可能です。 |
| content.managerInfos[].acntWsNickname | string | ワークスペースのニックネーム。省略可能です。 |
| content.levelInfo.id | integer または null | レベルレコード番号。システムデフォルトレベルの場合はこのフィールドは提供されません。 |
| content.levelInfo.workspaceUUID | string | 履歴レベルの表示情報における任意フィールド。所属ワークスペース UUID。 |
| content.levelInfo.status | integer | 履歴レベルの表示情報における任意フィールド。レコードステータス。0 は正常、3 は削除済みです。Issue のビジネスステータスである statusType とは区別されます。 |
| content.levelInfo.creator | string | 履歴レベルの表示情報における任意フィールド。作成呼び出しアイデンティティ。API Key 識別子、アカウント、またはシステムアイデンティティの場合があります。 |
| content.levelInfo.updator | string | 履歴レベルの表示情報における任意フィールド。最終更新アイデンティティ。未設定の場合は空文字列です。 |
| content.levelInfo.createAt | integer | 履歴レベルの表示情報における任意フィールド。作成時刻(Unix 秒)。 |
| content.levelInfo.updateAt | integer | 履歴レベルの表示情報における任意フィールド。最終更新時刻(Unix 秒)。未更新の場合は -1 になることがあります。 |
| content.levelInfo.deleteAt | integer | 履歴レベルの表示情報における任意フィールド。削除時刻(Unix 秒)。未削除の場合は -1 です。 |
| content.levelInfo.extend | object または null | 履歴レベルの表示情報における任意フィールド。作成時に保存された追加 JSON オブジェクト。レベルの変更インターフェースは現在このフィールドを変更しません。 |
| content.levelInfo.isManage | boolean または number | 履歴レベルの表示情報における任意フィールド。プラットフォーム管理レベルかどうか。ワークスペースで作成した場合は通常 false です。 |
| content.levelInfo.isDefault | boolean | システムデフォルトレベルの表示マーカー。省略可能です。 |
| content.creatorInfo.其他字段 | JSON 値 | GET の外部表示オブジェクトには他のキーが保存される場合があり、実際のデータに基づいて解釈してください。システムサマリーは通常、以下の公開フィールドのみを返します。 |
| content.updatorInfo.其他字段 | JSON 値 | 外部表示オブジェクトには他のキーが保存される場合がありますが、実際の認証アイデンティティを示すものではありません。 |
{
"code": 200,
"content": {
"id": 1001,
"uuid": "issue_example001",
"status": 0,
"creator": "acnt_example",
"updator": "SYS",
"createAt": 1785427200,
"updateAt": 1785427260,
"deleteAt": -1,
"workspaceUUID": "wksp_example001",
"name": "本番インターフェースの遅延",
"level": "system_level_1",
"statusType": 15,
"statusTypeUpdateRecord": [
"1785427260&&Working"
],
"description": "遅延原因を調査中です。",
"resourceType": "event",
"resourceUUID": "",
"subIdentify": "",
"resource": "LOG",
"repeatType": "",
"extend": {
"text": "遅延原因を調査中です。",
"manager": [],
"linkList": []
},
"resolveAt": -1,
"eventCount": 0,
"eventCountUpdateAt": -1,
"triggerRecord": {},
"creatorInfo": {},
"updatorInfo": {
"uuid": "",
"status": 0,
"wsAccountStatus": 0,
"name": "SYS",
"username": "SYS",
"email": "SYS",
"mobile": ""
},
"managerInfos": [],
"attachments": [],
"levelInfo": {
"uuid": "system_level_1",
"name": "P1",
"color": "#FF7931",
"description": "<現在の言語およびレベル設定の説明>",
"isDefault": true
},
"bindChannels": []
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | Issue UUID が存在しない/削除済みの場合にルートが最初に空の workspaceUUID を読み取る、または詳細/関連資料の読み取りで例外が発生する | 内部エラー | まず Issue が実在し、削除されておらず、UUID が正確であることを確認してください。この External ルートは現在、存在しないことを固定の 404 として処理できません。traceId を保持して管理者に連絡し、検証を依頼してください。 |