カスタム重要度 変更¶
POST /api/v1/issue-level/{issue_level_uuid}/modify
概要¶
現在のワークスペースにあるカスタム重要度の名前、色、または説明を変更します。
呼び出し前の準備と使用手順¶
作成時に保存した issl_ UUID、または有効な重要度リストに表示されるエントリから対象を取得します。渡した name、color、description のみを変更し、省略したフィールドは現在値を維持します。現在のバージョンの宣言に含まれる extend は変更時に保存されません。返却オブジェクトには、変更前の名前を確認するための old_name が追加されます。重要度を変更しても、その重要度を使用する Issue が保存している UUID は置き換わりません。操作は現在の API Key が属するワークスペースに対して実行されます。リソース識別子は同じワークスペースから取得してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issue_level_uuid | string | Y | 本ワークスペースのカスタム重要度 UUID。システム既定の重要度はこの API では名前を変更できません。 例: issl_example取得または入力方法: カスタム重要度の作成レスポンスの content.uuid を保存するか、有効なリストに表示されるカスタム重要度のエントリから取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| extend.自定义字段 | json | 現在の変更 API ではこれらの追加フィールドを更新しません。 例: urgent取得または入力方法: 連携システムが業務要件に応じて命名し、フィールド型を安定させてください。 |
|
| color | string | 変更後の色(任意)。省略時は現在値を維持します。 null 許可: False 例: #FF7931取得または入力方法: クライアントで表示可能な色を選択してください。#RRGGBB 形式の文字列を推奨します。 |
|
| description | string | 変更後の説明(任意)。省略時は現在値を維持します。 null 許可: False 例: 需要当天响应取得または入力方法: 判定基準と期待する応答時間を簡潔に記述してください。1024 文字以内を推奨します。省略時は空文字列になります。 |
|
| extend | json | 公開パラメータ宣言には残っていますが、現在のコントローラーは変更後の extend を保存しません。省略して構いません。 null 許可: True 例: {}取得または入力方法: カスタムの追加情報を保存する場合は JSON オブジェクトを渡します。内容がない場合は省略するか {} を指定します。 |
|
| name | string | 変更後の名前(任意)。省略時は現在値を維持します。128 文字以内を推奨し、本ワークスペース内で重複しない名前にしてください。 null 許可: False 最大長: 256 例: 紧急处理取得または入力方法: 業務に応じて本ワークスペース内で未使用の名前を選択してください。128 文字以内を推奨します。 |
パラメータ補足¶
システム既定またはプラットフォーム全体で管理される重要度は、本ワークスペースで変更可能なレコードではないため、ObjectNotExists が返る場合があります。色や名前を変更しても、既存 Issue の購読者に自動通知されることはありません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/issue-level/issl_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产紧急处理","color":"#E94444"}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号。Issue 作成/返信のレスポンスでは、永続化前に構築される場合に null となることがあります。リソースを操作する場合は uuid を使用してください。 |
| content.uuid | string | リソース UUID。 |
| content.workspaceUUID | string | 所属ワークスペース UUID。 |
| content.status | integer | レコード状態。0 は正常、3 は削除済み。Issue の業務状態 statusType とは区別されます。 |
| content.creator | string | 作成時の呼び出し元。API Key 識別子、アカウント、またはシステム ID の場合があります。 |
| content.updator | string | 最終更新者。未設定の場合は空文字列。 |
| content.createAt | integer | 作成時刻(Unix 秒)。 |
| content.updateAt | integer | 最終更新時刻(Unix 秒)。未更新の場合は -1 となることがあります。 |
| content.deleteAt | integer | 削除時刻(Unix 秒)。未削除の場合は -1。 |
| content.name | string | カスタム重要度の名前。 |
| content.color | string | 色を表す文字列。 |
| content.description | string | 重要度の説明。 |
| content.extend | object または null | 作成時に保存された追加 JSON オブジェクト。重要度の変更 API は現在このフィールドを変更しません。 |
| content.isManage | boolean または number | プラットフォーム管理の重要度かどうか。ワークスペースで作成したものは通常 false です。 |
| content.old_name | string | 今回の変更前の重要度名。 |
| content.declaration | object または null | ワークスペースの共通宣言。content のこの階層にのみ付加されます。 |
{
"code": 200,
"content": {
"id": 201,
"uuid": "issl_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430860,
"deleteAt": -1,
"name": "生产紧急处理",
"description": "需要当天响应",
"color": "#E94444",
"extend": {},
"isManage": false,
"old_name": "紧急处理",
"declaration": {}
},
"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 オブジェクトを送信してください。 |
| 404 | ft.ObjectNotExists | 指定したリソースが現在のワークスペースに存在しない、またはクエリ条件に一致しない | 指定したオブジェクトが存在しない | 同じワークスペースのリソース UUID を再取得し、削除されていないか確認してください。 |
| 406 | ft.IssueLevelNameExists | 新しい名前が本ワークスペース内の他の未削除のカスタム重要度と同一 | 重要度名が既に存在 | 未使用の名前に変更してください。 |
| 500 | ft.InternalServerError | 重要度または設定の保存、監査、その他の内部処理の失敗 | 内部エラー | まず現在の重要度または設定を読み取って結果を確認し、その後再試行を判断してください。継続的に失敗する場合は traceId を提供してください。 |