API docs by Redocly

Altair SLC Hub Batch jobs

Download OpenAPI specification:Download

Queries current job instances

Authorizations:
bearerAuth
query Parameters
filter[id][EQ]
string
filter[id][IN]
string
filter[namespace][EQ]
string
filter[namespace][IN]
Array of strings
filter[name][EQ]
string
filter[name][CO]
string
filter[task.type][EQ]
string
filter[created][LT]
string <date-time>
filter[created][GT]
string <date-time>
filter[startedAt][LT]
string <date-time>
filter[startedAt][GT]
string <date-time>
filter[finishedAt][LT]
string <date-time>
filter[finishedAt][GT]
string <date-time>
filter[state][EQ]
string (jobState)
Enum: "Creating" "Pending" "Executing" "Cancelled" "CompletedSuccess" "CompletedError" "Failed"
filter[state][IN]
Array of strings (jobState)
Items Enum: "Creating" "Pending" "Executing" "Cancelled" "CompletedSuccess" "CompletedError" "Failed"
filter[ownerPrincipal][EQ]
string
filter[exitCode][EQ]
int
filter[exitCode][NE]
int
filter[exitCode][LT]
int
filter[exitCode][GT]
int
page[offset]
integer
page[limit]
integer
sort
string
Enum: "created" "-created" "name" "-name" "id" "-id"
filter[executionNodeName][EQ]
string
filter[executionNodeId][EQ]
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Creates a new job

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
namespace
required
string
name
string
created
string <date-time>
ownerPrincipal
string
required
any (taskDef)
object (jobOutputs)
executionProfileId
required
string
object (jobStatus)
cancelled
boolean
emailPolicy
string (jobEmailPolicy)
Enum: "ALWAYS" "NEVER" "ONFAILURE"
submissionHost
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "namespace": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "ownerPrincipal": "string",
  • "task": {
    },
  • "outputs": {
    },
  • "executionProfileId": "string",
  • "status": {
    },
  • "cancelled": true,
  • "emailPolicy": "ALWAYS",
  • "submissionHost": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "namespace": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "ownerPrincipal": "string",
  • "task": {
    },
  • "outputs": {
    },
  • "executionProfileId": "string",
  • "status": {
    },
  • "cancelled": true,
  • "emailPolicy": "ALWAYS",
  • "submissionHost": "string"
}

Returns the count of jobs in each state

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Returns the given job

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "namespace": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "ownerPrincipal": "string",
  • "task": {
    },
  • "outputs": {
    },
  • "executionProfileId": "string",
  • "status": {
    },
  • "cancelled": true,
  • "emailPolicy": "ALWAYS",
  • "submissionHost": "string"
}

Deletes the given job. Note that the job must be in a terminal state

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

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

Completes creation of a job.

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

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

Returns the current status of a given job by ID

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

Content type
application/json
{
  • "state": "Creating",
  • "pendingReason": "string",
  • "failureReason": "string",
  • "exitCode": 0,
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "executionNodeName": "string",
  • "executionNodeId": "string",
  • "events": [
    ]
}

Returns a list of the results generated by the given job

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of the stdout/stderr logs generated by the given job

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns the standard output or standard error log from execution of a given job.

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

logType
required
string
Enum: "stdout" "stderr"

Type of log to return

Responses

Response samples

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

Returns the content of the given result

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

resultName
required
string

Name of the result

Responses

Response samples

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

Returns info for the given result

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

resultName
required
string

Name of the result

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "contentType": "string",
  • "size": 0
}

Returns a zip file containing all of the output of the job

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

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

Uploads content to be saved as a job input

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

inputName
required
string

Name of the input

Responses

Response samples

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

Requests cancellation of a job

Authorizations:
bearerAuth
path Parameters
jobId
required
string

ID of the job

Responses

Response samples

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