OpenAPI V2 Scenarios

This page organizes common OpenAPI V2 integration paths by business goal. If you already know which endpoint to call, go back to OpenAPI V2 Overview for the API index.

Scenario list

Read scenarios

• Query forms and records linked to a QR code: start from QR code and obtain code_id, tpl_id, then read form structure and record list.

Write scenarios

• Submit a record to a form under a QR code: locate target QR code and form, then build fields[] with structured IDs.
• Bulk add records from Excel: parse Excel locally and call addRecord row by row.

Reading tips

• Unsure about authentication: read Authentication (OpenAPI V2)
• Need field details, schema, or full examples: jump from scenario pages to corresponding API pages
• Need code generation or tool import: use https://open.cli.im/openapi.json