List Items¶

interface ListItemsResponse {
  items: TimelineItem[];

  // 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;
}

interface TimelineItem {

  // Item identifier
  id: string;

  // Item name
  name: string;
  type: TimelineItemType;
  start: string;  // RFC 3339 timestamp
  duration: string; // Duration in seconds. Example: "3s" or "3.001s"
  tags: string[];

  //if this item is part of a group, this is the group identifier
  groupId: string;

  //if this item time specification is relative to another item, relativeTime contains a reference
  // to that item as well as the relative start (the duration is the same as given by the duration above)
  //note that start of the item will be computed by the server based on the relativeTime before sending the item to the client
  relativeTime: RelativeTime;
}

interface RelativeTime {

  // Identifier of the item that this time is relative to.
  relto: string;
  relativeStart: string; // Duration in seconds. Example: "3s" or "3.001s"
}

enum TimelineItemType {

  //events are the most generic timeline items.
  EVENT = "EVENT",

  //unlike events, activities have an execution status
  //manual activity's execution status is controlled by an operator
  MANUAL_ACTIVITY = "MANUAL_ACTIVITY",

  //activity which is automatically executed on the server (the status changes automatically)
  AUTO_ACTIVITY = "AUTO_ACTIVITY",

  //a grouping of other items (events and/or activities)
  ITEM_GROUP = "ITEM_GROUP",

  //a grouping of activities - unlike the ITEM_GROUP, this group in itself is an automated activity
  ACTIVITY_GROUP = "ACTIVITY_GROUP",
}