The Project Resource - One Codex Developer Docs

{
  "$uri": "/api/v1/projects/0d77065796f8d173",
  "owner": {
    "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
  },
  "permissions": [
    "<string>"
  ],
  "project_name": "<string>",
  "description": "<string>",
  "external_id": "PRJ-2024-001",
  "name": "<string>",
  "public": false
}

Projects are a grouping mechanism for samples. They allow you to organize related samples, share them with collaborators, and apply consistent permissions. A user can own multiple projects, be a member of projects owned by others, and (with appropriate permissions) make projects public so they appear on the One Codex platform’s public listings. The below table summarizes all of the properties for the Project resource, with the JSON schema type of each property listed below in italics.

$uri

string

required

read-only

Pattern: ^/api/v1/projects/[a-f0-9]{16}$

Example:

"/api/v1/projects/0d77065796f8d173"

owner

users · object

required

Show child attributes

permissions

string[]

required

project_name

string | null

required

Required string length: 3 - 15

Pattern: ^[a-zA-Z0-9_-]{3,15}$

description

string | null

external_id

string | null

Example:

"PRJ-2024-001"

name

string | null

public

boolean

default:false

Delete A Sample Retrieve All Projects