여러 리소스를 RID로 조회(Get Resources Batch) (V2)

한 번에 최대 1,000개 리소스 RID를 조회합니다. 응답은 RID를 키로 하고 Resource를 값으로 하는 맵입니다. 존재하지 않는 리소스나 루트 폴더 또는 공간의 RID는 맵에 포함하지 않습니다.

POST를 사용하지만 리소스를 읽는 작업입니다. 요청 배열의 위치로 결과를 대응시키지 말고 RID를 키로 사용합니다.

HTTP 요청

POST /api/v2/filesystem/resources/getBatch

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

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

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

요청 본문

본문 형식은 list<GetResourcesBatchRequestElement>이며 필수입니다.

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

다음 본문의 식별자와 값은 가상 예시입니다.

[
  {
    "resourceRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
  }
]

응답

응답 형식은 GetResourcesBatchResponse입니다.

응답의 data는 map<ResourceRid, Resource>입니다.

data의 구조

맵의 키는 ResourceRid(string), 값은 Resource(object)입니다.

키: 리소스의 고유 식별자(RID)입니다.

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

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

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

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/resources/getBatch" \
	-d '[{"resourceRid":"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 = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = [
    {
        "resourceRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
    }
]

response = requests.post('https://{}/api/v2/filesystem/resources/getBatch'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class GetResourcesBatchExample {
    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()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/filesystem/resources/getBatch");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("[{\"resourceRid\":\"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da\"}]", ContentType.APPLICATION_JSON));
            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/getBatch`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '[{"resourceRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"}]'
}).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/getBatch" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "[{`"resourceRid`":`"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`"}]"

$response.content