Send File

Sends a number of Files to a selection of Devices.

Devices can be specified using a list of IDs, a Tag, or a Filter Language Query. An
Operation object will be returned, which can be used to track the
progress of the Files sent to each Device.

Files are sent to multiple Devices in parallel, but for a single Device, Files are sent in series. If a File
with the same name and hash already exists on the Device, the File will not be sent.

Once sent to a Device, Files can be consumed by connected assets through ORP.

An error
will be returned if more than one of the following attributes are specified in the request:deviceIds, tag,
query.

Permissions required:

Path / RolePermissionDescription
File.pathReadRead access to the File(s) included in the request
Device.path or Device.tagWriteWrite access to the Device(s) included in the request
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The company name

Body Params

A method of selecting Devices. Choose only one

deviceIds
array of strings
length between 0 and 500

List of Device IDs which the File(s) should be sent to.

deviceIds
string

Filters objects using the Octave Filter Language

string

A Tag selecting the Devices to send the File(s) to.

string
length ≤ 20000

A free-form description of the Operation. Supplied by the user as part of
the request which creates the Operation

fileIds
object
required

The list of files which will be sent to Devices

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json