화면
화면 상세
GET/api/screens/{screenId}
- Scope
screens:read - Since
1.0.0 - Success
200 - Demo tokenAllowed
id screens.get
Path parameters
GetScreenRequestPath
screenIdstringrequired
Response 200
GetScreenResponse
idstringrequirednamestringrequiredsourceAbleflowScreenSourcerequiredURLIMAGEEXTENSION
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
AbleFlow - 화면을 넣은 방식(구분 칸). EXTENSION 은 확장 프로그램(P1, 만드는 API 없음)
urlstringoptionalURL 화면: 전체 주소(경로로 넣었으면 프로젝트 baseUrl + 경로)
pathstringoptional경로로 넣은 화면이면 경로(기본 주소를 바꾸면 url 이 따라 바뀐다)
- AbleflowScreenViewportrequired
Variant 1AbleflowViewportPCMOBILE
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
AbleFlow - 분석 뷰포트(진단 기본값). 화면은 BOTH 까지
Variant 2enumBOTH
- FileInfoResponse[]optional
IMAGE 화면: 올린 이미지(priority 순, 첫 장이 썸네일). 공용 응답 주입기가 채운다
objectKeystringrequired파일 object key
fileNamestringrequired파일명
getUrlstringrequired파일 다운로드 URL
altstringoptional대체 텍스트(요청 언어로 저장된 것이 있을 때만)
createdAtstringoptional올린 시각(응답에서는 대개 빠진다 — 파일 응답 변환이 비운다)
- AbleflowLabelRef[]required
공통 먼저, 이름순
idstringrequirednamestringrequiredcolorAbleflowLabelColorrequiredGRAYBLUETEALGREENAMBERREDPINKVIOLET
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
AbleFlow - 레이블 색(다른 enum 처럼 대문자)
scopeAbleflowLabelScoperequiredWORKSPACEPROJECT
Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').
AbleFlow - 레이블 범위: 공통(워크스페이스) · 프로젝트 전용
requiresAuthbooleanrequiredprioritynumberrequired리포트 · 목록 순서(작을수록 앞)
latestResultunknownoptional진단(회차) 기능 전이라 늘 없음
createdAtstringrequiredupdatedAtstringrequiredprojectIdstringrequired
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(초) |