Notepad 내보내기 작업 생성(Create Export Job) (V2)

기존 문서 또는 성공한 템플릿 생성 결과에서 ExportJob을 만듭니다. 현재 이 API의 대상 형식은 pdf이며 userLocale과 userTimezone이 모두 필수입니다.

사용자는 내보낼 원천에 대한 내보내기 권한을 가져야 합니다. 만든 작업은 그 사용자만 접근할 수 있으며 생성 후 7일 이내에 사용합니다. 성공하면 파일 RID를 제공하므로 상태 조회 후 파일을 다운로드합니다.

생성 작업을 원천으로 사용할 때는 상태가 succeeded여야 하며 생성 작업 자체의 1시간 사용 기한도 지킵니다. running과 failed 상태 오류는 HTTP 500과 FAILED_PRECONDITION으로 반환됩니다.

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

HTTP 요청

POST /api/v2/notepad/exportJobs/create

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

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

요청 본문

필수 CreateExportJobRequest의 원천과 PDF 대상 설정을 모두 지정합니다.

exportJobSource의 구조

분기 generationJobSource

분기 documentSource

exportJobTarget의 구조

분기 pdf

응답

응답 형식은 ExportJob입니다.

status의 구조

분기 running

내보내기 작업이 실행 중입니다.

분기 failed

내보내기 작업이 실패했습니다.

분기 succeeded

내보내기 작업이 성공했습니다.

새로 만든 내보내기 작업의 응답 예시입니다.

{
  "rid": "ri.notepad.main.export-job.ef32c039-353c-4555-9704-eacfdfaa2c1c",
  "status": {
    "type": "running"
  }
}

개별 오류

요청 예제

내보내기 요청 파일 준비

기존 문서를 내보낼 때는 실제 문서 RID를 NOTEPAD_DOCUMENT_RID, 사용할 사용자 로캘을 NOTEPAD_LOCALE, IANA 시간대를 NOTEPAD_TIMEZONE에 제공합니다. 시간대는 America/New_York 또는 Asia/Seoul처럼 Area/Location 형태를 사용합니다. 로캘은 내보내기에 사용할 실제 사용자 설정값으로 지정하며 잘못된 값은 InvalidExportJobUserLocale로 거부됩니다.

NOTEPAD_EXPORT_REQUEST_FILE에는 생성할 UTF-8 JSON 파일 경로를 정합니다. 다음 Python 준비 코드는 로컬 파일을 쓰며 API를 호출하지 않습니다. 기존 파일이 있으면 덮어씁니다.

import json
import os
from pathlib import Path

request_body = {
    "exportJobSource": {
        "type": "documentSource",
        "documentRid": os.environ["NOTEPAD_DOCUMENT_RID"],
    },
    "exportJobTarget": {
        "type": "pdf",
        "userLocale": os.environ["NOTEPAD_LOCALE"],
        "userTimezone": os.environ["NOTEPAD_TIMEZONE"],
    },
}
Path(os.environ["NOTEPAD_EXPORT_REQUEST_FILE"]).write_text(
    json.dumps(request_body, ensure_ascii=False), encoding="utf-8"
)

성공한 생성 작업을 바로 내보내려면 exportJobSource를 type: "generationJobSource"와 필수 templateRid, generationJobRid를 갖는 객체로 바꿉니다. 이 경우에도 PDF 대상의 로캘과 시간대는 필수입니다.

FOUNDRY_HOST에는 https://를 제외한 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 제공합니다. 예시 식별자는 실제 작업 대상과 생성 응답에서 받은 값으로 바꿉니다.

다음 예제는 준비한 NOTEPAD_EXPORT_REQUEST_FILE의 UTF-8 JSON을 전송합니다. 실제 원천과 형식 설정을 확인한 뒤 호출합니다.

cURL

curl --fail -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/notepad/exportJobs/create?preview=true" \
	--data-binary "@${NOTEPAD_EXPORT_REQUEST_FILE}"

Python

Requests 라이브러리가 필요합니다.

import json
import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
with open(os.environ["NOTEPAD_EXPORT_REQUEST_FILE"], encoding="utf-8") as request_file:
    request_body = json.load(request_file)

response = requests.post('https://{}/api/v2/notepad/exportJobs/create?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
response.raise_for_status()
print(response.json())

Java

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

import java.io.IOException;
import org.apache.http.util.EntityUtils;
import java.io.File;
import org.apache.http.entity.FileEntity;
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;

public class CreateExportJobExample {
    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/notepad/exportJobs/create?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new FileEntity(new File(System.getenv("NOTEPAD_EXPORT_REQUEST_FILE")), ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                int status = response.getStatusLine().getStatusCode();
                if (status < 200 || status >= 300) throw new IOException("HTTP " + status);
                System.out.println(EntityUtils.toString(response.getEntity(), "UTF-8"));
            }
        }
    }
}

JavaScript

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

import { readFile } from "node:fs/promises";

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

fetch(`https://${HOSTNAME}/api/v2/notepad/exportJobs/create?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: await readFile(process.env.NOTEPAD_EXPORT_REQUEST_FILE)
}).then(async (response) => {
    if (!response.ok) {
        await response.body?.cancel();
        throw new Error(`HTTP ${response.status}`);
    }
    console.log(await response.json())
});

PowerShell

오류가 발생하면 스크립트를 중단합니다.

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

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/notepad/exportJobs/create?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-InFile $env:NOTEPAD_EXPORT_REQUEST_FILE

$response.content