Issue を変更¶
POST /api/v1/issue/{issue_uuid}/modify
概要¶
Issue のタイトル、レベル、ステータス、または完全な拡張情報を更新し、添付ファイルを関連付け、変更通知を非同期でトリガーします。
呼び出し前の確認と使用手順¶
サイトレベルの External 認証情報を使用します(認証についてはExternal API 署名認証を参照)。Issue UUID に基づいてサイト全体から所属ワークスペースを検索します。ワークスペース OpenAPI Key のスコープ対象インターフェースではありません。信頼された連携にのみ、対応するデータスコープの権限を持つ External 認証情報を提供してください。まずIssue 詳細と所属ワークスペースを読み取ります。通常のフィールドは省略時に保持されます。extend は省略時に保持され、指定された場合はオブジェクト全体が置き換えられるため、元のオブジェクトを読み取ってから完全な置き換え後の内容を構築してください。チャンネル関係は上書き削除ではなく追加マージされます。添付ファイルが空でない場合はバインド/再バインドされ、[]/null は既存の添付ファイルを削除しません。空の JSON でも更新時刻が更新され、変更通知がスケジュールされるため、副作用のない確認として使用しないでください。ステータスを明示的に再送信した場合も操作履歴が追加されることがあり、20/25 では resolveAt が更新されます。保存、チャンネル再構築、添付ファイル、操作返信には複数のコミットポイントがあり、その後通知のスケジュールと監査記録が行われます。500 は一部がすでに反映されている可能性があるため、再試行を判断する前に GET で確認してください。通知はチャンネル購読、ポリシースケジュール、担当者、今回の @ アカウントなどを非同期で消費します。成功は配信済みを意味しません。ステータス変更は 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 秒文字列を生成します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| attachmentUuids[*] | json | アップロード済みの単一添付ファイル UUID。 例: att_example取得または入力方法: 添付ファイルのアップロードの content.attachmentUuid を取得します。 |
|
| extend.text | json | 任意のプレーンテキスト。現在は長さが 3000 Python 文字以内であることのみをチェックします(description とは独立)。省略時は空テキストとしてチェックされ、null や長さを計算できない型の場合は 500 になる可能性があります。 例: 定位生产接口延迟。取得または入力方法: 説明からプレーンテキストを抽出し、3000 文字以内に収めます。省略した場合は空テキストとしてチェックされます。 |
|
| extend.channels | array | 説明内の # チャンネルオブジェクトの任意配列。指定時は今回の UUID、既存のバインド、デフォルトチャンネルをマージして重複を排除したうえで関係を再構築します。全量置換ではありません。[] は既存のバインドを解除せず、省略時は関係を調整しません。このフィールド自体は extend の内容として引き続き全体置換の対象です。null は不正な実装となり 500 になります。 例: [{"type": "#", "uuid": "chan_example", "name": "生产异常"}]取得または入力方法: チャンネル一覧から実際のチャンネル UUID を取得し、説明内の # チャンネルを参照します。省略時は追加しません。 |
|
| extend.channels[*] | json | チャンネル参照オブジェクト。 例: {"type": "#", "uuid": "chan_example", "name": "生产异常"}取得または入力方法: 各項目で同一ワークスペース内の実際のチャンネルを 1 つ選択します。 |
|
| extend.channels[*].uuid | json | チャンネル UUID。呼び出し元は同一ワークスペースに属し、関連付けが許可されていることを検証してください。現在のバインドでは UUID の存在性/所属を完全には検証しないため、成功は有効性を証明しません。GET の bindChannels で確認する必要があります。 例: chan_example取得または入力方法: チャンネル一覧の content[].uuid から取得します。 |
|
| extend.channels[*].name | json | クライアント表示名。 例: 生产异常取得または入力方法: チャンネル一覧から対応する name を取得して表示に使用します。省略可能です。 |
|
| extend.channels[*].type | json | チャンネル参照マーカー。 例: #取得または入力方法: チャンネル参照では固定で # を使用します。サーバー側の読み取り結果ではこのマーカーが補完されます。 |
|
| extend.channels[*].exists | json | 任意の表示マーカー。サーバー側のリソース検証を代替しません。 例: true取得または入力方法: 有効性の証明として渡す必要はありません。クエリ応答では現在のリソース存在性に基づいて再計算されます。 |
|
| extend.members | array | 今回の @ アカウントオブジェクトの任意配列。現在削除されていないアカウントのメールアドレスを抽出し、追加の単発通知に使用します。担当者配列ではなく、メールアドレスやチームオブジェクトをアカウント UUID の代替として直接使用することはできません。再送信すると再度通知されることがあります。省略時は今回の追加 @ はありません。null やオブジェクトでない要素は 500 になる可能性があります。 例: [{"type": "@", "uuid": "acnt_example", "name": "值班工程师"}]取得または入力方法: 対象ワークスペースのメンバー管理からアカウント UUID を取得します。省略時は今回の @ メンバーを追加しません。 |
|
| extend.members[*] | json | メンバー参照オブジェクト。 例: {"type": "@", "uuid": "acnt_example", "name": "值班工程师"}取得または入力方法: @ が必要なアカウントごとにオブジェクトを入力します。 |
|
| extend.members[*].uuid | json | メンバーアカウント UUID。 例: acnt_example取得または入力方法: 対象ワークスペースのメンバー管理から acnt_ アカウント UUID を取得します。 |
|
| extend.members[*].name | json | クライアント表示名。 例: 值班工程师取得または入力方法: メンバーの表示名を使用します。省略可能です。 |
|
| extend.members[*].type | json | メンバー参照マーカー。 例: @取得または入力方法: メンバー参照では @ を使用します。 |
|
| extend.members[*].exists | json | 任意の表示マーカー。 例: true取得または入力方法: 有効性の証明として渡す必要はなく、クエリ時に再計算されます。 |
|
| extend.extra | json | 外部表示用の任意 JSON オブジェクト。認証/監査上の実際の SYS 身份は変更しません。省略または {} の場合、全体置換の中で既存の表示上の更新者がクリアされる可能性があります。null などオブジェクト構造に適合しない値は 500 になる可能性があります。 例: {}取得または入力方法: サードパーティ連携で外部操作者を表示する必要がある場合に入力します。不要な場合は省略または {} を指定します。 |
|
| extend.extra.creator | json | 外部作成者の表示オブジェクト。既存の extra がある場合、今回の creator はまず削除され、その後(存在すれば)既存の creator が保持されます。変更によって作成者を上書きできることは保証されません。既存の extra が空の場合にのみ、今回の creator が保存される可能性があります。 例: {"name": "外部工单创建人", "email": "xxx@guance.com"}取得または入力方法: 連携システムの作成者を使用します。変更時は通常、既存の creator がサーバー側で保持されます。 |
|
| extend.extra.creator.name | json | 表示名。省略可能です。 例: 外部工单创建人取得または入力方法: 外部システムの表示名を取得します。 |
|
| extend.extra.creator.email | json | 表示メールアドレス。省略可能です。 例: xxx@guance.com取得または入力方法: 外部システムのメールアドレスを取得します。例は架空のアドレスです。 |
|
| extend.extra.updator | json | 更新者の表示オブジェクト。 例: {"name": "外部工单更新人", "email": "xxx@guance.com"}取得または入力方法: 変更時に連携システムの今回の操作者情報を取得します。 |
|
| extend.extra.updator.name | json | 表示名。省略可能です。 例: 外部工单更新人取得または入力方法: 外部システムの表示名を取得します。 |
|
| extend.extra.updator.email | json | 表示メールアドレス。省略可能です。 例: xxx@guance.com取得または入力方法: 外部システムのメールアドレスを取得します。 |
|
| extend.manager | array | 担当者の完全なターゲット配列(任意)。extend が指定された場合にのみ置き換えられます。このキーを省略するか [] を指定すると、オブジェクト全体の置換の中で既存の担当者がクリアされます。空でない場合は、不明なアカウント/チーム/通知先または無効なメールアドレスをフィルタリングします。dutyPerson は当日のオンコールカレンダーに従って具体的なターゲットに解決して保存され、その後のシフト交代に伴って自動変更されることはありません。フィルタリング後に [] になっても成功する可能性があるため、managerInfos を確認してください。通常のサイトの External は SYS 身份であり、外部表示の更新者を偽装しません。 例: ["acnt_example"]取得または入力方法: 対象ワークスペースのメンバー管理から acnt_ アカウント UUID、チーム管理から group_ UUID を取得します。通知先 UUID は通知先一覧から取得します。実際のメールアドレスまたは dutyPerson を入力することもできます。 |
|
| extend.manager[*] | json | アカウント UUID、チーム UUID、通知先 UUID、メールアドレス、または dutyPerson。 例: acnt_example取得または入力方法: 対象ワークスペースのメンバー管理から acnt_ アカウント UUID、チーム管理から group_ UUID を取得します。通知先 UUID は通知先一覧から取得します。実際のメールアドレスまたは dutyPerson を入力することもできます。 |
|
| extend.linkList | array | 参照リンク配列。クライアントの必要に応じて保存されます。 例: [{"name": "处理手册", "link": "https://example.com/runbook"}]取得または入力方法: 業務側が提供するアクセス可能な参照リンクを指定します。省略時は追加しません。 |
|
| extend.linkList[*] | json | リンクオブジェクト。 例: {"name": "处理手册", "link": "https://example.com/runbook"}取得または入力方法: 各項目で 1 つの参照リンクを記述します。 |
|
| extend.linkList[*].name | json | リンク名。 例: 处理手册取得または入力方法: リンクの表示名を入力します。 |
|
| extend.linkList[*].link | json | リンクアドレス。 例: https://example.com/runbook取得または入力方法: 完全なアクセス可能 URL を入力します。例のドメインは置き換える必要があります。 |
|
| extend.sourceLink | json | 任意のソースリンク。ソースタイプに応じて通知テンプレートで使用されます。この変更では viewer のカバレッジ時間枠を再計算しないため、通常の連携では元の値を保持すれば問題ありません。 例: https://example.com/source?doc_time=1785430800000取得または入力方法: コンソールのソースページから完全なリンクを取得します。viewer ソースの doc_time は Unix ミリ秒を使用します。 |
|
| extend.extra.managerInfos | json | 担当者メールアドレスから表示プロファイルオブジェクトへのマッピング。今回空でないマッピングを提供せず、既存のマッピングがある場合は、今回の manager 配列にまだ含まれているメールアドレスの項目のみ保持されます。その他の既存表示項目は保持されません。 例: {"xxx@guance.com": {"name": "外部值班人"}}取得または入力方法: extend.manager 内のメールアドレスをキーとして、外部担当者の表示情報を入力します。 |
|
| extend.extra.managerInfos.邮箱.name | json | 単一のメールアドレス担当者の表示名。 例: 外部值班人取得または入力方法: メールアドレスのキーは担当者配列内のメールアドレスと一致する必要があります。名前は外部業務システムから取得します。 |
|
| extend.extra.managerInfos.邮箱 | json | メールアドレスの表示オブジェクト。name 文字列のみを渡すことを推奨します。 例: {"name": "外部值班人"}取得または入力方法: キーは extend.manager 内の同じメールアドレスである必要があります。 |
|
| attachmentUuids | array | アップロード済み添付ファイル UUID の任意配列。省略、null、または [] のいずれも既存の添付ファイルを追加せず、削除もしません。空でない場合は項目ごとに本 Issue へバインド/再バインドされ、独立したコミットで処理されるため、本体更新との原子性は保証されません。このワークスペースに属し、関連付けが許可されていることを確認したアップロード済み添付ファイルのみを送信できます。無効または削除済みの UUID は現在、専用の 404 ではなく 500 になる可能性があります。 null を許可: True 例: []取得または入力方法: まず添付ファイルのアップロードを呼び出し、content.attachmentUuid を保存します。このワークスペースで実際にアップロードされ、利用可能な添付ファイルのみ使用できます。省略または [] では添付ファイルを追加しません。 |
|
| description | string | 任意の説明文字列。省略時は保持され、空文字列でクリアされます。null は不正です。extend.text から自動生成されることはありません。 null を許可: False 例: 定位生产接口延迟,记录处理过程。取得または入力方法: 現象、範囲、対応目標を入力します。詳細な診断資料は添付ファイルとしてアップロードできます。 |
|
| extend | json | 任意の拡張オブジェクト。省略時は既存の保存済みオブジェクトが保持されます。完全なオブジェクトを送信すると全体が置き換えられ、{} は担当者/テキスト/表示情報をクリアする可能性がありますが、既存の extra.creator は条件付きで保持されます。null を許可すると宣言されていますが、現在のコードでは .get にアクセスするため 500 になります。オブジェクトを渡すか省略する必要があります。動的子フィールドは完全には検証されず、誤った型は 500 を引き起こす可能性があります。 null を許可: True 例: {}取得または入力方法: 変更前に本ページの詳細 content.extend を読み取り、完全な内容をコピーしてから調整します。タイトル/ステータスのみを変更する場合は省略できます。 |
|
| level | string | 任意の有効なレベル UUID。省略時は保持され、空文字列でレベルがクリアされ、null は不正です。システムデフォルト/ワークスペースカスタム/バックエンドグローバルのレベルは現在の有効一覧から取得し、system_level_3 を固定で P3 と見なしません。 空文字列を許可: True null を許可: False 例: system_level_1取得または入力方法: まず有効レベル一覧を呼び出し、実際に返された uuid を取得します。レベルを指定しない場合は空文字列を送信します。 |
|
| name | string | 任意の新しいタイトル。省略時は保持されます。最大 256(カスタム長のカウント単位: ASCII は 1、中国語などの非 ASCII は通常 2)です。純粋な中国語の場合は 128 文字以内を推奨します。null は不正です。 null を許可: False $maxCustomLength: 256 例: checkout-api 延迟异常取得または入力方法: 問題の現象に応じて明確なタイトルを入力します。 |
|
| statusType | integer | 任意のステータス整数 10 Open、15 Working、20 Resolved、25 Closed、30 Pending。省略時は保持されます。明示的に送信するたびに、値が変わっていなくても操作履歴が記録されます。20/25 では resolveAt が更新され、再度オープンしても履歴の resolveAt はクリアされません。null は不正です。 null を許可: False 選択可能な値: [10, 15, 20, 25, 30] 例: 15取得または入力方法: 業務の処理進捗に応じて 10/15/20/25/30 を選択します。 |
パラメータ補足¶
description は実際の説明フィールドです。元の説明にある decription は歴史的なスペルミスであり、リクエストキーとして使用できません。デフォルトのレベル名は設定と言語に基づき、system_level_3 を固定で P3 と呼ぶことはできません。添付ファイルは、権限のある /api/v1/attachment/upload を呼び出して先にアップロードし、content.attachmentUuid を取得する必要があります。これはフロントエンド/OpenAPI に対応するエントリポイントであり、本 External モジュールが新たに追加したアップロードエントリポイントではありません。
完全な拡張オブジェクトの例(実際のメンバー/チャンネルに置き換え、元のオブジェクト内で必要なその他のキーは保持してください):
{
"extend": {
"text": "正在定位延迟原因。",
"channels": [
{
"uuid": "chan_example",
"type": "#",
"name": "生产异常"
}
],
"members": [
{
"uuid": "acnt_example",
"type": "@",
"name": "值班工程师"
}
],
"manager": [
"acnt_example"
],
"linkList": [
{
"name": "处理手册",
"link": "https://example.com/runbook"
}
],
"extra": {
"updator": {
"name": "外部系统操作人",
"email": "xxx@guance.com"
}
}
}
}
リクエスト例¶
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 = 'POST'
path = '/api/v1/issue/issue_example001/modify'
query = {}
data = {'name': '生产接口延迟', 'statusType': 15}
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"))
レスポンス¶
HTTP200、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.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.creatorInfo.status | integer | アカウントレコードステータス。省略可能です。 |
| content.creatorInfo.wsAccountStatus | integer | 任意のワークスペースステータス。変更レスポンスのアカウント摘要はワークスペースコンテキストを渡さずに読み取るため、これに基づいて Issue ワークスペースにおけるメンバーの有効状態を判断することはできません。 |
| 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 | 任意のワークスペースステータス。変更レスポンスのアカウント摘要はワークスペースコンテキストを渡さずに読み取るため、これに基づいて Issue ワークスペースにおけるメンバーの有効状態を判断することはできません。 |
| 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 | システムデフォルトレベルの表示マーカー。省略可能です。 |
{
"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
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | リクエスト JSON のトップレベルがオブジェクトではない | 一部の JSON ファイルの形式エラー | JSON オブジェクトを送信してください。通常のフィールドのみを変更する場合は extend を省略できます。 |
| 406 | ft.IssueLevelNotExists | level が空でないが、その Issue ワークスペースの現在の有効レベル集合に存在しない | レベル設定が存在しません | 有効レベル一覧から content.workspaceUUID に基づいて uuid を取得します。空文字列を指定するとレベルをクリアできます。 |
| 406 | ft.ExceedMaxLengthLimit | extend.text の長さが 3000 文字を超えている | テキストの最大長制限を超えています | プレーンテキストの長さを減らしてください。長い診断内容は添付ファイルとしてアップロードしてから関連付けられます。 |
| 400 | ft.UnsupportFreeIssueManager | 無料/制限付きプランで、ワークスペースメンバー以外のメールアドレスを担当者に設定した | 無料プランのワークスペースでは、インシデントの担当者を外部メールアドレスに設定することはサポートされていません | ワークスペース内の有効なメンバー/チーム/通知先を選択するか、先にプランとメールアドレスの範囲を確認してください。 |
| 500 | ft.InternalServerError | 対象が存在しない/削除済み、extend=null/動的フィールドの型エラー、無効な添付ファイル UUID、またはデータベース/返信/チャンネル/通知配信の段階的な例外 | 内部エラー | まず GET で最終的なフィールド、添付ファイル、チャンネルを確認してください。エラーはロールバックを証明するものではありません。本体のコミット完了後でも失敗する可能性があります。再試行するとステータス記録や通知が増えることがあるため、確認してから再試行してください。 |