Skip to content

Projects

Projects are collaborative research units in FLAME Hub. They group analyses, nodes, and data requirements into a single organizational context.

Overview

Projects overview

Creating a Project

Create project

A project defines:

  • Name and description
  • Selected nodes — the institutions participating in the analysis
  • Risk assessment — evaluation of data sensitivity and privacy requirements

Naming

Like analyses, projects have two name fields:

  • name — a unique, URL-friendly identifier (lowercase letters, digits and the characters -, _, .; no whitespace). It is required and must be unique. If you do not provide one when creating a project, a readable name is generated automatically (e.g. brave-otter-1a2b3c); the create form also pre-fills an editable suggestion.
  • display_name — an optional, free-form human-readable label. When set, it is shown in the UI in place of the name.

Once created, a project enters a pending state and requires administrator approval before analyses can be added (unless approval is disabled in development).

Project Nodes

Nodes are assigned to projects via ProjectNode associations. Only nodes assigned to a project can participate in that project's analyses.

API Endpoints

MethodEndpointDescription
GET/projectsList projects
POST/projectsCreate project
GET/projects/:idGet project details
PUT/projects/:idUpdate project
DELETE/projects/:idDelete project
GET/project-nodesList project-node associations
POST/project-nodesAssign node to project
DELETE/project-nodes/:idRemove node from project