기본 설정 상태 수정¶
POST /api/v1/issue-level/config/set
개요¶
현재 워크스페이스의 시스템 기본 Issue 레벨을 활성화하거나 비활성화합니다.
호출 전 및 사용 단계¶
isDisabled=true는 비활성화, false는 활성화입니다. 성공하면 설정 레코드를 반환하며, 실제 스위치는 content.config.isDisabled에서 읽습니다. 설정 조회 API를 다시 호출할 때 스위치는 content.isDisabled에 있습니다. 이 설정은 기존 Issue를 자동으로 수정하지 않으며 사용자 정의 레벨도 삭제하지 않습니다. 현재 버전에서는 사용자 정의 레벨을 최소 하나 이상 유지해야 한다는 검증을 강제하지 않으므로, 비활성화 전에 유효 레벨 목록과 비즈니스 사용 현황을 먼저 확인하시기 바랍니다. 플랫폼 전역 레벨이 우선 적용되는 경우 이 워크스페이스 스위치는 전역 선택을 덮어쓰지 않습니다. 작업은 현재 API Key가 속한 워크스페이스를 사용합니다. 동일한 워크스페이스에서 리소스 식별자를 가져오세요.
요청 헤더¶
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Body 요청 파라미터¶
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| isDisabled | bool | Y | 필수 boolean이며, true는 비활성화, false는 활성화입니다. null 허용: False 예: true획득 또는 입력 방법: 시스템 기본 레벨을 계속 제공할지 여부에 따라 선택합니다. 비활성화는 true, 복구는 false를 사용합니다. |
파라미터 추가 설명¶
설정은 활성화 또는 비활성화 감사 기록을 남기지만, Issue 생성/변경 알림을 직접 전송하지는 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/issue-level/config/set' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"isDisabled":true}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 레코드 번호입니다. Issue 생성/답글 응답이 영속화 전에 구성되는 경우 null일 수 있으며, 리소스 작업에는 uuid를 사용하세요. |
| content.uuid | string | 리소스 UUID입니다. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.status | integer | 레코드 상태이며, 0은 정상, 3은 삭제됨입니다. Issue 비즈니스 상태 statusType과 구분합니다. |
| content.creator | string | 생성 호출 주체이며, API Key 식별자, 계정 또는 시스템 주체일 수 있습니다. |
| content.updator | string | 최근 업데이트 주체이며, 설정되지 않은 경우 빈 문자열입니다. |
| content.createAt | integer | 생성 시간, Unix 초입니다. |
| content.updateAt | integer | 최근 업데이트 시간, Unix 초이며, 업데이트되지 않은 경우 -1일 수 있습니다. |
| content.deleteAt | integer | 삭제 시간, Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.keyCode | string | 설정 레코드의 유형 식별자입니다. |
| content.config | object | 스위치 설정입니다. |
| content.config.isDisabled | boolean | 저장된 시스템 기본 레벨 비활성화 스위치입니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언이며, content 계층에만 부가됩니다. |
{
"code": 200,
"content": {
"id": 401,
"uuid": "ctcf_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"keyCode": "IssueLevelDisabled",
"config": {
"isDisabled": true
},
"declaration": {}
},
"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 객체를 제출하세요. |
| 500 | ft.InternalServerError | 레벨 또는 설정 저장, 감사 또는 기타 내부 처리 실패 | 내부 오류 | 먼저 현재 레벨 또는 설정을 읽어 결과를 확인한 후 재시도 여부를 결정하세요. 계속 실패하면 traceId를 제공하세요. |