Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

Foundry 파일시스템 리소스 API (V2)

Resource는 데이터셋, Workshop 모듈과 Slate 애플리케이션, 폴더 및 프로젝트 같은 Foundry 파일시스템 리소스입니다. 이 API는 리소스의 공통 메타데이터, 휴지통 상태와 접근 요구조건을 다룹니다.

RID와 경로로 조회

입력단건 조회배치 조회
리소스 RIDGet ResourceGet Resources Batch, 최대 1,000개, RID 맵 반환
절대 경로Get By PathGet By Path Resources Batch, 최대 1,000개, 목록 반환

루트 폴더와 공간은 Resource 조회 대상이 아닙니다. 배치 요청에서는 일부 대상이 응답에서 빠질 수 있으므로 입력 배열의 위치만으로 결과를 대응시키지 않습니다. RID 배치와 경로 배치의 제외 조건은 각 엔드포인트의 계약을 따릅니다.

경로에는 리소스 이름까지 포함합니다. 맨 앞의 /는 생략할 수 있지만 구성 요소 사이에는 단일 /를 사용합니다. 일반 폴더의 수정 시각에는 하위 변경이 반영되는 반면 프로젝트와 공간은 자식의 변경만으로 수정 시각을 갱신하지 않습니다.

휴지통과 영구 삭제

Delete Resource는 리소스를 휴지통으로 옮깁니다. 공간, 자동 저장 리소스와 숨김 리소스는 이 작업을 지원하지 않습니다.

Restore Resource는 대상과 직접 휴지통에 옮겨진 조상을 복원합니다. 휴지통 상태가 아닌 대상에 대한 작업은 무시됩니다. trashStatus의 DIRECTLY_TRASHED, ANCESTOR_TRASHED, NOT_TRASHED를 구분하고, 직접 삭제되지 않았다는 오류가 발생하면 실제로 휴지통에 옮긴 대상을 확인합니다.

Permanently Delete Resource는 직접 휴지통에 옮겨진 리소스를 영구 삭제합니다. 복원이 필요한 리소스를 삭제하지 않도록 대상 RID와 상태를 확인합니다.

보안 표지와 조직 요구조건

Add Markings와 Remove Markings는 리소스의 일반 보안 표지를 변경합니다. 조직 표지는 이 경로로 관리하지 않고 프로젝트의 조직 관리 작업을 사용합니다. 숨김 리소스와 자동 저장 리소스도 일반 표지 변경을 지원하지 않습니다.

직접 적용한 표지 목록은 상속된 요구조건 전체와 다릅니다. Get Access Requirements는 조직과 보안 표지의 직접 적용 및 상속 상태를 isDirectlyApplied와 함께 제공합니다.

  • 조직 요구조건은 OR입니다. 적용된 조직 중 하나의 구성원 또는 게스트 구성원이어야 합니다.
  • 보안 표지 요구조건은 AND입니다. 적용된 모든 표지의 구성원 조건을 충족해야 합니다.

조직 요구조건은 파일 계층과 직접 의존성을 통해 상속될 수 있습니다. 이 자격 조건과 리소스 역할이 부여하는 실제 권한은 구분합니다. 접근 요구조건 조회가 역할이나 구성원 자격을 새로 부여하지는 않습니다.

작업별 HTTP 절에 명시한 OAuth 권한 범위와 리소스 접근 권한을 확인합니다. POST 배치 조회는 읽기 작업인 반면, 휴지통 이동과 복원, 영구 삭제 및 표지 변경은 리소스 상태에 영향을 줍니다.