コンテンツにスキップ

エクスポート


POST /api/v1/tag/export

概要

タグリストのフィルター条件に従って、グローバルタグテンプレートをエクスポートします。

Query リクエストパラメータ

パラメータ名 型 必須 説明
search string タグ名の検索
空の場合は許可されません: False
filter string フィルター条件
空の場合は許可されません: False
指定可能な値: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'SmartCheckerRefTagObject', 'DialingRefTagObject', 'SecurityRuleRefTagObject']

パラメータ補足説明

このAPIはグローバルタグの単独エクスポート専用であり、ワークスペースリソースのエクスポートタスクを経由する必要はありません。

リクエスト説明

  1. エクスポートパラメータはタグリストAPIと同一ですが、ページネーションパラメータはサポートされません。
  2. 現在サポートされているフィルターパラメータは search、filter です。
  3. 現在のワークスペースで有効なタグのみをエクスポートします。
  4. 戻り値は JSON リストであり、そのまま /tag/import のインポートテンプレートとして使用できます。

エクスポートフィールド

フィールド type 説明
name string タグ名
description string タグの説明
colour string タグの色

エクスポートされないフィールド

  • uuid
  • workspaceUUID
  • creator
  • updator
  • createAt
  • updateAt

リクエスト例

curl 'https://openapi.guance.com/api/v1/tag/export?search=%E6%A0%B8%E5%BF%83&filter=CheckerRefTagObject' \
-H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

{
    "code": 200,
    "content": [
        {
            "name": "核心服务",
            "description": "核心服务标签",
            "colour": "style_key3"
        },
        {
            "name": "线上环境",
            "description": "",
            "colour": "default"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
}

フィードバック

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