変更¶
POST /api/v1/issue/{issue_uuid}/modify
概要¶
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| issue_uuid | string | Y | インシデントUUID |
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | タイトル名 例: name 空を許可しない: False $maxCustomLength: 256 |
|
| level | string | レベル、対応するレベル設定のUUID 例: level 空を許可しない: False 空文字列を許可する: True |
|
| description | string | 説明 例: description 空を許可しない: False |
|
| statusType | integer | インシデントのステータス 例: statusType 空を許可しない: False 選択可能な値: [10, 15, 20, 25, 30] |
|
| extend | json | Y | 追加拡張情報、内容がない場合はデフォルトで{} 例: {} 空を許可する: True |
| attachmentUuids | array | 添付ファイルアップロードリストのUUID 例: [] 空を許可する: True |
パラメータ補足説明¶
基本パラメータ説明
| パラメータ名 | パラメータタイプ | 必須 | パラメータ説明 |
|---|---|---|---|
| name | string | N | インシデントのタイトル名 |
| level | string | N | インシデントのレベル、対応する設定レベルのUUID |
| statusType | integer | N | インシデントのステータス、10: Open, 15: Working, 20: Resolved, 25: Closed, 30: Pending |
| decription | string | N | インシデントの説明情報 |
| attachmentUuids | array | N | 添付ファイルアップロードリストのUUID、事前に /api/v1/attachment/upload エンドポイントでアップロードする必要があります |
| extend | json | N | 拡張フィールド、デフォルトは{} |
level レベルフィールド説明 level はシステムレベルとカスタムレベルに分かれます（設定管理で設定可能）
| level | value | パラメータ説明 |
|---|---|---|
| P0 | system_level_0 | パラメータ level: system_level_0 を指定すると、システムレベル P0 を表します |
| P1 | system_level_1 | パラメータ level: system_level_1 を指定すると、システムレベル P1 を表します |
| P2 | system_level_2 | パラメータ level: system_level_2 を指定すると、システムレベル P2 を表します |
| P3 | system_level_3 | パラメータ level: system_level_3 を指定すると、システムレベル P3 を表します |
| xxx | issl_yyyyy | パラメータ level: issl_yyyyy を指定すると、カスタムレベル xxx を表します |
拡張フィールド extend 説明
| パラメータ名 | パラメータタイプ | 必須 | パラメータ説明 |
|---|---|---|---|
| channels | array | N | 説明内の # : インシデントの送信先リソースリスト |
| linkList | array | N | インシデントリンクを追加 |
| members | array | N | 説明内の @ : インシデント通知の通知先メンバー |
| manager | array | N | 担当者情報（ユーザーアカウントUUID、メールアドレス、チームUUID） |
| extra | json | N | インシデント更新者/担当者のメールアドレスに対応する名前などの情報、フロントエンド表示用 |
extend フィールドの例:
{
"members": [
{
"type": "@",
"uuid": "acnt_xxxx32",
"exists": true
}
],
"channels": [
{
"type": "#",
"uuid": "chan_xxxx32",
"exists": true
}
],
"manager": [
"acnt_xxxxx",
"xxx@guance.com",
"group_xxx",
"xxx@guance.com"
],
"linkList": [
{
"name": "解決",
"link": "https://sd.com",
}
],
"extra":{
"updator": {
"name": "xxx",
"email": "xxx@guance.com",
},
"managerInfos": {
"xxx@guance.com": {"name": "111"},
"xxx@guance.com": {"name": "222"}
}
}
}
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/issue/issue_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"statusType":20}'\
--compressed
レスポンス¶
{
"code": 200,
"content": {
"createAt": 1686398344,
"creator": "acnt_xxxx32",
"creatorInfo": {
"acntWsNickname": "",
"email": "xxx@guance.com",
"iconUrl": "",
"name": "wanglei-testing",
"username": "xxx@guance.com"
},
"deleteAt": -1,
"description": "",
"extend": {
"channels": [
{
"exists": true,
"type": "#",
"uuid": "chan_xxxx32"
}
],
"view_isuue_url": ""
},
"id": 47402,
"level": "system_level_2",
"name": "dcacscsc",
"resource": "",
"resourceType": "",
"resourceUUID": "",
"status": 0,
"statusType": 20,
"subIdentify": "",
"updateAt": 1686400483,
"updator": "acnt_xxxx32",
"updatorInfo": {
"acntWsNickname": "",
"email": "xxx@guance.com",
"iconUrl": "",
"name": "wanglei-testing",
"username": "xxx@guance.com"
},
"uuid": "issue_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "1744405827768254151"
}