생성 결과를 문서로 저장(Save Document Generation Job) (V2)

성공한 생성 작업의 콘텐츠를 새 Notepad 문서로 저장합니다. parentFolderRid는 필수이며 documentName을 생략하면 문서 이름을 생성합니다.

직접 이름을 지정하면 700자 이하여야 하고 정확히 . 또는 ..일 수 없으며 /를 포함할 수 없습니다. 같은 폴더의 기존 이름과 충돌하거나 대상이 유효한 폴더가 아니면 오류가 발생합니다.

running 또는 failed 상태에서는 저장할 수 없습니다. 해당 상태 오류는 HTTP 500과 FAILED_PRECONDITION을 사용하므로 작업 상태를 먼저 확인합니다. 작업은 생성 후 1시간 이내에 사용합니다.

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

HTTP 요청

POST /api/v2/notepad/templates/{templateRid}/generationJobs/{generationJobRid}/saveDocument

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

경로 매개변수

쿼리 매개변수

요청 본문

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

다음은 문서를 저장할 폴더를 지정하는 요청 본문 예시입니다.

{
  "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"
}

응답

응답 형식은 SaveDocumentResponse입니다.

문서를 저장한 결과입니다.

새로 만든 Notepad 문서의 응답 예시입니다.

{
  "documentRid": "ri.notepad.main.notepad.ef32c039-353c-4555-9704-eacfdfaa2c1c"
}

개별 오류

요청 예제

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

저장할 폴더를 지정하고 문서 이름은 자동 생성하도록 생략한 예제입니다. 실제 성공한 생성 작업과 저장 폴더를 사용합니다. 실행하면 새 문서가 생성됩니다.

cURL

curl --fail -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/notepad/templates/ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52/generationJobs/ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c/saveDocument?preview=true" \
	-d '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}'

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 = {
    "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"
}

response = requests.post('https://{}/api/v2/notepad/templates/ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52/generationJobs/ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c/saveDocument?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
response.raise_for_status()
print(response.json())

Java

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

import java.io.IOException;
import org.apache.http.util.EntityUtils;
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 SaveDocumentGenerationJobExample {
    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/templates/ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52/generationJobs/ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c/saveDocument?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"parentFolderRid\":\"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791\"}", 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)로 실행합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

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

fetch(`https://${HOSTNAME}/api/v2/notepad/templates/ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52/generationJobs/ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c/saveDocument?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}'
}).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/templates/ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52/generationJobs/ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c/saveDocument?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"parentFolderRid`":`"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791`"}"

$response.content