미디어 항목 상세 메타데이터(Get Media Item Metadata) (V2)

항목 유형별 상세 정보를 조회합니다. 이미지 치수와 밴드, 문서 페이지, 오디오 및 비디오 길이, DICOM과 이메일 정보를 각 유형의 필드로 반환합니다.

상세 응답의 기존 sizeBytes는 2GiB 이상에서 2,147,483,647로 포화됩니다. 기본 정보 조회에서 이 필드를 생략하는 동작과 구분하며 sizeBytesLong을 사용합니다.

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

HTTP 요청

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

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

경로 매개변수

쿼리 매개변수

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

요청 본문

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

응답

응답 형식은 MediaItemMetadata입니다.

10가지 유형의 모든 필드, 형식 enum과 크기 및 좌표 조건은 유형별 메타데이터를 따릅니다.

가상 PNG 이미지 메타데이터의 응답 예시입니다.

{
  "type": "imagery",
  "format": "PNG",
  "dimensions": {
    "width": 1920,
    "height": 1080
  },
  "sizeBytes": 2048576,
  "sizeBytesLong": "2048576"
}

개별 오류

오류 응답 처리는 공통 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}/metadata"

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}/metadata'.format(HOSTNAME, mediaSetRid=os.environ["MEDIA_SET_RID"], mediaItemRid=os.environ["MEDIA_ITEM_RID"]), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API를 사용하는 GetMediaItemMetadataExample.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 GetMediaItemMetadataExample {
    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") + "/metadata");
            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}/metadata`, {
    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}/metadata" `
	-Headers $headers

$response.content