용어 일괄 삭제

지정한 용어를 일괄 삭제합니다. 단일 용어의 상세 정보는 용어 조회 API로 확인할 수 있습니다.

필요 권한

관리자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d guids=5ad13151-dbc1-41c0-92a7-dfeb5f534f4c,77e0aa85-14d3-43a9-ab23-4dc97dfc185e \
     -X DELETE \
     https://HOSTNAME/api/sonar/glossary/terms

요청 매개변수

정상 응답

{
  "failures": []
}

• failures (객체 배열): 삭제하지 못한 용어 목록. 모두 삭제되면 빈 배열
  • id (문자열): 삭제하지 못한 용어의 GUID
  • reason (문자열): 실패 사유

존재하지 않는 GUID나 요청에 중복으로 포함된 GUID가 있어도 HTTP 상태 코드 200과 함께 해당 항목을 failures 배열로 반환합니다.

{
  "failures": [
    {
      "id": "54157629-74f7-4d80-be5a-8cb8f0c71087",
      "reason": "term-not-found [guid: 54157629-74f7-4d80-be5a-8cb8f0c71087]"
    },
    {
      "id": "5ad13151-dbc1-41c0-92a7-dfeb5f534f4c",
      "reason": "duplicated-parameter [guid: 5ad13151-dbc1-41c0-92a7-dfeb5f534f4c]"
    }
  ]
}

오류 응답

guids가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "guids should be not null"
}

guids에 GUID 형식이 아닌 값이 포함된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guids should be guid type."
}

권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}