Mark file as Box Doc Gen template
Mark file as Box Doc Gen template
You can mark an existing document as a Box Doc Gen template and use it to generate documents.
開始する前に
Before you start using Box Doc Gen API, follow the steps listed in the get started with Box Doc Gen guide to create a custom app and a Box Doc Gen template.
リクエストの送信
質問を含むリクエストを送信するには、POST /2.0/docgen_templates
エンドポイントを使用し、必須のパラメータを指定します。
パラメータ
To make a call you need to pass the following parameters. Mandatory parameters are in bold.
パラメータ | 説明 | 例 |
---|---|---|
file.id | ID of the file to be marked as the Box Doc Gen template. | 12345678 |
file.type | The type of provided input. The value is always file . | file |
ユースケース
Mark a file as Box Doc Gen template
The following sample show you how to mark a file to ensure it is recognized as a Box Doc Gen template.
cURL
curl -L 'https://api.box.com/2.0/docgen_templates' \
-H 'box-version: 2025.0' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-D '{
"file": {
"id": "12345678",
"type": "file"
}
}'
TypeScript Gen
await client.docgenTemplate.createDocgenTemplateV2025R0({
file: new FileReferenceV2025R0({ id: uploadedFile.id }),
} satisfies DocGenTemplateCreateRequestV2025R0);
Python Gen
client.docgen_template.create_docgen_template_v2025_r0(
FileReferenceV2025R0(id=uploaded_file.id)
)
.NET Gen
await client.DocgenTemplate.CreateDocgenTemplateV2025R0Async(requestBody: new DocGenTemplateCreateRequestV2025R0(file: new FileReferenceV2025R0(id: uploadedFile.Id)));
Remove Box Doc Gen template marking from a file
To make sure a file is no longer marked as a Box Doc Gen template, use the DELETE 2.0/docgen_templates/:template_id
request.
cURL
curl -L -X DELETE 'https://api.box.com/2.0/docgen_templates/12345678' \
-H 'box-version: 2025.0' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
TypeScript Gen
await client.docgenTemplate.deleteDocgenTemplateByIdV2025R0(
createdDocgenTemplate.file!.id,
);
Python Gen
client.docgen_template.delete_docgen_template_by_id_v2025_r0(
created_docgen_template.file.id
)
.NET Gen
await client.DocgenTemplate.DeleteDocgenTemplateByIdV2025R0Async(templateId: NullableUtils.Unwrap(createdDocgenTemplate.File).Id);