Ion Channel Raw Data/SEVA API

Base URL: /v1, Version: 0.0.3

Contains the data used for generation of the SEVA(Software EVidence Archive)

Default response content-types: application/json
Schemes: https

Summary

Tag: Analysis

Operation Description
GET /animal/getAnalysis

Retrieve the analysis details given a analysis ID

GET /animal/getAnalyses

Retrieve a list of analyses details given an account ID

GET /animal/getScan

Retrieve the scan details given a analysis ID and scan ID

Tag: Scan

Operation Description
GET /animal/getScan

Retrieve the scan details given a analysis ID and scan ID

Paths

Retrieve a list of analyses details given an account ID

GET /animal/getAnalyses

Tags: Analysis

the /animal/getAnalyses endpoint returns an object containing an array of analyses for a given team_id.

team_id

The ID of the account to request all analyses for

query string (uuid)
project_id

The ID of the project to request details for

query string (uuid)
limit

Limit the number of rows in the response. To receive all rows set limit to 0.

query integer 10
offset

Starting row for responses (for pagination)

query integer

Uses default content-types: application/json

200 OK

An object containing a list of analyses

404 Not Found

No the analysis details were found

default

Unexpected error

Retrieve the analysis details given a analysis ID

GET /animal/getAnalysis

Tags: Analysis

the /animal/getAnalysis endpoint returns an object containing the details for a given analysis.

id

The ID of the analysis to request details for

query string (uuid)
project_id

The ID of the project to request details for

query string (uuid)
team_id

The ID of the team to request details for

query string (uuid)

Uses default content-types: application/json

200 OK

An object containing the analysis's details

404 Not Found

No the analysis details were found

default

Unexpected error

Retrieve the scan details given a analysis ID and scan ID

GET /animal/getScan

Tags: Scan, Analysis

the /animal/getScan endpoint returns an object containing the details for a given scan.

id

The ID of the scan to request details for

query string (uuid)
project_id

The ID of the project to request details for

query string (uuid)
analysis_id

The ID of the analysis to request details for

query string (uuid)
team_id

The ID of the account to request details for

query string (uuid)

Uses default content-types: application/json

200 OK

An object containing the Scan's details

404 Not Found

No the analysis details were found

default

Unexpected error

Schema definitions

Analyses: object

data: object[]
meta: Meta
timestamps: Timestamps
links: Links

Analysis: object

team_id: string (uuid)

Account ID of analysis owner

project_id: string (uuid)

Id of the project this analysis belongs

id: string (uuid)

Unique identifier representing a specific analysis

name: string

Name of the analysis?

type: string

Source type for the analysis (git|file)

source: string

Source endpoint for the analysis (git repo)

branch: string

Source specifier for a source (git branch)

description: string

Short description of the analysis

risk: string

Ion Channel risk rating

scan_summaries: object[]
status: string

Code for the results of the scan [accepted|failed|finished]

meta: Meta
timestamps: Timestamps
links: Links

AnalysisInput: object

team_id: string (uuid)

Account ID of analysis owner

project_id: string (uuid)

Id of the project this analysis belongs

name: string

Name of the analysis?

type: string

Source type for the analysis (git|file)

source: string

Source endpoint for the analysis (git repo)

branch: string

Source specifier for a source (git branch)

description: string

Short description of the analysis

status: string

Code for the results of the scan [accepted|failed|finished]

Error: object

code: integer (int32)
message: string
fields: string

Meta: object

copyright: string

Copyright info

authors: string

Authors

version: string

API version

last_update: string

Last update of source data (optional)

Scan: object

team_id: string (uuid)

Account ID of analysis owner

project_id: string (uuid)

Id of the project this scan belongs

analysis_id: string (uuid)

Unique identifier representing a specific analysis

id: string (uuid)

The unique id for a scan

description: string

Short human readable description of the results of the analysis

name: string

The name of the scan type that was run

summary: string

Summary of the scan results

results: object[]
meta: Meta
timestamps: Timestamps
links: Links

ScanInput: object

team_id: string (uuid)

Account ID of analysis owner

project_id: string (uuid)

Id of the project this scan belongs

analysis_id: string (uuid)

Unique identifier representing a specific analysis

description: string

Short human readable description of the results of the analysis

name: string

The name of the scan type that was run

results: object

The scan specific results object container

ScanResult: object

scan_id: integer

ID of the Scan

name: string

Name of the scan that was run

results: object

The data specific to the given scan defined by the name

ScanSummary: object

team_id: string (uuid)

Account ID of analysis owner

project_id: string (uuid)

Id of the project this scan belongs

analysis_id: string (uuid)

Unique identifier representing a specific analysis

id: string (uuid)

The unique id for a scan

description: string

Short human readable description of the results of the analysis

name: string

The name of the scan type that was run

summary: string

Summary of the scan result

risk: string

Ion Channel risk rating

results: ScanResult
meta: Meta
timestamps: Timestamps
links: Links

Timestamps: object

created: string

Time the object was created

updated: string

Time the object was last updated