폴더의 자식 리소스 조회(List Children Of Folder) (V2)

지정한 폴더의 자식 리소스를 페이지로 조회합니다. 한 페이지의 상한은 2,000개이며 pageSize를 생략해도 기본값 2,000을 사용합니다.

첫 요청에는 pageToken을 넣지 않습니다. 응답에 nextPageToken이 있으면 다음 요청의 쿼리 매개변수로 전달합니다. 페이지 크기를 전체 자식 수의 상한으로 해석하지 않습니다.

HTTP 요청

GET /api/v2/filesystem/folders/{folderRid}/children

작업 식별자는 v2.listChildrenOfFolder입니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListChildrenOfFolderResponse입니다.

data는 list<Resource>입니다. 폴더 메타데이터의 Folder 배열과 구분하며, 데이터셋 같은 다른 리소스도 포함할 수 있습니다.

data의 구조

배열 항목은 Resource이며 자료형은 object입니다.

자식 항목의 전체 필드와 85가지 유형은 Resource 메타데이터를 따릅니다.

작업 폴더의 자식 리소스를 조회했을 때 받는 응답의 가상 예시입니다.

{
  "data": [
    {
      "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 Dataset",
      "description": "This dataset contains important data about Empyrean Airlines",
      "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
      "type": "FOUNDRY_DATASET",
      "spaceRid": "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca",
      "trashStatus": "NOT_TRASHED",
      "parentFolderRid": "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8",
      "path": "/Empyrean Airlines/My Important Project/My Folder/My Dataset",
      "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
      "createdTime": "2024-09-25T17:29:35.974Z"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/folders/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/children"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/filesystem/folders/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/children'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListChildrenOfFolderExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class ListChildrenOfFolderExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/filesystem/folders/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/children");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/filesystem/folders/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/children`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/filesystem/folders/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/children" `
	-Headers $headers

$response.content