콘텐츠로 이동

가져오기



POST /api/v1/tag/import

개요

전역 태그 템플릿을 일괄 가져옵니다. 이름 중복 검사, 건너뛰기 및 덮어쓰기를 지원합니다.

Body 요청 매개변수

매개변수명 유형 필수 설명
tags array Y 태그 템플릿 목록
비어 있음 허용: False
tags[*] None
tags[*].name string Y 태그 이름
비어 있음 허용: False
tags[*].description string 태그 설명
비어 있음 허용: False
tags[*].colour string 태그 색상
비어 있음 허용: False
repeatTagNameOp string 태그 이름 중복 처리 전략
비어 있음 허용: False
선택 가능 값: ['check', 'skip', 'recover']

매개변수 추가 설명

이 API는 전역 태그 템플릿을 별도로 가져오는 데 사용됩니다.

호출 흐름

  1. tags 배열을 준비합니다. 각 요소는 하나의 태그 템플릿을 나타냅니다.
  2. repeatTagNameOp를 통해 동일한 이름의 태그가 있을 때의 처리 전략을 지정합니다.
  3. 전략이 check이고 동일한 이름의 태그가 존재하면 API는 repeat_name을 직접 반환하며 데이터베이스에 저장하지 않습니다.

repeatTagNameOp 설명

값 설명
check 중복만 확인합니다. 동일한 이름의 태그가 있으면 repeat_name 반환
skip 이미 존재하는 동일한 이름의 태그를 건너뛰고, 존재하지 않는 태그만 가져옵니다
recover 대상 워크스페이스에 동일한 이름의 태그가 이미 있을 경우 해당 태그의 description 및 colour를 덮어씁니다

템플릿 필드

필드 type 필수 설명
name string 예 태그 이름
description string 아니요 태그 설명
colour string 아니요 태그 색상

응답 설명

  • 가져오기 실행 성공 시 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"
}

문서 평가

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