Run File Action¶

Run a file-specific action.

Available actions are specific to the File Transfer implementation.

URI Template

POST /api/filetransfer/{instance}/{serviceName}/files:runFileAction

{instance}: Yamcs instance name
{serviceName}: File transfer service name

Request Body

interface RunFileActionRequest {

  // Remote entity
  remoteEntity: string;

  // File identifier
  file: string;

  // Action name
  action: string;

  // Action message
  message: {[key: string]: any};
}

Response Type

// `Struct` represents a structured data value, consisting of fields
// which map to dynamically typed values. In some languages, `Struct`
// might be supported by a native representation. For example, in
// scripting languages like JS a struct is represented as an
// object. The details of that representation are described together
// with the proto support for the language.
//
// The JSON representation for `Struct` is JSON object.
interface Struct {

  // Unordered map of dynamically typed values.
  fields: {[key: string]: Value};
}