返信を作成¶
POST /api/v1/issue/reply/create
概要¶
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issueUUID | string | Y | 返信対象の Issue の UUID 例: issueUUID 空を許可: False |
| attachmentUuids | array | 返信の添付ファイルアップロードリストの UUID 例: [] 空を許可: True |
|
| content | string | 返信内容 例: answer_xxx 空を許可: True 空文字列を許可: True $maxCustomLength: 65535 |
|
| extend | json | Y | 追加拡張情報。内容がない場合はデフォルトで {} 例: {} 空を許可: True |
パラメータ補足説明¶
基本パラメータの説明
| パラメータ名 | パラメータ型 | 必須 | パラメータ説明 |
|---|---|---|---|
| issueUUID | string | Y | 返信対象の Issue の UUID |
| attachmentUuids | array | N | 返信対象の Issue の添付ファイルリストの UUID。事前に /api/v1/attachment/upload エンドポイントでアップロードする必要があります |
| content | string | N | 返信の内容 |
| attachmentUuids | array | N | 添付ファイルアップロードリストの UUID |
| 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": {
"creator": {
"name": "xxx",
"email": "xxx@guance.com",
}
}
}
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/issue/reply/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"issueUUID":"issue_xxxx32","content":"aaa","attachmentUuids":[],"extend":{"members":[],"channels":[],"linkList":[]}}'\
--compressed
レスポンス¶
{
"code": 200,
"content": {
"content": "aaa",
"createAt": 1690810887,
"creator": "acnt_xxxx32",
"deleteAt": -1,
"extend": {
"channels": [],
"linkList": [],
"members": []
},
"id": null,
"issueUUID": "issue_xxxx32",
"status": 0,
"type": "reply",
"updateAt": 1690810887,
"updator": "acnt_xxxx32",
"uuid": "repim_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "10459577100278308134"
}