Skip to content

RunApi.md

Latest commit

 

History

History
317 lines (219 loc) · 9.62 KB

RunApi.md

File metadata and controls

317 lines (219 loc) · 9.62 KB
Raw

RunApi

All URIs are relative to http://localhost:8080

Method HTTP request Description
deleteRun DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} Delete a run
getRun GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} Get the details of a run
getRunLogs GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs get the logs for the Run
getRunStatus GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status get the status for the Run
listRuns GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs get the list of Runs for the Runner

deleteRun

deleteRun()

Example

import {
    RunApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunApi(configuration);

let organizationId: string; //The Organization identifier (default to undefined)
let workspaceId: string; //The Workspace identifier (default to undefined)
let runnerId: string; //The Runner identifier (default to undefined)
let runId: string; //The Run identifier (default to undefined)

const { status, data } = await apiInstance.deleteRun(
    organizationId,
    workspaceId,
    runnerId,
    runId
);

Parameters

Name Type Description Notes
organizationId [string] The Organization identifier defaults to undefined
workspaceId [string] The Workspace identifier defaults to undefined
runnerId [string] The Runner identifier defaults to undefined
runId [string] The Run identifier defaults to undefined

Return type

void (empty response body)

Authorization

oAuth2AuthCode

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Request succeeded -
400 Bad request -
404 the Run specified is unknown or you don't have access to it -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRun

Run getRun()

Retrieve detailed information about a specific run.

Example

import {
    RunApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunApi(configuration);

let organizationId: string; //The Organization identifier (default to undefined)
let workspaceId: string; //The Workspace identifier (default to undefined)
let runnerId: string; //The Runner identifier (default to undefined)
let runId: string; //The Run identifier (default to undefined)

const { status, data } = await apiInstance.getRun(
    organizationId,
    workspaceId,
    runnerId,
    runId
);

Parameters

Name Type Description Notes
organizationId [string] The Organization identifier defaults to undefined
workspaceId [string] The Workspace identifier defaults to undefined
runnerId [string] The Runner identifier defaults to undefined
runId [string] The Run identifier defaults to undefined

Return type

Run

Authorization

oAuth2AuthCode

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml

HTTP response details

Status code Description Response headers
200 the Run details -
404 the Run specified is unknown or you don't have access to it -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRunLogs

string getRunLogs()

Retrieve execution logs for a run as plain text. Logs are aggregated from all containers. May be truncated for long-running simulations.

Example

import {
    RunApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunApi(configuration);

let organizationId: string; //The Organization identifier (default to undefined)
let workspaceId: string; //The Workspace identifier (default to undefined)
let runnerId: string; //The Runner identifier (default to undefined)
let runId: string; //The Run identifier (default to undefined)

const { status, data } = await apiInstance.getRunLogs(
    organizationId,
    workspaceId,
    runnerId,
    runId
);

Parameters

Name Type Description Notes
organizationId [string] The Organization identifier defaults to undefined
workspaceId [string] The Workspace identifier defaults to undefined
runnerId [string] The Runner identifier defaults to undefined
runId [string] The Run identifier defaults to undefined

Return type

string

Authorization

oAuth2AuthCode

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 the run logs details -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRunStatus

RunStatus getRunStatus()

Retrieve detailed execution status of a run.

Example

import {
    RunApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunApi(configuration);

let organizationId: string; //The Organization identifier (default to undefined)
let workspaceId: string; //The Workspace identifier (default to undefined)
let runnerId: string; //The Runner identifier (default to undefined)
let runId: string; //The Run identifier (default to undefined)

const { status, data } = await apiInstance.getRunStatus(
    organizationId,
    workspaceId,
    runnerId,
    runId
);

Parameters

Name Type Description Notes
organizationId [string] The Organization identifier defaults to undefined
workspaceId [string] The Workspace identifier defaults to undefined
runnerId [string] The Runner identifier defaults to undefined
runId [string] The Run identifier defaults to undefined

Return type

RunStatus

Authorization

oAuth2AuthCode

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml

HTTP response details

Status code Description Response headers
200 the run status details -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listRuns

Array listRuns()

Retrieve a paginated list of all runs for a specific runner.

Example

import {
    RunApi,
    Configuration
} from '@cosmotech/api-ts';

const configuration = new Configuration();
const apiInstance = new RunApi(configuration);

let organizationId: string; //The Organization identifier (default to undefined)
let workspaceId: string; //The Workspace identifier (default to undefined)
let runnerId: string; //The Runner identifier (default to undefined)
let page: number; //page number to query (first page is at index 0) (optional) (default to undefined)
let size: number; //amount of result by page (optional) (default to undefined)

const { status, data } = await apiInstance.listRuns(
    organizationId,
    workspaceId,
    runnerId,
    page,
    size
);

Parameters

Name Type Description Notes
organizationId [string] The Organization identifier defaults to undefined
workspaceId [string] The Workspace identifier defaults to undefined
runnerId [string] The Runner identifier defaults to undefined
page [number] page number to query (first page is at index 0) (optional) defaults to undefined
size [number] amount of result by page (optional) defaults to undefined

Return type

Array

Authorization

oAuth2AuthCode

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml

HTTP response details

Status code Description Response headers
200 the run details list -

[Back to top] [Back to API list] [Back to Model list] [Back to README]