Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/windmill/windmill-api/JobApi.md

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Go to Latest
File

.JobApi

All URIs are relative to /api

Method HTTP request Description
cancelQueuedJob POST /w/{workspace}/jobs/queue/cancel/{id} cancel queued job
cancelSuspendedJobGet GET /w/{workspace}/jobs/cancel/{id}/{resume_id}/{signature} cancel a job for a suspended flow
cancelSuspendedJobPost POST /w/{workspace}/jobs/cancel/{id}/{resume_id}/{signature} cancel a job for a suspended flow
createJobSignature GET /w/{workspace}/jobs/job_signature/{id}/{resume_id} create an HMac signature given a job id and a resume id
deleteCompletedJob POST /w/{workspace}/jobs/completed/delete/{id} delete completed job (erase content but keep run id)
getCompletedJob GET /w/{workspace}/jobs/completed/get/{id} get completed job
getJob GET /w/{workspace}/jobs/get/{id} get job
getJobUpdates GET /w/{workspace}/jobs/getupdate/{id} get job updates
listCompletedJobs GET /w/{workspace}/jobs/completed/list list all available completed jobs
listJobs GET /w/{workspace}/jobs/list list all available jobs
listQueue GET /w/{workspace}/jobs/queue/list list all available queued jobs
resumeSuspendedJobGet GET /w/{workspace}/jobs/resume/{id}/{resume_id}/{signature} resume a job for a suspended flow
resumeSuspendedJobPost POST /w/{workspace}/jobs/resume/{id}/{resume_id}/{signature} resume a job for a suspended flow
runFlowByPath POST /w/{workspace}/jobs/run/f/{path} run flow by path
runFlowPreview POST /w/{workspace}/jobs/run/preview_flow run flow preview
runScriptByHash POST /w/{workspace}/jobs/run/h/{hash} run script by hash
runScriptByPath POST /w/{workspace}/jobs/run/p/{path} run script by path
runScriptPreview POST /w/{workspace}/jobs/run/preview run script preview
runWaitResultScriptByPath POST /w/{workspace}/jobs/run_wait_result/p/{path} run script by path

cancelQueuedJob

string cancelQueuedJob(inlineObject16)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiCancelQueuedJobRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
  // InlineObject16
  inlineObject16: {
    reason: "reason_example",
  },
};

apiInstance.cancelQueuedJob(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
inlineObject16 InlineObject16
workspace [string] defaults to undefined
id [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 job canceled -

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

cancelSuspendedJobGet

string cancelSuspendedJobGet()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiCancelSuspendedJobGetRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
  // number
  resumeId: 1,
  // string
  signature: "signature_example",
  // any (optional)
  payload: {},
};

apiInstance.cancelSuspendedJobGet(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
id [string] defaults to undefined
resumeId [number] defaults to undefined
signature [string] defaults to undefined
payload any (optional) defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 job resumed -

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

cancelSuspendedJobPost

string cancelSuspendedJobPost()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiCancelSuspendedJobPostRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
  // number
  resumeId: 1,
  // string
  signature: "signature_example",
  // any (optional)
  body: {},
};

apiInstance.cancelSuspendedJobPost(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
body any
workspace [string] defaults to undefined
id [string] defaults to undefined
resumeId [number] defaults to undefined
signature [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 job resumed -

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

createJobSignature

string createJobSignature()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiCreateJobSignatureRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
  // number
  resumeId: 1,
};

apiInstance.createJobSignature(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
id [string] defaults to undefined
resumeId [number] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 job signature -

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

deleteCompletedJob

CompletedJob deleteCompletedJob()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiDeleteCompletedJobRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
};

apiInstance.deleteCompletedJob(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
id [string] defaults to undefined

Return type

CompletedJob

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 job details -

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

getCompletedJob

CompletedJob getCompletedJob()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiGetCompletedJobRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
};

apiInstance.getCompletedJob(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
id [string] defaults to undefined

Return type

CompletedJob

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 job details -

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

getJob

Job getJob()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiGetJobRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
};

apiInstance.getJob(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
id [string] defaults to undefined

Return type

Job

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 job details -

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

getJobUpdates

InlineResponse2006 getJobUpdates()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiGetJobUpdatesRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
  // boolean (optional)
  running: true,
  // number (optional)
  logOffset: 1,
};

apiInstance.getJobUpdates(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
id [string] defaults to undefined
running [boolean] (optional) defaults to undefined
logOffset [number] (optional) defaults to undefined

Return type

InlineResponse2006

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 job details -

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

listCompletedJobs

Array listCompletedJobs()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiListCompletedJobsRequest = {
  // string
  workspace: "workspace_example",
  // boolean | order by desc order (default true) (optional)
  orderDesc: true,
  // string | mask to filter exact matching user creator (optional)
  createdBy: "created_by_example",
  // string | The parent job that is at the origin and responsible for the execution of this script if any (optional)
  parentJob: "parent_job_example",
  // string | mask to filter exact matching path (optional)
  scriptPathExact: "script_path_exact_example",
  // string | mask to filter matching starting path (optional)
  scriptPathStart: "script_path_start_example",
  // string | mask to filter exact matching path (optional)
  scriptHash: "script_hash_example",
  // Date | filter on created before (inclusive) timestamp (optional)
  createdBefore: new Date('1970-01-01T00:00:00.00Z'),
  // Date | filter on created after (exclusive) timestamp (optional)
  createdAfter: new Date('1970-01-01T00:00:00.00Z'),
  // boolean | filter on successful jobs (optional)
  success: true,
  // string | filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, (optional)
  jobKinds: "job_kinds_example",
  // boolean | is the job skipped (optional)
  isSkipped: true,
  // boolean | is the job a flow step (optional)
  isFlowStep: true,
};

apiInstance.listCompletedJobs(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
orderDesc [boolean] order by desc order (default true) (optional) defaults to undefined
createdBy [string] mask to filter exact matching user creator (optional) defaults to undefined
parentJob [string] The parent job that is at the origin and responsible for the execution of this script if any (optional) defaults to undefined
scriptPathExact [string] mask to filter exact matching path (optional) defaults to undefined
scriptPathStart [string] mask to filter matching starting path (optional) defaults to undefined
scriptHash [string] mask to filter exact matching path (optional) defaults to undefined
createdBefore [Date] filter on created before (inclusive) timestamp (optional) defaults to undefined
createdAfter [Date] filter on created after (exclusive) timestamp (optional) defaults to undefined
success [boolean] filter on successful jobs (optional) defaults to undefined
jobKinds [string] filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, (optional) defaults to undefined
isSkipped [boolean] is the job skipped (optional) defaults to undefined
isFlowStep [boolean] is the job a flow step (optional) defaults to undefined

Return type

Array

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 All available completed jobs -

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

listJobs

Array listJobs()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiListJobsRequest = {
  // string
  workspace: "workspace_example",
  // string | mask to filter exact matching user creator (optional)
  createdBy: "created_by_example",
  // string | The parent job that is at the origin and responsible for the execution of this script if any (optional)
  parentJob: "parent_job_example",
  // string | mask to filter exact matching path (optional)
  scriptPathExact: "script_path_exact_example",
  // string | mask to filter matching starting path (optional)
  scriptPathStart: "script_path_start_example",
  // string | mask to filter exact matching path (optional)
  scriptHash: "script_hash_example",
  // Date | filter on created before (inclusive) timestamp (optional)
  createdBefore: new Date('1970-01-01T00:00:00.00Z'),
  // Date | filter on created after (exclusive) timestamp (optional)
  createdAfter: new Date('1970-01-01T00:00:00.00Z'),
  // string | filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, (optional)
  jobKinds: "job_kinds_example",
  // boolean | is the job skipped (optional)
  isSkipped: true,
  // boolean | is the job a flow step (optional)
  isFlowStep: true,
  // boolean | filter on successful jobs (optional)
  success: true,
};

apiInstance.listJobs(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
createdBy [string] mask to filter exact matching user creator (optional) defaults to undefined
parentJob [string] The parent job that is at the origin and responsible for the execution of this script if any (optional) defaults to undefined
scriptPathExact [string] mask to filter exact matching path (optional) defaults to undefined
scriptPathStart [string] mask to filter matching starting path (optional) defaults to undefined
scriptHash [string] mask to filter exact matching path (optional) defaults to undefined
createdBefore [Date] filter on created before (inclusive) timestamp (optional) defaults to undefined
createdAfter [Date] filter on created after (exclusive) timestamp (optional) defaults to undefined
jobKinds [string] filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, (optional) defaults to undefined
isSkipped [boolean] is the job skipped (optional) defaults to undefined
isFlowStep [boolean] is the job a flow step (optional) defaults to undefined
success [boolean] filter on successful jobs (optional) defaults to undefined

Return type

Array

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 All jobs -

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

listQueue

Array listQueue()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiListQueueRequest = {
  // string
  workspace: "workspace_example",
  // boolean | order by desc order (default true) (optional)
  orderDesc: true,
  // string | mask to filter exact matching user creator (optional)
  createdBy: "created_by_example",
  // string | The parent job that is at the origin and responsible for the execution of this script if any (optional)
  parentJob: "parent_job_example",
  // string | mask to filter exact matching path (optional)
  scriptPathExact: "script_path_exact_example",
  // string | mask to filter matching starting path (optional)
  scriptPathStart: "script_path_start_example",
  // string | mask to filter exact matching path (optional)
  scriptHash: "script_hash_example",
  // Date | filter on created before (inclusive) timestamp (optional)
  createdBefore: new Date('1970-01-01T00:00:00.00Z'),
  // Date | filter on created after (exclusive) timestamp (optional)
  createdAfter: new Date('1970-01-01T00:00:00.00Z'),
  // boolean | filter on successful jobs (optional)
  success: true,
  // string | filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, (optional)
  jobKinds: "job_kinds_example",
};

apiInstance.listQueue(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
orderDesc [boolean] order by desc order (default true) (optional) defaults to undefined
createdBy [string] mask to filter exact matching user creator (optional) defaults to undefined
parentJob [string] The parent job that is at the origin and responsible for the execution of this script if any (optional) defaults to undefined
scriptPathExact [string] mask to filter exact matching path (optional) defaults to undefined
scriptPathStart [string] mask to filter matching starting path (optional) defaults to undefined
scriptHash [string] mask to filter exact matching path (optional) defaults to undefined
createdBefore [Date] filter on created before (inclusive) timestamp (optional) defaults to undefined
createdAfter [Date] filter on created after (exclusive) timestamp (optional) defaults to undefined
success [boolean] filter on successful jobs (optional) defaults to undefined
jobKinds [string] filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by, (optional) defaults to undefined

Return type

Array

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 All available queued jobs -

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

resumeSuspendedJobGet

string resumeSuspendedJobGet()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiResumeSuspendedJobGetRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
  // number
  resumeId: 1,
  // string
  signature: "signature_example",
  // any (optional)
  payload: {},
};

apiInstance.resumeSuspendedJobGet(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
id [string] defaults to undefined
resumeId [number] defaults to undefined
signature [string] defaults to undefined
payload any (optional) defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 job resumed -

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

resumeSuspendedJobPost

string resumeSuspendedJobPost()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiResumeSuspendedJobPostRequest = {
  // string
  workspace: "workspace_example",
  // string
  id: "id_example",
  // number
  resumeId: 1,
  // string
  signature: "signature_example",
  // any (optional)
  body: {},
};

apiInstance.resumeSuspendedJobPost(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
body any
workspace [string] defaults to undefined
id [string] defaults to undefined
resumeId [number] defaults to undefined
signature [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 job resumed -

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

runFlowByPath

string runFlowByPath(requestBody)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiRunFlowByPathRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
  // { [key: string]: any; } | flow args
  requestBody: {
    "key": null,
  },
  // Date | when to schedule this job (leave empty for immediate run) (optional)
  scheduledFor: new Date('1970-01-01T00:00:00.00Z'),
  // number | schedule the script to execute in the number of seconds starting now (optional)
  scheduledInSecs: 1,
  // string | The parent job that is at the origin and responsible for the execution of this script if any (optional)
  parentJob: "parent_job_example",
};

apiInstance.runFlowByPath(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
requestBody { [key: string]: any; } flow args
workspace [string] defaults to undefined
path [string] defaults to undefined
scheduledFor [Date] when to schedule this job (leave empty for immediate run) (optional) defaults to undefined
scheduledInSecs [number] schedule the script to execute in the number of seconds starting now (optional) defaults to undefined
parentJob [string] The parent job that is at the origin and responsible for the execution of this script if any (optional) defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 job created -

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

runFlowPreview

string runFlowPreview(flowPreview)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiRunFlowPreviewRequest = {
  // string
  workspace: "workspace_example",
  // FlowPreview | preview
  flowPreview: {
    value: {
      modules: [
        {
          inputTransforms: {
            "key": null,
          },
          value: null,
          stopAfterIf: {
            skipIfStopped: true,
            expr: "expr_example",
          },
          sleep: null,
          summary: "summary_example",
          suspend: {
            requiredEvents: 1,
            timeout: 1,
          },
          retry: {
            constant: {
              attempts: 1,
              seconds: 1,
            },
            exponential: {
              attempts: 1,
              multiplier: 1,
              seconds: 1,
            },
          },
        },
      ],
      failureModule: {
        inputTransforms: {
          "key": null,
        },
        value: null,
        stopAfterIf: {
          skipIfStopped: true,
          expr: "expr_example",
        },
        sleep: null,
        summary: "summary_example",
        suspend: {
          requiredEvents: 1,
          timeout: 1,
        },
        retry: {
          constant: {
            attempts: 1,
            seconds: 1,
          },
          exponential: {
            attempts: 1,
            multiplier: 1,
            seconds: 1,
          },
        },
      },
      sameWorker: true,
    },
    path: "path_example",
    args: {
      "key": null,
    },
  },
};

apiInstance.runFlowPreview(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
flowPreview FlowPreview preview
workspace [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 job created -

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

runScriptByHash

string runScriptByHash(body)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiRunScriptByHashRequest = {
  // string
  workspace: "workspace_example",
  // string
  hash: "hash_example",
  // any | Partially filled args
  body: {},
  // Date | when to schedule this job (leave empty for immediate run) (optional)
  scheduledFor: new Date('1970-01-01T00:00:00.00Z'),
  // number | schedule the script to execute in the number of seconds starting now (optional)
  scheduledInSecs: 1,
  // string | The parent job that is at the origin and responsible for the execution of this script if any (optional)
  parentJob: "parent_job_example",
};

apiInstance.runScriptByHash(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
body any Partially filled args
workspace [string] defaults to undefined
hash [string] defaults to undefined
scheduledFor [Date] when to schedule this job (leave empty for immediate run) (optional) defaults to undefined
scheduledInSecs [number] schedule the script to execute in the number of seconds starting now (optional) defaults to undefined
parentJob [string] The parent job that is at the origin and responsible for the execution of this script if any (optional) defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 job created -

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

runScriptByPath

string runScriptByPath(requestBody)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiRunScriptByPathRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
  // { [key: string]: any; } | script args
  requestBody: {
    "key": null,
  },
  // Date | when to schedule this job (leave empty for immediate run) (optional)
  scheduledFor: new Date('1970-01-01T00:00:00.00Z'),
  // number | schedule the script to execute in the number of seconds starting now (optional)
  scheduledInSecs: 1,
  // string | The parent job that is at the origin and responsible for the execution of this script if any (optional)
  parentJob: "parent_job_example",
};

apiInstance.runScriptByPath(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
requestBody { [key: string]: any; } script args
workspace [string] defaults to undefined
path [string] defaults to undefined
scheduledFor [Date] when to schedule this job (leave empty for immediate run) (optional) defaults to undefined
scheduledInSecs [number] schedule the script to execute in the number of seconds starting now (optional) defaults to undefined
parentJob [string] The parent job that is at the origin and responsible for the execution of this script if any (optional) defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 job created -

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

runScriptPreview

string runScriptPreview(preview)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiRunScriptPreviewRequest = {
  // string
  workspace: "workspace_example",
  // Preview | preview
  preview: {
    content: "content_example",
    path: "path_example",
    args: {
      "key": null,
    },
    language: "python3",
  },
};

apiInstance.runScriptPreview(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
preview Preview preview
workspace [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 job created -

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

runWaitResultScriptByPath

any runWaitResultScriptByPath(requestBody)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .JobApi(configuration);

let body:.JobApiRunWaitResultScriptByPathRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
  // { [key: string]: any; } | script args
  requestBody: {
    "key": null,
  },
  // Date | when to schedule this job (leave empty for immediate run) (optional)
  scheduledFor: new Date('1970-01-01T00:00:00.00Z'),
  // number | schedule the script to execute in the number of seconds starting now (optional)
  scheduledInSecs: 1,
  // string | The parent job that is at the origin and responsible for the execution of this script if any (optional)
  parentJob: "parent_job_example",
};

apiInstance.runWaitResultScriptByPath(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
requestBody { [key: string]: any; } script args
workspace [string] defaults to undefined
path [string] defaults to undefined
scheduledFor [Date] when to schedule this job (leave empty for immediate run) (optional) defaults to undefined
scheduledInSecs [number] schedule the script to execute in the number of seconds starting now (optional) defaults to undefined
parentJob [string] The parent job that is at the origin and responsible for the execution of this script if any (optional) defaults to undefined

Return type

any

Authorization

bearerAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 job result -

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