Back to top

Bruce runs uploaded code easily.

More description and simple examples go here.

Pipelines 

Pipeline objects facilitate execution of a Submission.

Pipeline List 

Pipelines woo woo

Get Pipelines
/pipelines
  • Request
  • Headers
    Content-Type: application/json
    X-Access-Token: <access token>
    Body
    {
        "name": "My new pipeline"
    }
    
  • Response  200
  • Headers
    Content-Type: application/json
Create New Pipeline
/pipelines

Create a new pipeline.

  • Request
  • Headers
    Content-Type: application/json
    X-Access-Token: <access token>
    Body
    {
        "name": "My new pipeline"
    }
    
  • Response  201
  • Response  400
  • Headers
    Content-Type: application/json
    Body
    {
        "error": "Invalid title"
    }
    
  • Response  401
  • Body
        {
            "error": "invalid access token"
        }
    
    

Pipeline 

Pipeline description

Get Pipeline
/pipelines/{id}

Get a single pipeline.

  • Parameters
  • id
    string (required) Example: 123

    The pipeline ID

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "id": 1,
        "name": "My pipeline",
        "language": "any",
        "inputUrl": ".../pipelines/{id}/input",
        "timeout": 5,
        "settings": {
            "container": "default",
            "command": "",
            "env": ""
        }
    }
    
  • Response  404
  • Headers
    Content-Type: application/json
    Body
    {
        "error": "Pipeline not found"
    }
    
Delete a Pipeline
/pipelines/{id}

Delete a single pipeline.

  • Parameters
  • id
    string (required) Example: 123

    The pipeline ID

  • Response  204
  • Response  404
  • Headers
    Content-Type: application/json
    Body
    {
        "error": "Note not found"
    }
    

Pipeline Submissions 

Get Pipeline Submissions
/pipelines/{id}/submissions

List submissions for a single pipeline.

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    [Submission][]
    
  • Response  404

Submissions 

Submission List 

Get Submissions
/submissions
  • Request
  • Headers
    Content-Type: application/json
    X-Access-Token: <access token>
    Body
    {
        "name": "My new pipeline"
    }
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "pipeline": "123",
        "codeUrl": "https://...",
        "outputUrl": "https://...",
        "status": "executed",
        "language": "python",
        "createDate": "...",
        "executeDate": "..."
    }
    
Create Submission
/submissions
  • Parameters
  • language
    string (required) Example: python

    Specify the language of the submission.

    Choices: python lua javascript java

    code
    string (optional) Example: print('hello world!')

    The code to run.

    filename
    string (optional) Example: script.py

    The filename to save the code to.

    joinedBefore
    string (optional) Example: 2011-01-01

    Search by join date

    joinedAfter
    string (optional) Example: 2011-01-01

    Search by join date

    limit
    integer (optional) Default: 10 Example: 25

    The maximum number of users to return, up to 50

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "pipeline": "123",
        "language": "python",
        "code": "x = 5..."
    }
    
  • Response  200
  • Response  400

Submission 

Get Submission
/submissions/{id}
  • Response  200
  • Response  404

Submission Code 

Get Submission Code
/submissions/{id}/code
  • Response  200
  • Response  404

Submission Output 

Get Submission Output
/submissions/{id}/output
  • Response  200
  • Response  404

Generated by aglio on 16 Jul 2015