콘텐츠로 이동

내보내기


POST /api/v1/tag/export

개요

태그 목록 필터 조건에 따라 전역 태그 템플릿을 내보냅니다.

Query 요청 매개변수

매개변수명 유형 필수 설명
search string 태그 이름 검색
비어 있음 허용: False
filter string 필터 조건
비어 있음 허용: False
선택 가능한 값: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'SmartCheckerRefTagObject', 'AiCheckerRefTagObject', '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"
}

문서 평가

이 페이지가 도움이 되었나요?