コンテンツにスキップ

コメントの修正¶

POST /api/v1/incidents/comment/{comment_uuid}/modify

概要¶

ルートパラメータ¶

パラメータ名	タイプ	必須	説明
comment_uuid	string	Y	単一コメントのUUID 空を許可しない: False

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
comment	string	Y	コメント内容空を許可しない: False 例: comment_xxx
extend	json		拡張情報空を許可しない: False 例: {}
attachmentUUIDs	array		添付ファイルUUIDのリスト空を許可しない: False 例: []

パラメータ補足説明¶

基本パラメータ説明

パラメータ名	パラメータタイプ	必須	パラメータ説明
attachmentUUIDs	array	N	インシデントのコメントに添付するファイルのUUIDリスト。事前に /api/v1/attachment/upload エンドポイントでアップロードする必要があります。
comment	string	Y	コメント内容
extend	json	N	拡張フィールド。デフォルトは {}

拡張フィールド extend の説明

パラメータ名	パラメータタイプ	必須	パラメータ説明
members	array	N	インシデント通知の通知先メンバー
linkList	array	N	リンクの追加

extend フィールドの例:

{
    "members": [
        {
            "type": "@",
            "uuid": "acnt_xxxx32",
            "exists": true
        }
    ],
    "linkList": [
        {
            "name": "テスト",
            "link": "https://xxxx",
        }
    ]
}

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/incidents/comment/inccmt_xxx/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"comment":"aaaaa<div>ddd</div>","attachmentUUIDs":[],"extend":{"links":[],"members":[]}}'\
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "incidentsUUID": "incident_xxxx",
        "workspaceUUID": "wksp_xxx",
        "comment": "aaaaa<div>ddd</div>",
        "extend": {
            "links": [],
            "members": []
        },
        "id": 33,
        "uuid": "inccmt_xxx",
        "status": 0,
        "creator": "acnt_xxxx",
        "updator": "acnt_xxx",
        "createAt": 1768964545,
        "deleteAt": -1,
        "updateAt": 1768986552.8467112,
        "attachments": []
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "xxxx"
}