Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

REST API 

Put all endpoints on secure channel

Jobs

Jobs are the submission to computing resources.

job_id: it's an unique id of an instance of published CI workflow. It's different from queue id from HPC

request
method

URL

Description

GET

jobs?idlist=xml

get list of status by the given list of job ids

PUT

jobs/delete?before=utc

delete jobs before utc timestamp from database

GET

jobs/{job_id}

get the status of a job by id

PUT

jobs/{job_id}/cancel

cancel the job by id

PUT

jobs/{job_id}/delete

delete the job by id from database

POST

jobs/submit

submit job submission xml; return status

Deprecated - Users

request
method

URL

Description

GET

users

get all user ids

GET

users/{user_id}

get the info of a user by id

Deprecated - Workflows

Workflows are the predefined analysis workflows which are registered at repository.

request
method

URL

Description

GET

workflows

get all ids of available workflows

GET

workflows/{workflow_id}

get the information of a workflow by id

GET

workflows/{workflow_id}/input

get the specification of input of a workflow by id

GET

workflows/{workflow_id}/output

get the specification of output of a workflow by id