Acumatica API - Custom Endpoint icon

Acumatica API - Custom Endpoint

Interact with a custom Acumatica endpoint (schema fetched from the instance)

Download File

AI-generated

Summary

Download a file from a specified Acumatica custom endpoint using the file's GUID and store it in the specified binary output field.

Inputs

  • Endpoint Name (required) — The Acumatica endpoint name, e.g. Default or JMS.CRM.
  • Endpoint Version (required) — The endpoint version, e.g. 24.200.001 or 1.0.
  • File ID (required) — The GUID of the file to download, taken from a record's expanded files list.
  • Binary Field (required) — The name of the binary output field in which to store the downloaded file's content.

Output shape

A single item per execution containing JSON metadata (fileId, fileName, mimeType) and a binary property with the file content stored under the specified binary field name.

The operation sends a GET request to the /files/{fileId} path of the specified endpoint and version. The file content is returned as raw binary, with filename and MIME type extracted from the response headers. The binary data is stored in the workflow item's specified binary field output. If the filename or MIME type are unavailable, their values may be null.

Links

Discussion