インポート¶

POST /api/v1/tag/import

概要¶

グローバルタグテンプレートを一括インポートします。名前重複チェック、スキップ、上書きに対応しています。

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

パラメータ補足説明¶

このAPIは、グローバルタグテンプレートを個別にインポートするために使用します。

呼び出しフロー

1. tags 配列を準備します。各要素は1つのタグテンプレートを表します。
2. repeatTagNameOp で、同名タグが存在する場合の処理ポリシーを指定します。
3. ポリシーが check で同名タグが存在する場合、APIは直接 repeat_name を返し、データベースへの書き込みは行われません。

repeatTagNameOp の説明

テンプレートフィールド

レスポンスの説明

• インポートが成功した場合は successCount、failCount を返します。
• 一部のオブジェクトの実行に失敗した場合、レスポンスに failedNames が追加で含まれます。
• check モードで重複が検出された場合は repeat_name を返します。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/tag/import' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"repeatTagNameOp":"recover","tags":[{"name":"コアサービス","description":"コアサービスタグ","colour":"style_key3"}]}'

レスポンス¶

{
    "code": 200,
    "content": {
        "successCount": 2,
        "failCount": 0
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
}