템플릿 콘텐츠 생성(Generate Template) (V2)

게시된 Notepad 템플릿에 매개변수를 적용하여 GenerationJob을 만듭니다. 작업이 성공하면 생성한 콘텐츠를 문서로 저장하거나 파일로 내보낼 수 있습니다.

templateVersion을 생략하면 가장 최근에 게시된 버전을 사용합니다. 템플릿이 요구하는 매개변수 이름과 자료형을 맞추어 전달합니다. 생성 작업에는 api:notepad-write 권한 범위가 필요하며 만든 사용자만 해당 작업에 접근할 수 있습니다. 생성한 작업은 1시간 이내에 사용합니다.

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

HTTP 요청

POST /api/v2/notepad/templates/{templateRid}/generate

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

경로 매개변수

쿼리 매개변수

요청 본문

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

templateParameters의 구조

맵의 키는 TemplateParameterName(string), 값은 TemplateParameterValue(union<objectSetRid, date, dateTime, string, double, objectRid>)입니다.

키: 템플릿 매개변수의 이름입니다.

템플릿 매개변수의 값입니다.

분기 objectSetRid

객체 집합 RID 값입니다.

분기 date

날짜 값입니다.

분기 dateTime

날짜와 시각 값입니다.

분기 string

문자열 값입니다.

분기 double

double 값입니다.

분기 objectRid

객체 RID 값입니다.

다음은 템플릿의 매개변수와 게시 버전을 지정하는 요청 본문 예시입니다.

{
  "templateParameters": {
    "customerName": {
      "type": "string",
      "value": "John Doe"
    }
  },
  "templateVersion": 42
}

응답

응답은 GenerationJobRid를 담은 JSON 문자열입니다. 상태 객체가 함께 반환되는 형식이 아니므로 생성 작업 조회에 이 RID를 전달하여 상태를 확인합니다.

생성 작업의 고유 식별자입니다.

생성 작업의 응답 예시입니다.

"ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c"

개별 오류

요청 예제

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

게시 버전 42가 있고 customerName이라는 문자열 매개변수를 받는 템플릿 예제입니다. John Doe는 매개변수의 예시 값입니다. 실제 템플릿의 게시 버전과 입력값을 사용합니다.

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/generate?preview=true" \
	-d '{"templateParameters":{"customerName":{"type":"string","value":"John Doe"}},"templateVersion":42}'

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 = {
    "templateParameters": {
        "customerName": {
            "type": "string",
            "value": "John Doe"
        }
    },
    "templateVersion": 42
}

response = requests.post('https://{}/api/v2/notepad/templates/ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52/generate?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
response.raise_for_status()
print(response.json())

Java

Apache HttpClient 4.5 API를 사용하는 GenerateTemplateExample.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 GenerateTemplateExample {
    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/generate?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"templateParameters\":{\"customerName\":{\"type\":\"string\",\"value\":\"John Doe\"}},\"templateVersion\":42}", 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/generate?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"templateParameters":{"customerName":{"type":"string","value":"John Doe"}},"templateVersion":42}'
}).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/generate?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"templateParameters`":{`"customerName`":{`"type`":`"string`",`"value`":`"John Doe`"}},`"templateVersion`":42}"

$response.content