コンテンツにスキップ

返信 編集



POST /api/v1/issue/reply/{reply_uuid}/modify

概要

ルートパラメータ

パラメータ名 タイプ 必須 説明
reply_uuid string Y reply_uuid

Body リクエストパラメータ

パラメータ名 タイプ 必須 説明
issueUUID string Y Issue の UUID
例: issueUUID
空欄許可: False
attachmentUuids array 返信添付ファイルのアップロードリスト uuids
例: []
空欄許可: True
content string 返信内容
例: answer_xxx
空欄許可: True
空文字列許可: True
extend json Y 追加拡張情報。内容がない場合はデフォルト {}
例: {}
空欄許可: True

パラメータ補足説明

基本パラメータ説明

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

拡張フィールド extend の説明

更新シナリオでは、channels と channelUUIDs はデフォルトチャンネルと追加チャンネルへの関連付けに使用されます。[] を渡した場合、デフォルトではワークスペースのデフォルトチャンネルにのみ存在します。

パラメータ名 パラメータタイプ 必須 パラメータ説明
channels array N Issue を配信するリソースリスト
members array N Issue 通知の通知先メンバー
extra json N 返信更新者に関する名称などの情報。フロントエンドでの表示用

extend フィールドの例:

{
    "members": [
        {
            "type": "@",
            "uuid": "acnt_xxxx32",
            "exists": true
        }
    ],
    "channels": [
        {
            "type": "#",
            "uuid": "chan_xxxx32",
            "exists": true
        }
    ],
    "extra": {
                "updator": {
                  "name": "yyy",
                  "email": "xxx@guance.com",
                }
            }
}

リクエスト例

curl 'https://openapi.guance.com/api/v1/issue/reply/repim_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"issueUUID":"issue_xxxx32","content":"aaaaas","attachmentUuids":[],"extend":{"channels":[],"linkList":[],"members":[],"text":"aaaaas"}}'\
--compressed

レスポンス

{
    "code": 200,
    "content": {
        "content": "aaaaas",
        "createAt": 1690810887,
        "creator": "acnt_xxxx32",
        "deleteAt": -1,
        "extend": {
            "channels": [],
            "linkList": [],
            "members": [],
            "text": "aaaaas"
        },
        "id": 319430,
        "issueUUID": "issue_xxxx32",
        "status": 0,
        "type": "reply",
        "updateAt": 1690811215,
        "updator": "acnt_xxxx32",
        "uuid": "repim_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "13131178623027797701"
}

フィードバック

このページは役に立ちましたか?