사용자 정의 등급 수정¶
POST /api/v1/incidents/level/{incidents_level_uuid}/modify
개요¶
현재 워크스페이스의 사용자 정의 인시던트 등급 이름, 색상 및 설명을 수정합니다.
호출 전 준비 및 사용 단계¶
Key에는 incidents.incidentsLevelManage 권한이 필요하며, 현재 Key가 속한 워크스페이스에만 적용됩니다. 이 모듈은 Issue 등급 API와 기본 등급 및 기본 등급 설정을 공유하므로, 변경 사항이 인시던트/Issue 등급 선택에 동시에 영향을 줄 수 있습니다. 이 모듈에서만 독립적인 복사본을 생성하는 것은 아닙니다. 백엔드에서 전역 등급을 활성화한 경우 실제 유효한 등급 선택은 전역 설정이 우선 결정할 수 있으며, 이 워크스페이스 관리 목록에는 여전히 기본 및 워크스페이스 사용자 정의 항목만 표시되고 백엔드 전역 등급은 포함되지 않습니다. 관리자는 적용 기준을 확인한 후 수정하고, 관리 목록의 모든 항목을 사용 가능한 등급으로 간주하지 마십시오.
실제로는 name/color/description만 업데이트되며, 생략하면 유지되고 description이 빈 문자열이면 초기화됩니다. extend는 현재 무시됩니다. {}를 전달해도 업데이트 시간은 갱신됩니다. 등급 설정만 변경하며, 과거 인시던트의 level UUID를 일괄 변경하거나 알림을 재발송하지 않습니다. 과거 화면 표시는 해당 등급에 따라 이름/색상을 다시 해석할 수 있습니다. 이름 수정 시 동일 워크스페이스의 활성 사용자 정의 등급과 중복되는지 확인합니다. 검증을 위해 old_name을 추가로 반환하지만, 모든 이전 필드의 스냅샷을 반환하지는 않습니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| incidents_level_uuid | string | Y | 현재 워크스페이스의 사용자 정의 등급 UUID입니다. system_level_0 등 기본 등급이나 백엔드 전역 등급은 입력할 수 없습니다. 예: issl_example조회 또는 입력 방법: 인시던트 등급 목록에서 isDefault=false인 항목의 uuid를 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>조회 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| color | string | 생성 시 필수, 수정 시 생략 가능합니다. 문자열로만 선언되며 색상 형식은 검증하지 않고 데이터베이스는 128자입니다. 유효한 16진수 색상을 사용할 것을 권장합니다. null 허용: False 예: #3F94DC조회 또는 입력 방법: 고객 UI 색상 구성에 따라 입력하며 #RRGGBB를 권장합니다. |
|
| description | string | 선택적 문자열로, 생성 시 생략하면 빈 문자열, 수정 시 생략하면 유지되며, 빈 문자열이면 초기화되고 null은 허용하지 않습니다. 데이터베이스는 1024자이며 호출 측에서 제한해야 합니다. null 허용: False 예: 일부 기능 영향조회 또는 입력 방법: 비즈니스 담당자가 등급 판정 기준을 작성합니다. |
|
| extend | json | 생성 시 객체 또는 null만 허용하며 생략하면 기본값 {}입니다. 배열/문자열 등은 선언 검증 단계에서 406으로 거부됩니다. 수정 라우트에 선언되어 있지만, 검증을 통과한 객체나 null도 컨트롤러에서 무시되어 기존 extend를 변경하지 않으며 {}로 초기화할 수 없습니다. null 허용: True 예: {}조회 또는 입력 방법: 생성 시 저장해야 하는 JSON 비즈니스 확장을 입력합니다. |
|
| name | string | 생성 시 필수, 수정 시 생략 가능합니다. 동일 워크스페이스의 활성 사용자 정의 등급과 이름이 중복될 수 없습니다. 선언상 최대 256자, 데이터베이스 128자이므로 1~128자를 권장합니다. 현재 비어 있지 않음을 강제하지 않습니다. null 허용: False 최대 길이: 256 예: P3-경미조회 또는 입력 방법: 비즈니스 심각도에 따라 식별하기 쉬운 이름을 정합니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/level/issl_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"color":"#6C7AEB","description":"수정된 판정 설명"}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 데이터베이스 행 ID입니다. 비즈니스 식별에는 uuid를 사용하며, 제출 전 스냅샷은 null일 수 있습니다. |
| content.uuid | string | 해당 리소스 UUID입니다. |
| content.status | integer | 데이터베이스 상태로 0은 활성, 3은 삭제입니다. 인시던트 비즈니스 상태인 incidentsStatus와 다릅니다. |
| content.creator | string | 생성 주체이며, API Key는 일반적으로 wsak_리소스UUID입니다. |
| content.updator | string | 최근 업데이트 주체이며, 업데이트가 없으면 비어 있을 수 있습니다. |
| content.createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.updateAt | integer | Unix 초 단위 최근 업데이트 시간입니다. |
| content.deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않았으면 -1입니다. |
| content.workspaceUUID | string | 등급이 속한 워크스페이스입니다. |
| content.name | string | 사용자 정의 등급 이름입니다. |
| content.color | string | 색상 표시 값으로 일반적으로 #RRGGBB이며, 서버에서 색상 형식을 검증한다고 보장하지 않습니다. |
| content.description | string | 등급 설명입니다. |
| content.extend | JSON 또는 null | 생성 시 저장된 확장으로, 생략하면 {}이며 명시적 null도 저장할 수 있습니다. 수정 진입점에서는 현재 이 필드를 무시합니다. |
| content.extend.사용자 정의 필드 | JSON | 호출 측이 저장한 동적 비즈니스 확장으로, 추가 제어 파라미터가 아닙니다. |
| content.isManage | boolean | 이 워크스페이스에서 생성된 경우 false이며, 백엔드 전역 등급은 이 모듈에서 수정하지 않습니다. |
| content.old_name | string | 이번 수정 전 이름이며, 이름이 변경되지 않아도 반환됩니다. |
| content.declaration | object | 현재 워크스페이스의 공통 선언입니다. |
{
"code": 200,
"content": {
"id": 123,
"uuid": "issl_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427260,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "P3-경미",
"color": "#6C7AEB",
"description": "수정된 판정 설명",
"extend": {},
"isManage": false,
"declaration": {},
"old_name": "P3-경미"
},
"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 파일 형식 오류 | 객체를 제출합니다. |
| 404 | ft.ObjectNotExists | 현재 워크스페이스에서 삭제되지 않은 해당 사용자 정의 등급을 찾을 수 없음 | 지정한 객체가 존재하지 않음 | 이 워크스페이스 목록에서 isDefault=false인 uuid를 가져옵니다. |
| 406 | ft.IssueLevelNameExists | 수정한 이름이 다른 활성 사용자 정의 등급과 중복됨 | 등급 이름이 이미 존재함 | 사용되지 않은 이름을 선택합니다. |
| 500 | ft.InternalServerError | 데이터베이스, 설정/ID 형식 또는 처리되지 않은 시스템 예외 | 내부 오류 | 읽기는 백오프 후 재시도할 수 있으며, 쓰기는 먼저 설정/등급 목록을 다시 읽어 저장 여부를 확인한 후 재시도 여부를 결정합니다. |