Actions120
- Activity Actions
- API Token Actions
- Assessment Actions
- Assessment Comment Actions
- Assessment Phase Actions
- Assessment Section Actions
- Assessment Section Event Actions
- Assessment Section Template Actions
- Assessment Task Set Actions
- Assessment Template Actions
- Assessment Template Checklist Actions
- Assessment User Actions
- Checklist Actions
- Checklist Category Actions
- Checklist Category Template Actions
- Checklist Template Actions
- Client Actions
- Custom Field Actions
- Document Actions
- Finding Actions
- Finding Event Actions
- List finding events
- Create a finding comment
- Update a finding comment
- Create a finding retest
- Update a finding retest
- Create a finding retest inquiry
- Update a retest inquiry
- Create a finding retest cancelled event
- Update a retest cancelled event
- Create a finding review event
- Create a finding retest review event
- Create a remediation status change
- Update a remediation status change
- Finding Layout Actions
- Finding Template Actions
- Language Actions
- Notification Actions
- Output File Actions
- Reaction Actions
- Role Actions
- Snippet Actions
- Tag Actions
- Target Actions
- Task Actions
- Task Set Actions
- Team Actions
- Team User Actions
- Test Case Actions
- Test Case Template Actions
- Theme Actions
- Tool Finding Actions
- Tool Target Actions
- User Actions
Document → Upload a document
AI-generatedSummary
Upload a document file associated with a specified model type and section using binary data from a workflow node.
Inputs
- Documentable type (required) — Select the model type the document belongs to, e.g., Finding or Assessment.
- Section (required) — Specify the section of the associated model where the document will belong; must be a valid section value as per the API documentation.
- Binary Property (required) — Name of the binary property containing the file data to upload (e.g., 'data').
- Additional Fields — Optional fields including documentable id (ID of the associated model, must be alphanumeric), caption (image caption or document title used in markdown, not stored in the database), and language id (for translations when applicable).
Output shape
a single JSON object containing details of the uploaded document as returned by the API.
The operation performs a multipart/form-data upload using the binary file data from the specified property. Additional optional parameters can further specify metadata for the document. The response includes the created document's data in JSON format.
Examples
Example 1: Upload a PDF document to the 'description' section of a Finding model with an optional caption.
- Set Documentable type to 'Finding'.
- Enter 'description' for Section.
- Choose the binary property holding the PDF file data.
- Optionally provide Documentable id and Caption in Additional Fields.