Home

/

GitHub

/

vjcitn/terraClientR

/

docs/SubmissionsApi.md

terraClientR: R Package Client for FireCloud

SubmissionsApi

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- AbortSubmission | DELETE /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions/{submissionId} | abort a submission CountSubmissions | GET /api/workspaces/{workspaceNamespace}/{workspaceName}/submissionsCount | Count submissions by status CreateSubmission | POST /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions | Create a submission. ListSubmissions | GET /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions | List submissions. MonitorSubmission | GET /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions/{submissionId} | Monitor submission status ValidateSubmission | POST /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions/validate | Validate submission WorkflowCostInSubmission | GET /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions/{submissionId}/workflows/{workflowId}/cost | Retrieve workflow cost, if available. WorkflowMetadata | GET /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions/{submissionId}/workflows/{workflowId} | Get call-level metadata for workflow WorkflowOutputsInSubmission | GET /api/workspaces/{workspaceNamespace}/{workspaceName}/submissions/{submissionId}/workflows/{workflowId}/outputs | Get workflow outputs. WorkflowQueueStatus | GET /api/submissions/queueStatus | workflow queue status

AbortSubmission

AbortSubmission(workspace.namespace, workspace.name, submission.id)

abort a submission

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name
var.submission.id <- 'submission.id_example' # character | Submission ID

#abort a submission 
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
api.instance$AbortSubmission(var.workspace.namespace, var.workspace.name, var.submission.id)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name | submission.id | character| Submission ID |

void (empty response body)

googleoauth

Content-Type: Not defined
Accept: Not defined

| Status code | Description | Response headers | |-------------|-------------|------------------| | 204 | Aborted successfully | - | | 404 | Submission not found | - | | 500 | Internal Error | - |

CountSubmissions

SubmissionsCountResponse CountSubmissions(workspace.namespace, workspace.name)

Count submissions by status

Counts all submissions run in the workspace, grouped by status. Returns a map of status:count.

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name

#Count submissions by status
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$CountSubmissions(var.workspace.namespace, var.workspace.name)
dput(result)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name |

SubmissionsCountResponse

googleoauth

Content-Type: Not defined
Accept: application/json

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successful Request | - | | 404 | Workspace not found | - | | 500 | Internal Error | - |

CreateSubmission

CreateSubmission(workspace.namespace, workspace.name, submission)

Create a submission.

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name
var.submission <- SubmissionRequest$new("methodConfigurationNamespace_example", "methodConfigurationName_example", "useCallCache_example", "entityType_example", "entityName_example", "expression_example", "deleteIntermediateOutputFiles_example", "useReferenceDisks_example", "NoNewCalls") # SubmissionRequest | Post Submission

#Create a submission. 
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
api.instance$CreateSubmission(var.workspace.namespace, var.workspace.name, var.submission)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name | submission | SubmissionRequest| Post Submission |

void (empty response body)

googleoauth

Content-Type: application/json
Accept: Not defined

| Status code | Description | Response headers | |-------------|-------------|------------------| | 201 | Successful Request | - | | 400 | Expression eval failed or entities are not of type required by method config | - | | 404 | Method Configuration or Entity not found | - | | 409 | Method Configuration failed to resolve input expressions with the supplied Entity | - | | 500 | Internal Error | - |

ListSubmissions

ListSubmissions(workspace.namespace, workspace.name)

List submissions.

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name

#List submissions. 
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
api.instance$ListSubmissions(var.workspace.namespace, var.workspace.name)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name |

void (empty response body)

googleoauth

Content-Type: Not defined
Accept: Not defined

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | List of submissions | - | | 404 | Workspace not found | - | | 500 | Internal Error | - |

MonitorSubmission

Submission MonitorSubmission(workspace.namespace, workspace.name, submission.id)

Monitor submission status

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name
var.submission.id <- 'submission.id_example' # character | Submission ID

#Monitor submission status 
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$MonitorSubmission(var.workspace.namespace, var.workspace.name, var.submission.id)
dput(result)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name | submission.id | character| Submission ID |

Submission

googleoauth

Content-Type: Not defined
Accept: application/json

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successful Request | - | | 404 | Submission not found | - | | 500 | Internal Error | - |

ValidateSubmission

SubmissionValidationReport ValidateSubmission(workspace.namespace, workspace.name, submission)

Validate submission

Validate expression syntax for a submission

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name
var.submission <- SubmissionRequest$new("methodConfigurationNamespace_example", "methodConfigurationName_example", "useCallCache_example", "entityType_example", "entityName_example", "expression_example", "deleteIntermediateOutputFiles_example", "useReferenceDisks_example", "NoNewCalls") # SubmissionRequest | Description of a submission.

#Validate submission
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$ValidateSubmission(var.workspace.namespace, var.workspace.name, var.submission)
dput(result)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name | submission | SubmissionRequest| Description of a submission. |

SubmissionValidationReport

googleoauth

Content-Type: application/json
Accept: application/json

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Validation Response | - | | 400 | Expression evaluation failed or entities are not of type required by method config | - | | 404 | Workspace, Method Configuration or Entity not found | - | | 500 | Rawls Internal Error | - | | 502 | Trouble talking to Agora | - |

WorkflowCostInSubmission

WorkflowCost WorkflowCostInSubmission(workspace.namespace, workspace.name, submission.id, workflow.id)

Retrieve workflow cost, if available.

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name
var.submission.id <- 'submission.id_example' # character | Submission ID
var.workflow.id <- 'workflow.id_example' # character | Workflow ID

#Retrieve workflow cost, if available. 
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$WorkflowCostInSubmission(var.workspace.namespace, var.workspace.name, var.submission.id, var.workflow.id)
dput(result)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name | submission.id | character| Submission ID | workflow.id | character| Workflow ID |

WorkflowCost

googleoauth

Content-Type: Not defined
Accept: application/json

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successful Request | - | | 404 | Workspace, Submission or Workflow not found | - | | 500 | Internal Error | - |

WorkflowMetadata

WorkflowMetadata(workspace.namespace, workspace.name, submission.id, workflow.id, include.key=var.include.key, exclude.key=var.exclude.key, expand.sub.workflows=FALSE)

Get call-level metadata for workflow

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name
var.submission.id <- 'submission.id_example' # character | Submission ID
var.workflow.id <- 'workflow.id_example' # character | Workflow ID
var.include.key <- list("inner_example") # array[character] | When specified, return only these keys in the response. Matches any key in the response, including within nested blocks. May not be used with excludeKey. 
var.exclude.key <- list("inner_example") # array[character] | When specified, omit these keys from the response. Matches any key in the response, including within nested blocks. May not be used with includeKey. 
var.expand.sub.workflows <- FALSE # character | When true, metadata for sub workflows will be fetched and inserted automatically in the metadata response. 

#Get call-level metadata for workflow
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
api.instance$WorkflowMetadata(var.workspace.namespace, var.workspace.name, var.submission.id, var.workflow.id, include.key=var.include.key, exclude.key=var.exclude.key, expand.sub.workflows=var.expand.sub.workflows)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name | submission.id | character| Submission ID | workflow.id | character| Workflow ID | include.key | list( character )| When specified, return only these keys in the response. Matches any key in the response, including within nested blocks. May not be used with excludeKey. | [optional] exclude.key | list( character )| When specified, omit these keys from the response. Matches any key in the response, including within nested blocks. May not be used with includeKey. | [optional] expand.sub.workflows | character| When true, metadata for sub workflows will be fetched and inserted automatically in the metadata response. | [optional] [default to FALSE]

void (empty response body)

googleoauth

Content-Type: Not defined
Accept: application/json

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successful Request | - | | 404 | Workspace, Submission or Workflow not found | - | | 500 | Rawls Internal Error | - |

WorkflowOutputsInSubmission

WorkflowOutputsInSubmission(workspace.namespace, workspace.name, submission.id, workflow.id)

Get workflow outputs.

library(openapi)

var.workspace.namespace <- 'workspace.namespace_example' # character | Workspace Namespace
var.workspace.name <- 'workspace.name_example' # character | Workspace Name
var.submission.id <- 'submission.id_example' # character | Submission ID
var.workflow.id <- 'workflow.id_example' # character | Workflow ID

#Get workflow outputs. 
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
api.instance$WorkflowOutputsInSubmission(var.workspace.namespace, var.workspace.name, var.submission.id, var.workflow.id)

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- workspace.namespace | character| Workspace Namespace | workspace.name | character| Workspace Name | submission.id | character| Submission ID | workflow.id | character| Workflow ID |

void (empty response body)

googleoauth

Content-Type: Not defined
Accept: Not defined

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Get workflow outputs | - | | 404 | Workspace, Submission or Workflow not found | - | | 500 | Internal Error | - |

WorkflowQueueStatus

WorkflowQueueStatusResponse WorkflowQueueStatus()

workflow queue status

List workflow counts by queueing state

library(openapi)


#workflow queue status
api.instance <- SubmissionsApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$WorkflowQueueStatus()
dput(result)

This endpoint does not need any parameter.

WorkflowQueueStatusResponse

googleoauth

Content-Type: Not defined
Accept: application/json

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successful Request | - | | 500 | Rawls Internal Error | - |

vjcitn/terraClientR documentation built on Dec. 23, 2021, 4:07 p.m.

rdrr.io home R language documentation Run R code online

CRAN packages Bioconductor packages R-Forge packages GitHub packages

Note that we can't provide technical support on individual packages. You should contact the package authors for that.

vjcitn/terraClientR R Package Client for FireCloud

docs/SubmissionsApi.md In vjcitn/terraClientR: R Package Client for FireCloud

SubmissionsApi

AbortSubmission

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CountSubmissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateSubmission

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListSubmissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

MonitorSubmission

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ValidateSubmission

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WorkflowCostInSubmission

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WorkflowMetadata

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WorkflowOutputsInSubmission

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

WorkflowQueueStatus

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

R Package Documentation

Browse R Packages

We want your feedback!

vjcitn/terraClientR
R Package Client for FireCloud

docs/SubmissionsApi.md
In vjcitn/terraClientR: R Package Client for FireCloud