Smapone icon

Smapone

Interact with the Smapone API

Actions85

SmapsData → Load All Data Records for Given Version

AI-generated

Summary

Load all data records for a specified smap ID and version, optionally filtering by record state and output format, with the option to mark loaded records as exported.

Inputs

  • API — Selects the API scope, either 'Intern' or 'Preview'. This operation requires the 'Intern' scope.
  • Smap ID (required) — The ID of the smap whose data records are to be loaded.
  • Version (required) — The specific version of the smap for which to load all data records.
  • Mark as Exported — Boolean flag to mark the loaded records as exported (true) or not (false). Defaults to false.
  • Output Format — The desired output format of the data records: JSON (default), PDF, or XML.
  • Record State Filter — Filters data records to those with a specific state: 'New' (default), 'Exported', or 'Incomplete'.

Output shape

a list of data records for the given smap ID and version, formatted as specified (JSON, PDF, or XML).

The returned list includes records filtered by the specified state if given. If 'Mark as Exported' is true, the retrieved records are updated to the exported state. Supports only the 'Intern' API scope.

Examples

Example 1: Load all new data records for smap ID '12345' and version '1.0' in JSON format without marking them as exported.

Set API to 'Intern', provide smapId='12345', version='1.0', leave 'Mark as Exported' false, output format 'JSON', and state filter 'New'.

Links

Discussion