미디어 집합 설정 조회(Get Media Set) (V2)
미디어 집합의 스키마 종류, 기본 브랜치, 트랜잭션 정책과 경로 필수 여부를 조회합니다. 쓰기 전에 transactionPolicy와 pathsRequired를 확인하여 요청을 준비합니다.
이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.
HTTP 요청
GET /api/v2/mediasets/{mediaSetRid}
작업 식별자는 v2.getMediaSet입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:mediasets-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
mediaSetRid | string | 필수 | Foundry 미디어 집합의 RID입니다. |
쿼리 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
preview | boolean | 선택 | true이면 미리보기 단계의 베타 기능을 사용합니다. | true |
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 GetMediaSetResponse입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
rid | string | 필수 | Foundry 미디어 집합의 RID입니다. | |
mediaSchema | enum | 필수 | 포함할 수 있는 항목 유형을 나타내는 미디어 집합 스키마입니다. 허용값: AUDIO, CAD, DICOM, DOCUMENT, IMAGERY, MODEL_3D, MULTIMODAL, SPREADSHEET, STREAMING_VIDEO, TILED_RASTER, VIDEO, EMAIL. | |
defaultBranchName | string | 필수 | 미디어 집합의 브랜치 이름입니다. 비어 있지 않아야 하며 길이는 256자 미만이고 유효한 ResourceIdentifier 형식이어서는 안 됩니다. | |
transactionPolicy | union<batchTransactions, noTransactions> | 필수 | 미디어 집합의 쓰기 처리 방식을 정하는 트랜잭션 정책입니다. | |
pathsRequired | boolean | 필수 | 이 미디어 집합의 항목에 경로가 필요한지 나타냅니다. |
transactionPolicy의 구조
분기 batchTransactions
모든 쓰기가 트랜잭션에 포함되어야 합니다. 트랜잭션은 브랜치 범위이며 생성 API로 엽니다. 커밋 전에는 쓰기가 보이지 않습니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: batchTransactions. | batchTransactions |
분기 noTransactions
쓰기를 트랜잭션에 포함하지 않으며 즉시 보입니다. 트랜잭션 생성이나 커밋 API를 호출하면 오류가 발생합니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: noTransactions. | noTransactions |
개별 오류
오류 응답 처리는 공통 API 오류 계약을 따릅니다.
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 제공합니다.
환경 변수 MEDIA_SET_RID에 조회할 미디어 집합의 RID를 제공합니다.
cURL
curl \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/mediasets/${MEDIA_SET_RID}?preview=true"
Python
Requests 라이브러리가 설치된 환경에서 사용합니다.
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/mediasets/{mediaSetRid}?preview=true'.format(HOSTNAME, mediaSetRid=os.environ["MEDIA_SET_RID"]), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API를 사용하는 GetMediaSetExample.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 GetMediaSetExample {
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/mediasets/" + System.getenv("MEDIA_SET_RID") + "?preview=true");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
try (CloseableHttpResponse response = httpClient.execute(request)) {
System.out.println(response);
}
}
}
}
JavaScript
fetch를 제공하는 Node.js 환경에서 사용합니다. import가 있는 예제는 ES 모듈(.mjs)로 실행합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.
const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;
fetch(`https://${HOSTNAME}/api/v2/mediasets/${process.env.MEDIA_SET_RID}?preview=true`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${TOKEN}`,
}
}).then((response) => {
console.log(response)
});
PowerShell
스크립트 오류가 발생하면 중단하도록 ErrorActionPreference를 설정합니다.
$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST
$headers = @{
"authorization" = "Bearer $TOKEN"
}
$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/mediasets/${env:MEDIA_SET_RID}?preview=true" `
-Headers $headers
$response.content