페더레이션 미디어 항목 등록(Register Media Item) (V2)

페더레이션 미디어 저장소에 이미 있는 항목을 등록합니다. 등록할 때 집합의 스키마에 맞는지 검증하고 초기 메타데이터를 추출합니다. 페더레이션 미디어 집합에서만 사용할 수 있습니다.

physicalItemName은 저장소 안의 실제 상대 경로이며 mediaItemPath는 미디어 집합에서 항목을 식별할 논리적 경로입니다. 트랜잭션을 사용하는 집합에서는 transactionId를 제공합니다.

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

HTTP 요청

POST /api/v2/mediasets/{mediaSetRid}/items/register

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

경로 매개변수

쿼리 매개변수

요청 본문

본문 형식은 RegisterMediaItemRequest이며 필수입니다.

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

{
  "physicalItemName": "q3-data/my-file.png",
  "mediaItemPath": "q3-data/my-file.png"
}

응답

응답 형식은 RegisterMediaItemResponse입니다.

개별 오류

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

요청 예제

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

환경 변수 MEDIA_SET_RID에 실제 요청 대상의 식별자를 제공합니다.

가상 저장소 경로와 논리 경로를 모두 q3-data/my-file.png로 정한 예제입니다. 실제 저장소에 존재하는 항목과 사용할 논리 경로로 바꿉니다. 트랜잭션을 사용하지 않는 집합을 전제로 하며, 트랜잭션 집합에서는 transactionId를 추가합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/mediasets/${MEDIA_SET_RID}/items/register?preview=true" \
	-d '{"physicalItemName":"q3-data/my-file.png","mediaItemPath":"q3-data/my-file.png"}'

Python

Requests 라이브러리가 설치된 환경에서 사용합니다.

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 = {"physicalItemName": "q3-data/my-file.png", "mediaItemPath": "q3-data/my-file.png"}

response = requests.post('https://{}/api/v2/mediasets/{mediaSetRid}/items/register?preview=true'.format(HOSTNAME, mediaSetRid=os.environ["MEDIA_SET_RID"]), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API를 사용하는 RegisterMediaItemExample.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 RegisterMediaItemExample {
    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/mediasets/" + System.getenv("MEDIA_SET_RID") + "/items/register?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"physicalItemName\":\"q3-data/my-file.png\",\"mediaItemPath\":\"q3-data/my-file.png\"}", ContentType.APPLICATION_JSON));
            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/register?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: JSON.stringify({"physicalItemName": "q3-data/my-file.png", "mediaItemPath": "q3-data/my-file.png"})
}).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/register?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body '{"physicalItemName":"q3-data/my-file.png","mediaItemPath":"q3-data/my-file.png"}'

$response.content