파일시스템 리소스 조회(Get Resource) (V2)

리소스 RID로 공통 메타데이터를 조회합니다. 표시 이름과 설명, 전체 경로, 소속 프로젝트와 공간, 수정 시각 및 휴지통 상태를 확인할 수 있습니다.

루트 폴더와 공간을 Resource로 조회하는 기능은 지원하지 않습니다. 데이터셋의 실제 행이나 파일 내용이 필요한 경우에는 해당 데이터 접근 API를 사용합니다.

HTTP 요청

GET /api/v2/filesystem/resources/{resourceRid}

작업 식별자는 v2.getResource입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:filesystem-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

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

응답

응답 형식은 Resource입니다.

전체 필드, 수정 시각의 적용 범위, 휴지통 상태와 85가지 리소스 유형은 리소스 메타데이터를 따릅니다.

가상 항공사 데이터셋 리소스의 응답 예시입니다.

{
  "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.4cae7c13-b59f-48f6-9ef2-dbde603e4e33",
  "path": "/Empyrean Airlines/My Important Project/My Dataset",
  "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
  "createdTime": "2024-09-25T17:29:35.974Z"
}

개별 오류

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"

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/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetResourceExample.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 GetResourceExample {
    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/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da");
            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/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`, {
    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/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" `
	-Headers $headers

$response.content