용어 생성

새 용어를 생성합니다. 이 작업은 관리자 권한을 요구합니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d term="시각" \
     -d code="_time" \
     -d category="field" \
     -d type="DATE" \
     -d locale="ko" \
     -d description="로그 생성 시각" \
     -X POST "https://HOSTNAME/api/sonar/glossary/terms"

요청 매개변수

• type은 DATE, STRING, IP, PORT, SHORT, INT, LONG, COUNTRY, FLOAT, DOUBLE, BOOL, MD5, SHA1, URL, SHA256, DOMAIN 중 하나입니다.

정상 응답

{}

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

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

term이 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'term' must be 1 to 50 characters and must not contain special characters or spaces."
}

term이 중복된 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "duplicated-term [term: term, locale: locale]"
}

code가 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'code' must be 1 to 50 characters, alphanumeric or underscore characters only, and must not start with a number"
}

code가 중복된 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "duplicated-code [code: code, locale: locale]"
}

category가 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "invalid-category: invalid-category"
}

type이 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "type should be one of IP, SHA256, BOOL, DATE, INT, URL, STRING, DOUBLE, COUNTRY, SHORT, LONG, FLOAT, MD5, PORT, DOMAIN, SHA1"
}

locale이 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "unsupported-locale: ru"
}

description이 너무 긴 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'description' must be shorter than or equal to 2000 characters."
}

권한이 없는 경우

HTTP 상태 코드 500 응답

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