AbleFlowDocs

진단

프로젝트 회차 이력 페이지 조회(기본 정렬: seq 내림차순)

GET/api/projects/{projectId}/diagnoses

  • Scopediagnoses:read
  • Since1.0.0
  • Success200
  • Demo tokenAllowed
  • Personal dataThe response contains personal data

id diagnoses.list

Path parameters

GetDiagnosisPaginationRequestPath

  • projectIdstringrequired

Query

쿼리의 배열은 콤마로 이어 보낸다(status=A,B)

GetDiagnosisPaginationRequestParams

limit 최대 10000(공통 PaginationRequest.MAX_LIMIT)

  • offsetnumberoptional

    시작 오프셋

  • limitnumberoptional

    조회 개수

  • sortstringoptional

    정렬 조건. 콤마로 구분하며 각 항목은 property 또는 property:ASC|DESC 형식

  • statusAbleflowDiagnosisStatus[]optional

    콤마 구분

  • triggerAbleflowDiagnosisTrigger[]optional

    AbleFlow - 회차를 만든 계기. 사용자 실행은 MANUAL

  • fromstringoptional

    만든 시각 범위(ISO-8601, from 포함 · to 미포함)

  • tostringoptional
  • requestedBystring[]optional

    실행한 사람 memberId(콤마 구분)

Response 200

GetDiagnosisPaginationResponse

  • countnumberrequired

    전체 개수

  • prevstringrequirednull

    이전 페이지 query string. 키는 늘 있고, 첫 페이지면 null

  • nextstringrequirednull

    다음 페이지 query string. 키는 늘 있고, 마지막 페이지면 null

  • DiagnosisResponseItem[]required

    조회 결과

    • idstringrequired
    • seqnumberrequired

      프로젝트 안 표시 번호(#1, #2 …)

    • triggerAbleflowDiagnosisTriggerrequired
      • MANUAL
      • FREE_TRIAL
      • SCHEDULED
      • PRE_DEPLOY

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 회차를 만든 계기. 사용자 실행은 MANUAL

    • statusAbleflowDiagnosisStatusrequired
      • QUEUED
      • RUNNING
      • COMPLETED
      • PARTIAL
      • FAILED
      • CANCELED

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 회차 상태. 진행 중(QUEUED · RUNNING)은 프로젝트에 하나

    • screenCountnumberrequired
    • analysisCountnumberrequired

      분석 수(화면 × 뷰포트)

    • completedCountnumberrequired

      끝난(COMPLETED · FAILED) 분석 수

    • failedCountnumberrequired
    • uxRiskScorenumberoptional

      끝난 회차(COMPLETED · PARTIAL)만

    • gradeAbleflowGradeoptional
      • SAFE
      • CAUTION
      • RISK
      • CRITICAL

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 대표 위험도 구간: 0~29 SAFE · 30~49 CAUTION · 50~69 RISK · 70~100 CRITICAL

    • previousUxRiskScorenumberoptional

      바로 앞 끝난 회차의 대표 위험도(변화 ▲▼)

    • failureReasonstringoptional

      FAILED 일 때 한 줄 이유(한국어 원문)

    • failureCodestringoptional

      회차 실패 문구 키(예: allAnalysesFailed, 키 목록은 AbleflowFailureMessageArgs 설명). 키를 쓰기 전 행은 빠진다 — 그때는 failureReason 을 그대로 보인다

    • AbleflowMemberRefrequired

      AbleFlow - 사람 표시. 이름 · 이메일은 계정 DB 에서 채운다(찾지 못하면 name 없음). 공개 API 토큰에 members:read 가 없으면 email 이 빠진다

    • createdAtstringrequired
    • startedAtstringoptional
    • finishedAtstringoptional

Errors

9 errors common to every public API
Common to every public API
StatusCodeWhen
400UNSUPPORTED_API_VERSIONAbleFlow-Version(또는 토큰 고정 버전)을 맞출 수 없다. detail { requested, supported }
401UNAUTHORIZEDAuthorization 머리글이 없다(토큰 없음). 공개 API 요청으로 보지 않아 응답에 AbleFlow-Version 머리글이 없다
401INVALID_TOKEN토큰이 틀렸거나 폐기됐다(발급자가 워크스페이스를 나가 폐기된 토큰 포함)
401TOKEN_EXPIRED토큰이 만료됐다
403INSUFFICIENT_SCOPE토큰 범위가 모자란다. detail { required }
403DEMO_READ_ONLY데모 토큰은 GET · HEAD 만 부를 수 있다
403PLAN_FEATURE_REQUIRED워크스페이스 요금제에 공개 API 가 없거나 체험이 끝났다(요금제로 막을 때, 데모 토큰 제외). detail { target: PUBLIC_API, reason: PLAN_FEATURE | TRIAL_ENDED, suggestedPlan? }
404RESOURCE_NOT_FOUND자원이 없거나 토큰이 묶인 워크스페이스 밖이다
429API_RATE_LIMITED호출 한도를 넘었다. Retry-After(초)