여러 절대 경로로 리소스 조회(Get By Path Resources Batch) (V2)

한 번에 최대 1,000개 절대 경로를 조회하고 리소스 목록을 반환합니다. 존재하지 않거나 접근할 수 없는 경로, 루트 폴더나 공간을 가리키는 경로는 응답에서 제외됩니다.

응답은 RID 배치 조회의 맵과 달리 배열입니다. 일부 항목이 빠질 수 있으므로 요청 순서의 인덱스만으로 결과를 대응시키지 않고 반환된 RID와 경로를 확인합니다.

HTTP 요청

POST /api/v2/filesystem/resources/getByPathBatch

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

경로 매개변수

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

쿼리 매개변수

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

요청 본문

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

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

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

[
  {
    "path": "/My Organization-abcd/My Important Project/My Dataset"
  }
]

응답

응답 형식은 GetByPathResourcesBatchResponse입니다.

data는 list<Resource>입니다.

data의 구조

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

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

가상 절대 경로 배치 조회의 응답 예시입니다.

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

개별 오류

오류 응답 처리는 공통 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/getByPathBatch" \
	-d '[{"path":"/My Organization-abcd/My Important Project/My Dataset"}]'

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 = [
    {
        "path": "/My Organization-abcd/My Important Project/My Dataset"
    }
]

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetByPathResourcesBatchExample.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 GetByPathResourcesBatchExample {
    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/getByPathBatch");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("[{\"path\":\"/My Organization-abcd/My Important Project/My Dataset\"}]", 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/getByPathBatch`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '[{"path":"/My Organization-abcd/My Important Project/My Dataset"}]'
}).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/getByPathBatch" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "[{`"path`":`"/My Organization-abcd/My Important Project/My Dataset`"}]"

$response.content