Documentation Powered by ReDoc

Submission API (1.0.0)

Download OpenAPI specification:Download

E-mail: thomas.yu@sagebionetworks.org License: Apache-2.0 Terms of Service

This is the submission API to obtain the metadata of the submission and send the submission to execute in the right workflow environment

Compute

Compute environment

Execution

Allow synapse submissions to interact with supported workflow engines

Mimics GA4GH

Queue

Ceate and link synapse queues with workflow engines

Create a queue

Creates a queue for storing and running of submissions

Request Body schema: application/json
name
string

Name of Queue

computeId
string

Compute Environment Id

workflowFiles
Array of strings

Workflow/Tool files and templates

workflowInput
string

Path to workflow inputs

submissionType
string
Enum: "docker" "file" "workflow" "workflow_inputs"

Path to workflow inputs

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "computeId": "string",
  • "workflowFiles": [
    ],
  • "workflowInput": "string",
  • "submissionType": "docker"
}

Response samples

Content type
application/json
{
  • "queueId": "string"
}

List the available queues

Returns the queues

query Parameters
limit
integer [ 10 .. 100 ]
Default: 10

Maximum number of results returned

offset
integer >= 0
Default: 0

Index of the first result that must be returned

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "links": {
    },
  • "totalResults": 0,
  • "queues": [
    ]
}

Get a queue by its ID

Returns the queue for a given ID

path Parameters
queueId
required
string

The ID of the queue

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "computeId": "string",
  • "workflowFiles": [
    ],
  • "workflowInput": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "submissionType": "docker"
}

Delete a queue by its ID

Deletes the queue for a given ID

path Parameters
queueId
required
string

The ID of the queue

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "type": "string"
}

Submission

Submission and its metadata

More about submission references

Create a submission

Creates a submission

path Parameters
queueId
required
string

The ID of the queue

Request Body schema: application/json
One of
name
required
string

Name of submission

submitter
required
string

Submitter name

object (SubmissionStatus)

Submission status

required
object

Responses

Request samples

Content type
application/json
Example
CreateDockerSubmissionRequest
CreateDockerSubmissionRequest
CreateFileSubmissionRequest
CreateWorkflowSubmissionRequest
{
  • "name": "string",
  • "submitter": "string",
  • "status": {
    },
  • "docker": {
    }
}

Response samples

Content type
application/json
{
  • "submissionId": "string"
}

List the submitted submissions

Returns the submissions from a queue

path Parameters
queueId
required
string

The ID of the queue

query Parameters
limit
integer [ 10 .. 100 ]
Default: 10

Maximum number of results returned

offset
integer >= 0
Default: 0

Index of the first result that must be returned

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "links": {
    },
  • "totalResults": 0,
  • "submissions": [
    ]
}

Get a submission by its ID

Returns the submission for a given ID

path Parameters
queueId
required
string

The ID of the queue

submissionId
required
string

The ID of the submission

Responses

Response samples

Content type
application/json
Example
DockerSubmission
DockerSubmission
FileSubmission
WorkflowSubmission
{
  • "name": "string",
  • "id": 0,
  • "submitter": "string",
  • "queueId": "string",
  • "status": {
    },
  • "docker": {
    }
}

Delete a submission by its ID

Deletes the submission for a given ID

path Parameters
queueId
required
string

The ID of the queue

submissionId
required
string

The ID of the submission

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "type": "string"
}

Team

Teams

HealthCheck

Get health check information

Get information about the health of the service

Responses

Response samples

Content type
application/json
{
  • "status": "pass"
}