コンテンツにスキップ

インシデントコメントの作成¶

POST /api/v1/incidents/comment/{incident_uuid}/add

概要¶

ルートパラメータ¶

パラメータ名	型	必須	説明
incident_uuid	string	Y	インシデントUUID 空を許可: False

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

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

パラメータ補足説明¶

基本パラメータ説明

パラメータ名	パラメータ型	必須	説明
attachmentUUIDs	array	N	Issue 返信に対応する添付ファイルの 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/incident_xxxx/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"comment":"<span class=\"mention-highlight\" data-mention=\"true\" data-uuid=\"acnt_xxx\" data-name=\"xxx\" contenteditable=\"false\">@xxxx</span>&nbsp;test","attachmentUUIDs":[],"extend":{"links":[],"members":[{"uuid":"acnt_xxxx","name":"xxxx","type":"@"}]}}'\
--compressed

レスポンス¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "xxx"
}