Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

미디어 항목 참조 조회(Get Media Item Reference) (V2)

항목의 MIME 유형과 미디어 집합, 뷰 및 항목 식별자를 담는 MediaReference를 조회합니다. 중첩된 mediaSetViewItem 객체 구조를 유지합니다. 선택적인 token은 특정 항목의 읽기 접근을 부여하므로 자격 증명으로 취급합니다.

특정 항목의 읽기 토큰을 전달할 때는 선택 헤더 ReadToken을 사용합니다. 이 토큰을 일반 로그나 공유 문서에 노출하지 않습니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

GET /api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
mediaSetRidstring필수미디어 집합의 RID입니다.
mediaItemRidstring필수미디어 항목의 RID입니다.

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
previewboolean선택true이면 미리보기 단계의 베타 기능을 사용합니다.true

요청 본문

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

응답

응답 형식은 MediaReference입니다.

이름자료형필수 여부의미와 조건예시 값
mimeTypestring필수파일 또는 첨부의 MIME 유형입니다. 예: application/json, application/pdf, application/octet-stream, image/jpeg.application/pdf
referenceunion<mediaSetViewItem>필수미디어 참조의 종류를 구분합니다.

reference의 구조

분기 mediaSetViewItem
이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: mediaSetViewItem.mediaSetViewItem
mediaSetViewItemobject필수
mediaSetViewItem의 구조
이름자료형필수 여부의미와 조건예시 값
mediaSetRidstring필수Foundry 미디어 집합의 RID입니다.
mediaSetViewRidstring필수미디어 집합 뷰의 RID입니다. 뷰는 독립적인 미디어 항목 모음입니다.
mediaItemRidstring필수미디어 집합 안의 개별 항목 RID입니다.
tokenstring선택특정 미디어 항목의 읽기 접근을 부여하는 토큰입니다.

개별 오류

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

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 제공합니다.

환경 변수 MEDIA_SET_RID와 MEDIA_ITEM_RID에 참조를 조회할 미디어 집합과 항목의 RID를 제공합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/mediasets/${MEDIA_SET_RID}/items/${MEDIA_ITEM_RID}/reference?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}/items/{mediaItemRid}/reference?preview=true'.format(HOSTNAME, mediaSetRid=os.environ["MEDIA_SET_RID"], mediaItemRid=os.environ["MEDIA_ITEM_RID"]), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API를 사용하는 GetMediaItemReferenceExample.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 GetMediaItemReferenceExample {
    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") + "/items/" + System.getenv("MEDIA_ITEM_RID") + "/reference?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}/items/${process.env.MEDIA_ITEM_RID}/reference?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}/items/${env:MEDIA_ITEM_RID}/reference?preview=true" `
	-Headers $headers

$response.content