경로의 미디어 항목 삭제(Clear Media Item At Path) (V2)

지정한 경로의 항목을 소프트 삭제합니다. 그 항목과 같은 경로에 있던 모든 이전 항목을 다시 조회할 수 없게 됩니다.

branchName, branchRid, viewRid 중 하나만 지정합니다. 모두 생략하면 기본 브랜치가 대상이며 둘 이상을 지정하면 오류가 발생합니다. 트랜잭션을 사용하는 집합에서는 transactionId가 필수이고 커밋 전에는 삭제가 보이지 않습니다.

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

HTTP 요청

DELETE /api/v2/mediasets/{mediaSetRid}/items/clearAtPath

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

경로 매개변수

쿼리 매개변수

요청 본문

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

응답

성공 응답에 반환할 본문 모델이 없습니다.

개별 오류

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

요청 예제

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

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

가상 경로 q3-data/my-file.png를 한 번 URL 인코딩한 예제입니다. 트랜잭션을 사용하지 않는 집합의 기본 브랜치를 대상으로 하며, 실행 전에 실제 삭제할 경로로 바꿉니다. 트랜잭션 집합에서는 생성한 ID를 transactionId 쿼리 매개변수에 추가합니다.

cURL

curl -X DELETE \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/mediasets/${MEDIA_SET_RID}/items/clearAtPath?mediaItemPath=q3-data%2Fmy-file.png&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.delete('https://{}/api/v2/mediasets/{mediaSetRid}/items/clearAtPath?mediaItemPath=q3-data%2Fmy-file.png&preview=true'.format(HOSTNAME, mediaSetRid=os.environ["MEDIA_SET_RID"]), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API를 사용하는 ClearMediaItemAtPathExample.java 예제입니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class ClearMediaItemAtPathExample {
    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()) {
            HttpDelete request = new HttpDelete("https://" + HOSTNAME + "/api/v2/mediasets/" + System.getenv("MEDIA_SET_RID") + "/items/clearAtPath?mediaItemPath=q3-data%2Fmy-file.png&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/clearAtPath?mediaItemPath=q3-data%2Fmy-file.png&preview=true`, {
    method: 'DELETE',
    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/clearAtPath?mediaItemPath=q3-data%2Fmy-file.png&preview=true" `
	-Method Delete `
	-Headers $headers

$response.content