コンテンツにスキップ

作成


POST /api/v1/issue/add

概要

Body リクエストパラメータ

パラメータ名 タイプ 必須 説明
name string Y タイトル名
例: name
空文字許可: False
最大長: 256
level string Y レベル。レベル設定に対応する uuid
例: level
空文字許可: False
空文字列許可: True
description string Y 説明
例: description
空文字許可: False
attachmentUuids array 添付ファイルアップロードリストの uuid
例: []
空文字許可: True
extend json Y 拡張情報
例: {}
空文字許可: True
resourceType string ソースタイプ。該当するユースケースがない場合は送信不要
例: resourceType
空文字許可: False
選択可能な値: ['event', 'dashboard', 'viewer']
resourceUUID string 対応するソースの uuid (それぞれ docid, dashboardUUID, dashboardUUID)
例: resourceUuid
空文字許可: False
空文字列許可: True
resource string 対応するソースから引き継がれるソース名
例: resource
空文字許可: False
空文字列許可: True
channelUUIDs array issue の配信先トラッキングチャンネルの uuid
例: []
空文字許可: True

パラメータ補足説明

基本パラメータ説明

パラメータ名 パラメータタイプ 必須 パラメータ説明
name string N issue タイトル名
level string N issue レベル。設定済みレベルに対応する uuid
statusType integer N issue ステータス。10: Open, 15: Working, 20: Resolved, 25: Closed, 30: Pending
decription string N issue 説明情報
attachmentUuids array N 添付ファイルアップロードリストの uuid。事前に /api/v1/attachment/upload エンドポイントでアップロードする必要があります。
extend json N 拡張フィールド。デフォルトは {}
resourceType string N event: イベント, dashboard: ダッシュボード, viewer: エクスプローラー (checker: モニター, このタイプは自動生成)
resourceUUID string N リソースに関連付けられた uuid
resource string N 対応するリソース名
channelUUIDs array N issue を配信するリソースリスト。デフォルトではデフォルトワークスペースのデフォルトチャンネルに配信されます。

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 を示します。

Issue チャンネル説明。すべての issue は自動的にデフォルトチャンネル（すべて）に分類されます。 issue に関連付けられるチャンネルは、デフォルトチャンネル（すべて）、channels、および channelUUIDs です。

拡張フィールド extend 説明

パラメータ名 パラメータタイプ 必須 パラメータ説明
channels array N 説明内の #: issue を配信するリソースリスト。
linkList array N issue リンクを追加
members array N 説明内の @: issue の通知先となる通知オブジェクトメンバー
manager array N 担当者情報（ユーザーアカウント uuid、メールアドレス、チーム uuid）
extra json N issue 作成者/担当者名などの情報。フロントエンド表示用

extend フィールドの例: 

{
    "members": [
        {
            "type": "@",
            "uuid": "acnt_xxxx32",
            "exists": true
        }
    ],
    "channels": [
        {
            "type": "#",
            "uuid": "chan_xxxx32",
            "exists": true
        }
    ],
    "manager": [
        "acnt_xxxx32",
        "xxx@guance.com",
        "group_xxx"
    ],
    "linkList": [
        {
            "name": "解決",
            "link": "https://sd.com",
        }
    ],
    "extra": {
            "creator": {
                "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/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"dcacscsc","level":"system_level_2","description":"<span>cdscascas</span>","extend":{"channels":[{"type":"#","uuid":"chan_xxxx32"}],"view_isuue_url":"/exceptions/exceptionsTracking?leftActiveKey=ExceptionsTracking&activeName=ExceptionsTracking&w=wksp_xxxx32&classic=exceptions_tracing&issueName=SYS&activeChannel=%7BdefaultChannelUUID%7D&sourceType=exceptions_tracing&__docid=%7BissueUUID%7D"},"attachmentUuids":[]}'\
--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"
}

フィードバック

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