AbleFlowDocs

화면

화면 페이지 조회(기본 정렬: priority 오름차순 → 넣은 순). 파일 연결까지 끝난 화면만

GET/api/projects/{projectId}/screens

  • Scopescreens:read
  • Since1.0.0
  • Success200
  • Demo tokenAllowed

id screens.list

Path parameters

GetScreenPaginationRequestPath

  • projectIdstringrequired

Query

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

GetScreenPaginationRequestParams

  • offsetnumberoptional

    시작 오프셋

  • limitnumberoptional

    조회 개수

  • sortstringoptional

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

  • keywordstringoptional

    이름 · 주소 · 경로 검색어(대소문자 무시, 100자 이하)

  • labelIdsstring[]optional

    콤마 구분. 하나라도 붙은 화면(OR)

  • unlabeledbooleanoptional

    true 면 레이블 없는 화면만

  • sourceAbleflowScreenSource[]optional

    콤마 구분

  • viewportAbleflowViewportoptional
    • PC
    • MOBILE

    PC 를 주면 PC · BOTH 화면

Response 200

GetScreenPaginationResponse

  • countnumberrequired

    전체 개수

  • prevstringrequirednull

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

  • nextstringrequirednull

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

  • ScreenResponseItem[]required

    조회 결과

    • idstringrequired
    • namestringrequired
    • sourceAbleflowScreenSourcerequired
      • URL
      • IMAGE
      • EXTENSION

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

      AbleFlow - 화면을 넣은 방식(구분 칸). EXTENSION 은 확장 프로그램(P1, 만드는 API 없음)

    • urlstringoptional

      URL 화면: 전체 주소(경로로 넣었으면 프로젝트 baseUrl + 경로)

    • pathstringoptional

      경로로 넣은 화면이면 경로(기본 주소를 바꾸면 url 이 따라 바뀐다)

    • AbleflowScreenViewportrequired
    • FileInfoResponse[]optional

      IMAGE 화면: 올린 이미지(priority 순, 첫 장이 썸네일). 공용 응답 주입기가 채운다

    • AbleflowLabelRef[]required

      공통 먼저, 이름순

    • requiresAuthbooleanrequired
    • prioritynumberrequired

      리포트 · 목록 순서(작을수록 앞)

    • latestResultunknownoptional

      진단(회차) 기능 전이라 늘 없음

    • createdAtstringrequired
    • updatedAtstringrequired

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(초)