Skip to main content
POST
CreateRemoteFile

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to RemoteFileService_CreateRemoteFile to create a remote file.

The request for a call to RemoteFileService_CreateRemoteFile to create a remote file.

fileName
string
required
entityId
string
required
entityType
enum<string>
default:ENTITY_TYPE_UNSPECIFIED
required
  • ENTITY_TYPE_CANVAS_CELL_EXECUTION_ATTACHMENT: UI evidence files attached to a cell execution on a canvas report.
  • ENTITY_TYPE_CANVAS_CELL_EXECUTION_OUTPUT: Reserved for a future cell-output upload path (not used by the report attachment UI).
Available options:
ENTITY_TYPE_UNSPECIFIED,
ENTITY_TYPE_RUN,
ENTITY_TYPE_ANNOTATION,
ENTITY_TYPE_ASSET,
ENTITY_TYPE_ANNOTATION_LOG,
ENTITY_TYPE_TEST_REPORT,
ENTITY_TYPE_TEST_STEP,
ENTITY_TYPE_CANVAS_VERSION,
ENTITY_TYPE_CANVAS_CELL_EXECUTION_ATTACHMENT,
ENTITY_TYPE_CANVAS_CELL_EXECUTION_OUTPUT
fileMimeType
string
required
fileContentEncoding
string
required
fileSize
string<uint64>
required
description
string
organizationId
string

This field is only required if your user belongs to multiple organizations.

videoMetadata
object
imageMetadata
object
audioMetadata
object
customUuid
string

A custom UUID used to generate the object key. Recommended to be left unset.

metadataValues
object[]

The metadata values associated with this remote file.

Response

A successful response.

The response for a call to RemoteFileService_CreateRemoteFile.

remoteFile
object
required