미디어 항목 기본 정보(Get Media Item Info) (V2)
항목의 뷰, 경로, 논리 시각, 생성 정보와 MIME 유형 및 바이트 크기를 조회합니다. logicalTimestamp는 마이크로초로 해석할 수 있는 논리적 순서값이며 시스템 시각과 조금 다를 수 있습니다. 생성 시각과 같은 값이라고 단정하지 않습니다.
기존 sizeBytes는 2GiB 이상이면 생략됩니다. 크기 처리는 필수 sizeBytesLong을 기준으로 합니다.
특정 항목의 읽기 토큰을 전달할 때는 선택 헤더 ReadToken을 사용합니다. 이 토큰을 일반 로그나 공유 문서에 노출하지 않습니다.
HTTP 요청
GET /api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}
작업 식별자는 v2.getMediaItemInfo입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:mediasets-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
mediaSetRid | string | 필수 | 미디어 집합의 RID입니다. | |
mediaItemRid | string | 필수 | 미디어 항목의 RID입니다. |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 GetMediaItemInfoResponse입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
viewRid | string | 필수 | 미디어 집합 뷰의 RID입니다. 뷰는 독립적인 미디어 항목 모음입니다. | |
path | string | 선택 | 미디어 집합 안의 항목을 식별하는 사용자 지정 경로입니다. 길이는 256자 미만이어야 합니다. 같은 경로에 여러 항목을 쓰면 경로 조회는 마지막으로 쓴 항목을 반환합니다. | |
logicalTimestamp | long | 필수 | 트랜잭션 등에서 논리적 순서를 나타내는 수입니다. 마이크로초 타임스탬프로 해석할 수 있지만 시계 편차와 순서 보정을 위해 시스템 시각과 조금 다를 수 있습니다. epoch 이후를 나타내는 양수만 지원합니다. | |
attribution | object | 선택 | ||
originallyUploadedFileMimeType | string | 선택 | 파일 또는 첨부의 MIME 유형입니다. 예: application/json, application/pdf, application/octet-stream, image/jpeg. | application/pdf |
mimeType | string | 선택 | 파일 또는 첨부의 MIME 유형입니다. 예: application/json, application/pdf, application/octet-stream, image/jpeg. | application/pdf |
sizeBytes | integer | 선택 | 사용을 권장하지 않는 기존 필드이며 sizeBytesLong을 사용합니다. 항목이 2GiB 이상이면 이 필드는 생략합니다. | |
sizeBytesLong | long | 필수 | 미디어 항목의 바이트 크기입니다. | 72526847 |
attribution의 구조
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
creatorId | string | 필수 | Foundry 사용자 ID입니다. | dd05feb8-662a-445d-8f4c-ce92d46bedeb |
creationTimestamp | string (date-time) | 필수 | 미디어 항목 생성 시각이며 ISO 8601 타임스탬프 형식입니다. |
가상 PNG 미디어 항목의 응답 예시입니다.
{
"viewRid": "ri.mio.main.view.1",
"logicalTimestamp": "1594393200000000",
"path": "example.png",
"attribution": {
"creatorId": "dd05feb8-662a-445d-8f4c-ce92d46bedeb",
"creationTimestamp": "2020-07-10T15:00:00.000Z"
},
"originallyUploadedFileMimeType": "image/png",
"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}"
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}'.format(HOSTNAME, mediaSetRid=os.environ["MEDIA_SET_RID"], mediaItemRid=os.environ["MEDIA_ITEM_RID"]), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API를 사용하는 GetMediaItemInfoExample.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 GetMediaItemInfoExample {
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") + "");
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}`, {
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}" `
-Headers $headers
$response.content