사용자 지정 등급 삭제¶
POST /api/v1/issue-level/delete
개요¶
현재 워크스페이스의 사용자 지정 등급을 일괄 삭제합니다.
호출 전 및 사용 단계¶
이 워크스페이스의 사용자 지정 등급 UUID만 전달하세요. system_level_ 접두사가 붙은 시스템 기본 등급은 삭제할 수 없습니다. 제출 전에 이러한 등급이 여전히 필요한 Issue 또는 연결된 규칙을 먼저 조정하세요. 이 API는 기존 Issue의 level을 자동으로 마이그레이션하지 않습니다. 찾을 수 없는 사용자 지정 등급 식별자는 변경을 발생시키지 않을 수 있으며, 성공 시 true를 반환하더라도 모든 UUID가 존재한다는 의미는 아닙니다. 빈 배열을 제출하지 마세요. 현재 빈 배열 경로는 감사 처리 중 내부 오류를 반환할 수 있습니다. 작업은 현재 API Key가 속한 워크스페이스를 사용합니다. 동일한 워크스페이스에서 리소스 식별자를 가져오세요.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져오세요. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| uuids[*] | string | 단일 등급 UUID입니다. 예시: issl_example획득 또는 입력 방법: 이 워크스페이스에서 issl_로 시작하는 사용자 지정 등급 UUID를 사용하세요. |
|
| uuids | array | Y | 삭제할 사용자 지정 등급 UUID 배열이며 필수입니다. 시스템 기본 등급은 포함하지 않습니다. null 허용: False 예시: ["issl_example"]획득 또는 입력 방법: 사용자 지정 등급 생성 응답에서 저장된 content.uuid 또는 유효한 등급 목록에 표시되는 항목에서 가져오세요. 삭제하기 전에 이후에 더 이상 사용하지 않을 것인지 확인하고, 실제 UUID를 하나 이상 제출하세요. |
파라미터 추가 설명¶
삭제하면 해당 등급은 더 이상 이 워크스페이스에서 유효한 등급으로 사용되지 않습니다. 기존 Issue에는 이전 UUID와 읽을 수 있는 표시 정보가 남아 있을 수 있습니다. 이 작업은 등급 설정을 삭제하며 Issue는 삭제하지 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/issue-level/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"uuids":["issl_example"]}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 삭제 처리가 완료되면 true입니다. 항목별 결과는 제공하지 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인하세요. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정하세요. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아닙니다 | 일부 json 파일 형식 오류 | JSON 객체를 제출하세요. |
| 406 | ft.NotAllowDeleteDefaultIssueLevel | uuids에 system_level_ 접두사 기본 등급이 포함되어 있습니다 | 워크스페이스 기본 등급 설정 정보는 삭제할 수 없습니다 | 기본 등급을 제거하세요. 기본 등급을 비활성화해야 하는 경우 기본 등급 스위치를 사용하세요. |
| 500 | ft.InternalServerError | 등급 또는 설정 저장, 감사 또는 기타 내부 처리에 실패했습니다 | 내부 오류 | 먼저 현재 등급 또는 설정을 읽어 결과를 확인한 후 재시도 여부를 결정하세요. 계속 실패하면 traceId를 제공하세요. |