feed.md

Feed

API resource representing a container or grouping for a set of runtime ChRIS objects known as plugin instances that are organized as nodes of a connected directed acyclic graph (DAG). It can also be viewed as a container for all the files generated by the plugin instances run within the feed.

A feed is created by the root node of its plugin instance DAG. The root node must be a plugin instance of a plugin of type fs (feed synthesis plugin). The rest of the plugin instances within the feed can only be of type ds (data synthesis, by far the most common) or ts (a special type of topological plugin instances).

Semantic descriptors

• id: feed unique identifier
• creation_date: feed creation date
• modification_date: feed modification date
• name: feed name
• creator_username: username of the ChRIS user that created the feed
• created_jobs: number of plugin instances with created status within the feed
• waiting_jobs: number of plugin instances with waiting status within the feed
• scheduled_jobs: number of plugin instances with scheduled status within the feed
• started_jobs: number of plugin instances with started status within the feed
• registering_jobs: number of plugin instances with registering output files status within the feed
• finished_jobs: number of plugin instances with finished status within the feed
• errored_jobs: number of plugin instances with errored status within the feed
• cancelled_jobs: number of plugin instances with cancelled status within the feed

Link relations

• owner: points to a ChRIS user that owns the feed (there can be many owners for shared feeds)
• note: points to the feed's note
• tags: points to the collection of feed's tags
• taggings: points to the collection of feed's taggings
• comments: points to the collection of feed's comments
• plugin_instances: points to the collection of all the plugin instances created within the feed
• files: points to the collection of all the plugin instance files created within the feed