AbleFlowDocs

프로젝트

프로젝트 페이지 조회(기본 정렬: 만든 시각 최신순)

GET/api/workspaces/{workspaceId}/projects

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

id projects.list

Path parameters

GetProjectPaginationRequestPath

  • workspaceIdstringrequired

Query

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

GetProjectPaginationRequestParams

limit 최대 10000(공통 PaginationRequest.MAX_LIMIT, 넘으면 400)

  • offsetnumberoptional

    시작 오프셋

  • limitnumberoptional

    조회 개수

  • sortstringoptional

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

  • keywordstringoptional

    이름 · 설명 · 기본 주소 검색어(대소문자 무시)

  • minebooleanoptional

    true 면 내가 만든 프로젝트만

Response 200

GetProjectPaginationResponse

  • countnumberrequired

    전체 개수

  • prevstringrequirednull

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

  • nextstringrequirednull

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

  • GetProjectPaginationResponseItem[]required

    조회 결과

    • idstringrequired
    • namestringrequired
    • descriptionstringrequirednull

      설명. 키는 늘 있고, 비워 두었으면 null

    • baseUrlstringrequirednull

      서비스 기본 주소. 키는 늘 있고, 없으면 null

    • createdBystringrequired

      만든 사람 memberId

    • createdAtstringrequired
    • updatedAtstringrequired
    • screenCountnumberrequired

      화면 수(파일 연결까지 끝난 화면)

    • objectoptional

      가장 최근 회차(없으면 빠진다). 진행 중이면 completedCount/analysisCount, 끝났으면 위험도 · 등급

    • object[]required

      가장 최근 끝난 회차의 대표 캡처(화면 순서, 최대 3장. 없으면 [])

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