개선 과제
개선 과제 페이지 조회(기본 정렬: 심각도 높은 순 → 만든 시각)
GET/api/workspaces/{workspaceId}/issues
- Scope
issues:read - Since
1.0.0 - Success
200 - Demo tokenAllowed
- Personal dataThe response contains personal data
id issues.list
Path parameters
GetIssuePaginationRequestPath
workspaceIdstringrequired
Query
쿼리의 배열은 콤마로 이어 보낸다(status=A,B)
GetIssuePaginationRequestParams
offsetnumberoptional시작 오프셋
limitnumberoptional조회 개수
sortstringoptional정렬 조건. 콤마로 구분하며 각 항목은 property 또는 property:ASC|DESC 형식
keywordstringoptional제목 검색어(대소문자 무시). 한국어 원문 제목과 요청 언어(?locale= en · ja · zh-CN · zh-Hant)의 AI 제목 번역에서 찾는다(OR)
titleKeysstring[]optional제목 문구 키(콤마 구분, 예: textContrastLow — 키 목록은 AbleflowFindingMessageArgs 설명). keyword 와 함께 오면 제목에 keyword 가 들어 있거나 제목 문구 키가 이 중 하나인 과제(OR). 규칙 제목 원문은 한국어라 다른 언어 화면의 검색어는 원문에 없다 — 화면 언어 메시지에서 검색어가 들어간 키를 찾아 같이 보낸다 (AI 제목은 서버가 요청 언어 번역에서 찾는다). 모르는 키는 무시한다(형식이 틀리면 400)
projectIdsstring[]optional콤마 구분
criterionAbleflowCriterion[]optionalAbleFlow - 진단 기준
severityAbleflowSeverity[]optionalAbleFlow - 위험 구간 심각도(화면 표기 높음 · 보통 · 낮음)
statusAbleflowIssueStatus[]optionalAbleFlow - 개선 과제 상태(화면 표기 할 일 · 진행 중 · 확인 대기 · 완료 · 보류 · 무시됨). DONE · DISMISSED 가 닫힌 과제(ON_HOLD 도 열린 과제). DISMISSED 는 다음 회차 확인 · 자동 다시 열기에서 빠진다
assigneestring[]optional담당 memberId(콤마 구분) · "me" 는 나 · "none" 은 담당 없음. 그 밖의 값은 400
Response 200
GetIssuePaginationResponse
countnumberrequired전체 개수
prevstringrequirednull이전 페이지 query string. 키는 늘 있고, 첫 페이지면 null
nextstringrequirednull다음 페이지 query string. 키는 늘 있고, 마지막 페이지면 null
- IssueResponseItem[]required
조회 결과
idstringrequiredseqnumberrequired워크스페이스 안 표시 번호
projectIdstringrequiredprojectNamestringrequiredtitlestringrequired과제 제목(만들 때 묶음 대표 위험 구간의 제목). 규칙 제목은 한국어 원문(titleKey 로 옮긴다), AI 판단 제목은 요청 언어(?locale=) 번역이 있으면 그 글 (만든 회차의 같은 묶음 · 같은 원문 제목 위험 구간의 번역, 그 회차가 지워졌으면 한국어 원문)
titleKeystringoptional규칙 위험 구간에서 온 제목의 문구 키(키 목록은 AbleflowFindingMessageArgs 설명). AI 판단 제목 · 키가 없는 옛 행은 빠진다 — 그때는 title 을 그대로 보인다
- AbleflowFindingMessageArgsoptional
문구 키의 이름 붙은 값(값 자리가 없는 문구 · 키가 없으면 빠진다)
criterionAbleflowCriterionrequiredCOLOR_DEPENDENCYLOW_CONTRASTINFORMATION_DENSITYLAYOUT_COMPLEXITYSTATUS_COMMUNICATION
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
AbleFlow - 진단 기준
severityAbleflowSeverityrequiredHIGHMEDIUMLOW
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
AbleFlow - 위험 구간 심각도(화면 표기 높음 · 보통 · 낮음)
statusAbleflowIssueStatusrequiredTODOIN_PROGRESSIN_REVIEWDONEON_HOLDDISMISSED
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
AbleFlow - 개선 과제 상태(화면 표기 할 일 · 진행 중 · 확인 대기 · 완료 · 보류 · 무시됨). DONE · DISMISSED 가 닫힌 과제(ON_HOLD 도 열린 과제). DISMISSED 는 다음 회차 확인 · 자동 다시 열기에서 빠진다
- AbleflowMemberRefoptional
AbleFlow - 사람 표시. 이름 · 이메일은 계정 DB 에서 채운다(찾지 못하면 name 없음). 공개 API 토큰에 members:read 가 없으면 email 이 빠진다
screenCountnumberrequired영향 분석 수 · 묶은 위험 구간 수(그 프로젝트의 가장 최근 끝난 회차 기준, 그 회차에 없으면 0)
findingCountnumberrequiredelementHintstringoptional최근 끝난 회차에서 이 과제 묶음의 요소 단서(같은 제목 과제를 구분). 그 회차에 묶음이 없으면 빠진다
elementHintKeystringoptionalelementHint 가 규칙의 고정 단서일 때 표시용 키(예: firstScreen). 셀렉터 · AI 단서는 빠진다
latestDiagnosisEvaluatedbooleanoptional그 최근 끝난 회차가 이 과제의 기준을 평가했는지(끝난 분석 중 하나라도 그 기준 점수를 냈는지). false 면 screenCount · findingCount 의 0 은 "고쳐짐"이 아니라 "이번 회차는 보지 않음"(기준 일부만 고른 진단 등). 끝난 회차가 없으면 없음
- objectoptional
만든 회차와 그때 우선순위 순위(회차가 지워졌으면 빠진다). finishedAt 은 그 회차를 실패만 다시 하는 중(재실행 중)에는 없음
- objectoptional
다음 회차 확인(무시됨을 뺀 모든 과제, 확인 전에는 없음). 같은 묶음 키가 사라지면 CONFIRMED, 남으면 REOPENED(열린 과제는 아직 남음). 완료 과제가 REOPENED 면 서버가 TODO 로 다시 연다(같은 묶음의 열린 과제가 있으면 결과만). at = 확인한 회차가 끝난 시각
createdAtstringrequiredupdatedAtstringrequiredeffortAbleflowEffortoptionalEASYMEDIUMHARD
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
고치는 품(기준별 고치는 방법에서 읽는다. 운영 콘솔에서 바꾸면 바로 바뀐다)
Errors
9 errors common to every public API
| Status | Code | When |
|---|---|---|
| 400 | UNSUPPORTED_API_VERSION | AbleFlow-Version(또는 토큰 고정 버전)을 맞출 수 없다. detail { requested, supported } |
| 401 | UNAUTHORIZED | Authorization 머리글이 없다(토큰 없음). 공개 API 요청으로 보지 않아 응답에 AbleFlow-Version 머리글이 없다 |
| 401 | INVALID_TOKEN | 토큰이 틀렸거나 폐기됐다(발급자가 워크스페이스를 나가 폐기된 토큰 포함) |
| 401 | TOKEN_EXPIRED | 토큰이 만료됐다 |
| 403 | INSUFFICIENT_SCOPE | 토큰 범위가 모자란다. detail { required } |
| 403 | DEMO_READ_ONLY | 데모 토큰은 GET · HEAD 만 부를 수 있다 |
| 403 | PLAN_FEATURE_REQUIRED | 워크스페이스 요금제에 공개 API 가 없거나 체험이 끝났다(요금제로 막을 때, 데모 토큰 제외). detail { target: PUBLIC_API, reason: PLAN_FEATURE | TRIAL_ENDED, suggestedPlan? } |
| 404 | RESOURCE_NOT_FOUND | 자원이 없거나 토큰이 묶인 워크스페이스 밖이다 |
| 429 | API_RATE_LIMITED | 호출 한도를 넘었다. Retry-After(초) |