폴더 구성과 하위 리소스 API (V2)
일반 폴더는 프로젝트 안의 리소스를 구조적으로 정리하는 데 사용합니다. Create Folder로 만들고, Get Folder 또는 Get Folders Batch로 메타데이터를 조회합니다. 폴더의 자식 리소스는 List Children Of Folder로 가져옵니다.
Folder 자료형
Folder.type은 FOLDER, PROJECT, SPACE를 구분합니다. Resource 메타데이터의 RID 기반 type enum과 다른 필드 계약입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
rid | string | 필수 | 폴더의 고유 리소스 식별자(RID)입니다. | ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8 |
displayName | string | 필수 | 리소스의 표시 이름입니다. | My Folder |
description | string | 선택 | 폴더에 연결된 설명입니다. | |
documentation | string | 선택 | 폴더에 연결된 문서 내용입니다. | |
path | string | 필수 | 리소스 이름 자체를 포함한 전체 경로입니다. | /Empyrean Airlines/My Important Project/My Folder |
type | enum | 필수 | 일반 폴더, 프로젝트 또는 공간을 구분합니다. 허용값: FOLDER, SPACE, PROJECT. | FOLDER |
createdBy | string | 필수 | 리소스를 생성한 Foundry 사용자입니다. | f05f8da4-b84c-4fca-9c77-8af0b13d11de |
updatedBy | string | 필수 | 리소스를 마지막으로 갱신한 Foundry 사용자입니다. | f05f8da4-b84c-4fca-9c77-8af0b13d11de |
createdTime | string (date-time) | 필수 | 리소스 생성 시각입니다. | 2024-09-25T17:29:35.974Z |
updatedTime | string (date-time) | 필수 | 리소스를 가장 최근에 갱신한 시각입니다. | 2024-09-25T17:29:35.974Z |
trashStatus | enum | 필수 | 폴더 자체가 휴지통에 있거나 조상이 휴지통에 있어서 영향을 받는 상태를 구분합니다. 허용값: DIRECTLY_TRASHED, ANCESTOR_TRASHED, NOT_TRASHED. | NOT_TRASHED |
parentFolderRid | string | 필수 | 상위 폴더의 RID입니다. 프로젝트의 상위는 공간이며, 공간의 상위는 루트 폴더 ri.compass.main.folder.0입니다. | ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33 |
projectRid | string | 선택 | 폴더가 속한 프로젝트의 RID입니다. 폴더가 공간이면 이 값은 없습니다. | ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33 |
spaceRid | string | 필수 | 폴더가 속한 공간의 RID입니다. 폴더 자체가 공간이면 자신의 RID와 같습니다. | ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca |
프로젝트와 공간의 소속 표현
parentFolderRid는 프로젝트에서 상위 공간을, 공간에서 루트 폴더 ri.compass.main.folder.0을 가리킵니다. 공간에는 projectRid가 없고 spaceRid가 자신의 RID와 같습니다.
이 자료형이 세 종류를 표현한다는 사실과 각 조회 작업이 허용하는 대상은 구분합니다. 루트 폴더 조회 제한 등은 개별 API의 오류 계약을 따릅니다. 일반 폴더 생성에는 프로젝트 안의 상위 폴더를 선택합니다.
이름과 페이지 크기
새 폴더의 표시 이름은 필수이며 700자 이하여야 합니다. 이름 자체가 . 또는 ..일 수 없고 /를 포함할 수 없습니다. 같은 상위 폴더에 이름이 겹치는 리소스가 있으면 HTTP 409가 발생합니다.
폴더 배치 조회는 최대 1,000개 RID를 받습니다. 자식 조회는 한 페이지의 기본 크기와 상한이 모두 2,000이며 다음 토큰이 있으면 이어서 조회합니다. 폴더 전체의 자식 수가 2,000개로 제한된다는 뜻은 아닙니다.
폴더 예시
가상 프로젝트의 작업 폴더입니다.
{
"projectRid": "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33",
"updatedTime": "2024-09-25T17:29:35.974Z",
"updatedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"displayName": "My Folder",
"description": "Empyrean Airlines project working folder",
"rid": "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8",
"type": "FOLDER",
"spaceRid": "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca",
"trashStatus": "NOT_TRASHED",
"parentFolderRid": "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33",
"path": "/Empyrean Airlines/My Important Project/My Folder",
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"createdTime": "2024-09-25T17:29:35.974Z"
}