Skip to main content

Worker Roster

A roster sample that merges the flat fields of a single worker (name, date of birth, hire date and so on). Clone the template into your own workspace, pass the published input JSON to POST /v1/file/sync/single as content.params, and you reproduce the same output as the finished PDF on GitHub.

  • What it exercises: Single record / date fields (date of birth, hire date) / Japanese text
  • Expected pages: 1
  • Supported API version: v1 (POST /v1/file/sync/single)
  • GitHub: examples/worker-roster

When should I use this worker roster sample?

Use it when you want to try a document that has no line-item array — just a single record. It shows whether date fields such as date of birth and hire date are merged correctly.

1. Clone the template

Clone "労働者名簿" from the template gallery into your own Re:port Flow workspace. After cloning, look up your own design ID.

2. Finished PDF (expected output)

The verified finished PDF is available on GitHub.

3. Input JSON

This is the input data you pass to the API as content.params (view on GitHub).

{
"フリガナ": "ヤマダ タロウ",
"氏名": "山田 太郎",
"性別": "男",
"生年月日": "2000-01-01 12:00:00",
"郵便番号": "100-1000",
"住所": "東京都千代田区",
"従事する業務の種類": "営業事務",
"雇入れ年月日": "2026-04-01 12:00:00",
"退職又は死亡事由": "",
"履歴": ""
}

4. Call the API

Run the request with your appkey and the design ID and version of your clone.

curl -X POST https://api.re-port-flow.com/v1/file/sync/single \
-H "appkey: ak_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"designId": "(your cloned design ID)",
"version": 1,
"content": { "fileName": "worker-roster", "params": { /* the input.json above */ } }
}' \
--output output.pdf

curl / Node.js / Python request examples are on GitHub.

note

The keys in params must match the parameter definition of the template you cloned. You can fetch that definition with Design Parameters (GET /v1/file/design/parameter/{designId}?version=1).