콘텐츠로 이동

기본 구성 상태 조회



GET /api/v1/issue-level/config/get

개요

현재 워크스페이스 시스템 기본 Issue 레벨의 활성화 스위치를 조회합니다.

호출 전 및 사용 단계

Query 파라미터는 필요하지 않습니다. content.isDisabled=false는 시스템 기본 레벨이 활성화되었음을, true는 비활성화되었음을 의미하며, 구성을 아직 저장하지 않은 경우 기본값은 false입니다. 이 스위치는 최종적으로 유효한 레벨 집합을 의미하지 않으며, 플랫폼 전역 레벨이 활성화된 경우 전역 레벨이 우선 적용되므로 유효 레벨 목록을 함께 확인하여 선택 가능한 항목을 확인하시기 바랍니다. 작업은 현재 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/config/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

HTTP 200, application/json. 아래 예시는 직접 조회 가능한 주요 필드를 보여줍니다.

필드 타입 설명
content.isDisabled boolean 시스템 기본 레벨의 비활성화 여부이며, 기본값은 false입니다.
content.declaration object 또는 null 워크스페이스 공통 선언이며, content의 해당 레벨에만附加됩니다.
{
  "code": 200,
  "content": {
    "isDisabled": false,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

스위치를 저장하지 않은 경우에도 성공 시 isDisabled=false를 반환하며 구성이 존재하지 않는다는 오류를 발생시키지 않습니다. 인증, 버전 및 속도 제한 실패는 공통 오류 설명을 참고하십시오.

문서 평가

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