콘텐츠로 이동

레벨 목록



GET /api/v1/issue-level/list

개요

현재 워크스페이스에서 Issue에 실제로 사용할 수 있는 유효 레벨 집합을 가져옵니다.

호출 전 및 사용 단계

먼저 이 API를 호출한 다음, 반환된 항목의 uuid를 Issue 생성 또는 수정 시 level에 사용합니다. P0/P1과 같은 고정된 표시 이름에 의존하지 않습니다. 플랫폼에서 전역 레벨을 활성화한 경우 전역 관리 레벨을 반환하고, 그렇지 않으면 현재 활성화된 시스템 기본 레벨과 이 워크스페이스의 사용자 정의 레벨을 반환합니다. 시스템 기본 레벨이 비활성화된 경우 이 유효 목록에 포함되지 않습니다. API는 content 배열을 직접 반환하며 페이지네이션하지 않습니다. 순서는 심각도 정렬을 의미하지 않습니다. 유효한 구성이 없으면 빈 배열일 수 있습니다. 작업은 현재 API Key가 속한 워크스페이스를 사용합니다. 동일한 워크스페이스에서 리소스 식별자를 가져오세요.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

파라미터 추가 설명

이 API는 실제 유효 레벨을 반환하며 전체 사용자 정의 레벨 관리 목록이 아닙니다. 전역 레벨로 재정의된 이 워크스페이스의 사용자 정의 레벨은 표시되지 않을 수 있습니다. 기본 레벨 이름 및 설명은 워크스페이스 언어에 따라 변경될 수 있습니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/issue-level/list' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content array<object> 유효 레벨 배열입니다. 항목은 출처에 따라 서로 다른 선택 필드를 제공합니다.
content[].uuid string 레벨 UUID입니다. Issue.level에 계속 사용할 수 있는지는 현재 유효 레벨 목록을 기준으로 해야 합니다.
content[].name string 레벨 이름이며 워크스페이스 언어 또는 레벨 구성에 따라 표시됩니다.
content[].color string 색상 문자열이며 일반적으로 #RRGGBB입니다.
content[].description string 레벨 설명입니다.
content[].isDefault boolean 시스템 기본 레벨 항목은 true를 제공하며, 다른 항목은 생략될 수 있습니다.
content[].isManage boolean 플랫폼 전역 레벨을 사용하는 경우 true를 제공하며, 워크스페이스 사용자 정의 레벨은 생략될 수 있습니다.
content[].status integer 데이터베이스 레벨 항목에서 제공하는 레코드 상태이며 일반적으로 0입니다.
content[].declaration object 또는 null 비어 있지 않은 각 레벨 객체에 추가된 워크스페이스 공통 선언입니다.
{
  "code": 200,
  "content": [
    {
      "uuid": "system_level_1",
      "name": "P1",
      "description": "핵심 비즈니스 기능을 사용할 수 없으나 사용자 영향은 제한적입니다.",
      "color": "#FF7931",
      "isDefault": true,
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

유효 레벨이 없으면 빈 배열을 성공적으로 반환하며, 추가 비즈니스 파라미터는 없습니다. 인증, 버전 및 속도 제한 실패에는 공통 오류 설명을 사용합니다.

문서 평가

이 페이지가 도움이 되었나요?