Reporter icon

Reporter

Interact with Reporter API

Actions120

Assessment Section → Create an assessment section

AI-generated

Summary

Create an assessment section in the selected assessment, with settings for findings, visibility, editing, page breaks, review status, and publication. Optionally set its placement in the section tree and provide a description or custom report heading.

Inputs

  • Assessment id (required) — Select the assessment that will contain the section.
  • Name (required) — Name the section.
  • Can have findings (required) — Set whether the section and its subsections can have findings assigned.
  • Finding is required (required) — Set whether the section must contain at least one finding.
  • Report section visibility (required) — Choose whether to include the section in the report, hide it and its subsections, or include it only when it has findings.
  • Is visible in assessment overview (required) — Set whether the section appears in the assessment overview.
  • Text editable with permission (required) — Set whether researchers with permission can edit the section.
  • Force page break after section (required) — Set whether the PDF report starts a new page after this section.
  • Management report section visibility (required) — Choose whether to include the section in the management report, hide it and its subsections, or include it only when it has findings.
  • Review status (required) — Set the section's review status: Draft, Under Review, Revision Requested, or Approved.
  • Is published (required) — Set whether the section is published.
  • Anchor section id — Optionally place the new section relative to this existing section. If omitted, the section is appended at the end.
  • Place — When an anchor section ID is provided, choose Before, Inside (as a child), or After.
  • Description — Optional section contents in Markdown.
  • Report heading — Optionally set the report heading level (1–6). Heading 1 starts on a new page; if omitted, the level is derived from the section's depth in the tree.

Output shape

A single assessment section record returned by the API.

The source pack identifies this as a create request but does not show the response handling for this operation, so the exact response envelope is unspecified.

Links

Discussion