avanta icon

avanta

Consume avanta API

Actions57

Download → Create Item

AI-generated

Overview

This node operation creates a new download item in the Avanta system. It is useful for automating the addition of downloadable content or files to a platform, such as product manuals, software, or media files. Users can specify details like the item's title, status (active or inactive), and various additional metadata fields to customize the download item.

Use Case Examples

  1. Automatically add new downloadable product manuals to a portal when new products are added.
  2. Create download items for marketing materials and make them available on a customer portal.

Properties

Name Meaning
Request Options Options to configure the API request behavior, including debug mode, SSL certificate validation, and request timeout.
Use Bulk API Whether to use the bulk API for processing multiple items.
Dataflow ID Optional override for the dataflow ID; if not set, it is read from webhook input data when triggered via a dataflow profile.
Status Indicates whether the download item is active.
Title The title of the download item.
Additional Fields Optional additional metadata fields for the download item, such as visibility, description, company IDs, category IDs, filename, URL, and extension attributes.

Output

JSON

  • id - The unique identifier of the created download item.
  • title - The title of the created download item.
  • status - The active status of the created download item.
  • additionalFields
    • show_in_portal - Whether the item is shown in the portal.
    • external_id - External identifier of the item.
    • visibility - Visibility level of the item.
    • filename - Filename of the downloadable file.
    • description - Description of the download item.
    • short_description - Short description of the item.
    • company_ids
      * ids
      * id - List of associated company IDs.
    • category_ids
      * ids
      * id - List of associated category IDs.
    • company_group_ids - Company group IDs associated with the item.
    • item_dir - Directory path for the item.
    • preview - Preview content or URL.
    • extracted_text - Extracted text content from the item.
    • type - Type of the download item.
    • url - URL for the downloadable item.
    • extension_attributes
      * extension_attribute
      * attribute_code - Name or ID of the extension attribute.
      * value - Value of the extension attribute.

Dependencies

  • An API key credential for Avanta API authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to create download items.
  • If using the bulk API option, verify that the input data format matches the expected bulk structure.
  • Check that required fields like 'Title' and 'Status' are provided and valid.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; increase the timeout value if needed.

Links

Discussion