Notepad 파일 다운로드(Content File) (V2)

Notepad의 파일 콘텐츠를 바이너리로 내려받습니다. 내보내기 작업이 성공하면 반환한 fileRid를 사용합니다.

파일은 생성 후 7일 이내에 사용해야 하는 임시 리소스입니다. 그 이후 찾을 수 없다면 자동 삭제되었을 수 있습니다. 파일의 내용을 텍스트로 변환하지 않고 저장합니다.

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

HTTP 요청

GET /api/v2/notepad/files/{fileRid}/content

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

경로 매개변수

쿼리 매개변수

요청 본문

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

응답

응답 본문은 파일 콘텐츠의 바이너리입니다. PDF 내보내기 결과인 경우 PDF 파일로 저장하여 사용할 수 있습니다.

개별 오류

요청 예제

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

예시 파일 RID를 실제 내보내기 성공 결과의 fileRid로 바꿉니다.

NOTEPAD_OUTPUT_FILE은 저장할 로컬 파일 경로입니다. 기존 파일을 덮어쓰며 본문을 텍스트로 변환하지 않고 바이트로 기록합니다.

cURL

curl --fail --output "${NOTEPAD_OUTPUT_FILE}" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/notepad/files/ri.notepad.main.file.cf32c039-353c-4555-9704-eacfdfaa2c1c/content?preview=true"

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

with requests.get('https://{}/api/v2/notepad/files/ri.notepad.main.file.cf32c039-353c-4555-9704-eacfdfaa2c1c/content?preview=true'.format(HOSTNAME), headers=headers, stream=True) as response:
    response.raise_for_status()
    with open(os.environ["NOTEPAD_OUTPUT_FILE"], "wb") as output:
        for chunk in response.iter_content(chunk_size=1024 * 1024):
            output.write(chunk)

Java

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

import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
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 ContentFileExample {
    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/notepad/files/ri.notepad.main.file.cf32c039-353c-4555-9704-eacfdfaa2c1c/content?preview=true");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                int status = response.getStatusLine().getStatusCode();
                if (status < 200 || status >= 300) throw new IOException("HTTP " + status);
                try (OutputStream output = Files.newOutputStream(Paths.get(System.getenv("NOTEPAD_OUTPUT_FILE")))) {
                    response.getEntity().writeTo(output);
                }
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. import가 있는 예제는 ES 모듈(.mjs)로 실행합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

import { createWriteStream } from "node:fs";
import { Readable } from "node:stream";
import { pipeline } from "node:stream/promises";

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

const response = await fetch(`https://${HOSTNAME}/api/v2/notepad/files/ri.notepad.main.file.cf32c039-353c-4555-9704-eacfdfaa2c1c/content?preview=true`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
 });
if (!response.ok) {
    await response.body?.cancel();
    throw new Error(`HTTP ${response.status}`);
}
await pipeline(Readable.fromWeb(response.body), createWriteStream(process.env.NOTEPAD_OUTPUT_FILE));

PowerShell

스크립트 오류가 발생하면 중단하도록 ErrorActionPreference를 설정합니다.

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/notepad/files/ri.notepad.main.file.cf32c039-353c-4555-9704-eacfdfaa2c1c/content?preview=true" `
	-Headers $headers `
    -OutFile $env:NOTEPAD_OUTPUT_FILE