Terrain Discovery Environment API · Schema

Terrain Analysis

A bioinformatics analysis job submitted through the CyVerse Discovery Environment Terrain API.

BioinformaticsData ScienceLife SciencesFilesystemCloud ComputingOpen Source

Properties

Name	Type	Description
id	string	Unique UUID identifier for the analysis
name	string	User-provided name for this analysis job
description	string	Optional description of the analysis
app_id	string	UUID of the application used for this analysis
app_name	string	Display name of the application
system_id	string	Execution system (de for Discovery Environment, tapis for TACC)
status	string	Current execution status of the analysis
start_date	string	ISO 8601 timestamp when the analysis started
end_date	string	ISO 8601 timestamp when the analysis completed
result_folder_path	string	iRODS path where output files are stored
username	string	CyVerse username of the analysis owner

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/terrain-discovery-environment-api/main/json-schema/terrain-analysis-schema.json",
  "title": "Terrain Analysis",
  "description": "A bioinformatics analysis job submitted through the CyVerse Discovery Environment Terrain API.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique UUID identifier for the analysis"
    },
    "name": {
      "type": "string",
      "description": "User-provided name for this analysis job"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the analysis"
    },
    "app_id": {
      "type": "string",
      "description": "UUID of the application used for this analysis"
    },
    "app_name": {
      "type": "string",
      "description": "Display name of the application"
    },
    "system_id": {
      "type": "string",
      "description": "Execution system (de for Discovery Environment, tapis for TACC)"
    },
    "status": {
      "type": "string",
      "enum": ["Submitted", "Running", "Completed", "Failed", "Canceled"],
      "description": "Current execution status of the analysis"
    },
    "start_date": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the analysis started"
    },
    "end_date": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the analysis completed"
    },
    "result_folder_path": {
      "type": "string",
      "description": "iRODS path where output files are stored"
    },
    "username": {
      "type": "string",
      "description": "CyVerse username of the analysis owner"
    }
  },
  "required": ["id", "name", "app_id", "system_id", "status"]
}