List Activities¶

List activities

URI Template

GET /api/activities/{instance}/activities

{instance}: Yamcs instance name

Query Parameters

limit: The maximum number of returned records per page. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default: 100
order: The order of the returned results. Can be either asc or desc. Default: desc
status: Filter on activity status
type: The type of activity. Names must match exactly.
next: Continuation token returned by a previous page response.
start: Filter the lower bound of the activity's start time. Specify a date string in ISO 8601 format. This bound is inclusive.
stop: Filter the upper bound of the activity's generation time. Specify a datestring in ISO 8601 format. This bound is exclusive.
q: Text to search for in the description.

Response Type

interface ListActivitiesResponse {

  // Resulting activities, possibly limited
  activities: ActivityInfo[];

  // Token indicating the response is only partial. More results can then
  // be obtained by performing the same request (including all original
  // query parameters) and setting the ``next`` parameter to this token.
  continuationToken: string;
}

Related Types

interface ActivityInfo {

  // Activity identifier
  id: string;

  // Start time of the activity
  start: string;  // RFC 3339 timestamp

  // Differentiator in case of multiple activities
  // with the same start time
  seq: number;

  // Activity status
  status: ActivityStatus;

  // User who started the run
  startedBy: string;

  // Activity type
  type: string;

  // Activity arguments
  args: {[key: string]: any};

  // Activity detail (short descriptive)
  detail: string;

  // Stop time of the activity run
  stop: string;  // RFC 3339 timestamp

  // User who stopped the run. Only set if the activity
  // was manually stopped
  stoppedBy: string;

  // If set, the activity is stopped, but failed
  failureReason: string;
}

enum ActivityStatus {

  // An activity is runing
  RUNNING = "RUNNING",

  // The activity was cancelled. It may or may not still be running
  // (verify stop time).
  CANCELLED = "CANCELLED",

  // The activity completed successfully
  SUCCESSFUL = "SUCCESSFUL",

  // An error occurred while running this activity
  FAILED = "FAILED",
}