사용자 정의 등급 수정¶
POST /api/v1/issue-level/{issue_level_uuid}/modify
개요¶
현재 워크스페이스 사용자 정의 등급의 이름, 색상 또는 설명을 수정합니다.
호출 전 및 사용 단계¶
생성 시 저장한 issl_ UUID 또는 유효 등급 목록에 표시되는 항목에서 대상을 가져옵니다. 전달한 name, color, description만 수정되며 생략한 필드는 현재 값을 유지합니다. 현재 버전 선언의 extend는 수정 시 저장되지 않습니다. 반환 객체에는 수정 전 이름을 확인할 수 있도록 old_name이 추가되며, 등급을 수정해도 해당 등급을 사용하는 Issue에 저장된 UUID는 변경되지 않습니다. 작업은 현재 API Key가 속한 워크스페이스를 사용하므로, 동일한 워크스페이스에서 리소스 식별자를 가져오세요.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issue_level_uuid | string | Y | 현재 워크스페이스의 사용자 정의 등급 UUID이며, 시스템 기본 등급은 이 인터페이스로 이름을 변경할 수 없습니다. 예시: issl_example가져오기 또는 입력 방법: 사용자 정의 등급 생성 응답의 content.uuid를 저장하거나, 유효 목록에 표시되는 사용자 정의 등급 항목에서 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| extend.사용자 정의 필드 | json | 현재 수정 인터페이스는 이 추가 필드를 갱신하지 않습니다. 예시: urgent가져오기 또는 입력 방법: 통합 시스템이 업무 필요에 따라 이름을 지정하고 필드 유형을 일정하게 유지합니다. |
|
| color | string | 선택적 새 색상이며, 생략하면 유지됩니다. null 허용: False 예시: #FF7931가져오기 또는 입력 방법: 클라이언트에서 표시할 수 있는 색상을 선택하며, #RRGGBB 문자열 사용을 권장합니다. |
|
| description | string | 선택적 새 설명이며, 생략하면 유지됩니다. null 허용: False 예시: 需要当天响应가져오기 또는 입력 방법: 판정 기준과 기대 응답 시간을 간단히 작성하며, 1024자 이내를 권장합니다. 생략하면 빈 문자열입니다. |
|
| extend | json | 여전히 공개 파라미터 선언에 포함되어 있지만 현재 컨트롤러는 수정된 extend를 저장하지 않으므로 생략해도 됩니다. null 허용: True 예시: {}가져오기 또는 입력 방법: 사용자 정의 추가 정보를 저장해야 할 때 JSON 객체를 전달하며, 내용이 없으면 생략하거나 {}를 전달합니다. |
|
| name | string | 선택적 새 이름이며, 생략하면 현재 값을 유지합니다. 128자 이내, 현재 워크스페이스 내 중복 없는 이름을 권장합니다. null 허용: False 최대 길이: 256 예시: 紧急处理가져오기 또는 입력 방법: 업무에 따라 현재 워크스페이스에서 사용하지 않는 이름을 선택하며, 128자 이내를 권장합니다. |
파라미터 추가 설명¶
시스템 기본 또는 플랫폼 전역 관리 등급은 현재 워크스페이스에서 수정 가능한 레코드가 아니므로 ObjectNotExists가 반환될 수 있습니다. 색상이나 이름을 변경해도 기존 Issue의 구독자에게 자동으로 알림이 전송되지 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/issue-level/issl_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产紧急处理","color":"#E94444"}'
응답¶
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.name | string | 사용자 정의 등급 이름입니다. |
| content.color | string | 색상 문자열입니다. |
| content.description | string | 등급 설명입니다. |
| content.extend | object 또는 null | 생성 시 저장된 추가 JSON 객체이며, 등급 수정 인터페이스는 현재 이 필드를 수정하지 않습니다. |
| content.isManage | boolean 또는 number | 플랫폼 관리 등급 여부이며, 워크스페이스 자체 생성 등급은 일반적으로 false입니다. |
| content.old_name | string | 이번 수정 전의 등급 이름입니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언이며, content 이 계층에만 추가됩니다. |
{
"code": 200,
"content": {
"id": 201,
"uuid": "issl_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430860,
"deleteAt": -1,
"name": "生产紧急处理",
"description": "需要当天响应",
"color": "#E94444",
"extend": {},
"isManage": false,
"old_name": "紧急处理",
"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 객체를 제출합니다. |
| 404 | ft.ObjectNotExists | 지정한 리소스가 현재 워크스페이스에 없거나 조회 조건에 부합하지 않음 | 지정한 객체가 존재하지 않음 | 동일 워크스페이스의 리소스 UUID를 다시 가져오고 삭제 여부를 확인합니다. |
| 406 | ft.IssueLevelNameExists | 새 이름이 현재 워크스페이스의 다른 미삭제 사용자 정의 등급과 동일함 | 등급 이름이 이미 존재함 | 사용 중이지 않은 이름으로 변경합니다. |
| 500 | ft.InternalServerError | 등급 또는 설정 저장, 감사 또는 기타 내부 처리 실패 | 내부 오류 | 먼저 현재 등급 또는 설정을 읽어 결과를 확인한 후 재시도 여부를 결정하고, 지속적으로 실패하면 traceId를 제공합니다. |