Skip to main content

Report

Use the Report tool to generate a report for a data record. The report includes a folder for each function that was previously executed for the record.

The tool packages the report as a ZIP archive and returns the archive as a Base64-encoded value.

Parameters​

You can include a custom output file alongside the report files that the tool generates automatically.

SettingDescriptionRequired
Output fileActivate it to add a custom output file to the generated report.Yes
File nameSets the name of the custom file in the ZIP archive.No
Data output structureDefines the content of the custom output file.No

Report contents​

The generated ZIP archive contains:

  • A folder for each function that was previously executed for the data record.
  • A custom output file, when one is configured under Report configuration.

Response​

The tool returns the following fields:

FieldDescription
report_outputThe generated ZIP archive as a Base64-encoded value.
error.codeThe error code when the report cannot be generated.
errorError information when the report cannot be generated.

Was this article helpful?