Skip to main content
POST
Error

Authorizations

x-cdata-authtoken
string
header
required

Body

application/json

The files entity to post

ConnectorId
string
required

The connector Id.

Filename
string
required

The name of the file.

Folder
string
required

Which folder the file is in.

Subfolder
string

The subfolder of the file.

TimeCreated
string<date-time>

The time the file was created.

PortId
string

The port Id.

BatchGroupId
string

The batch group message Id. Null unless the file is a batch group.

MessageId
string

The file message Id. This only has a value when the file is a message.

IsBatchGroup
boolean

Whether the message is a batch group message.

Content
string

The Base64-encoded file contents. This is only returned when you request a specific file. You cannot use this field when filtering results with the $filter parameter. You must provide either Content or InputName: they cannot both be null.

FileSize
integer<int32>

The file size in bytes.

FilePath
string

The full path to the file.

Response

files created

ConnectorId
string
required

The connector Id.

Filename
string
required

The name of the file.

Folder
string
required

Which folder the file is in.

Subfolder
string

The subfolder of the file.

TimeCreated
string<date-time>

The time the file was created.

PortId
string

The port Id.

BatchGroupId
string

The batch group message Id. Null unless the file is a batch group.

MessageId
string

The file message Id. This only has a value when the file is a message.

IsBatchGroup
boolean

Whether the message is a batch group message.

Content
string

The Base64-encoded file contents. This is only returned when you request a specific file. You cannot use this field when filtering results with the $filter parameter. You must provide either Content or InputName: they cannot both be null.

FileSize
integer<int32>

The file size in bytes.

FilePath
string

The full path to the file.