Skip to content

TaskRun ​

Beta

Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.

Views and updates the runs of the scheduled or adhoc tasks that can perform automated actions.

Salaxy API v04 (beta), Finland only. 8 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.

The reference wins

These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.

GET /v04/api/task-runs ​

Performs an OData query to the search index.

ParameterInTypeRequiredDescription
$searchquerystring
$filterquerystringSpecifies the logic to pull back a subset of records.
$orderbyquerystringSpecifies the values used to sort the collection of entries.
$selectquerystringThe $select system query option allows the clients to requests a limited set of properties for each entry.
$topquerynumberSpecifies the subset of entries by count.
$skipquerynumberSpecifies the count of entries to skip.
$countquerybooleanIndicates whether or not to include a total entry count.

Response: PageResultOfTaskRunListItem

Try it: interactive reference

POST /v04/api/task-runs ​

Updates or creates a new object

Request body: TaskRun (required)

Response: TaskRun

Try it: interactive reference

GET /v04/api/task-runs/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object. The indentifier should be in format id@owner if the template is a public read-only item owned by another owner.

Response: TaskRun

Try it: interactive reference

DELETE /v04/api/task-runs/{id} ​

Deletes an object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v04/api/task-runs/new ​

Factory method that creates a new object

Response: TaskRun

Try it: interactive reference

GET /v04/api/task-runs/{id}/logs ​

Retruns log entries for the task run.

ParameterInTypeRequiredDescription
idpathstringyesId of the task run..

Response: TaskLogEntry

Try it: interactive reference

POST /v04/api/task-runs/schedule ​

Schedules a new run for the task definition. The schedule parameter of the task definition must be defined.

Request body: string (required)

Response: TaskRun

Try it: interactive reference

POST /v04/api/task-runs/start ​

Starts a new run immediately for the task definition.

Request body: string (required)

Response: TaskRun

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.