Parameters
If in the request is_async is set to False the request will become a blocking operation. The client will not
receive a response from LSO until the executable has completed. The response then contains the output from the
executable. With is_async set to True, LSO will immediately give a response containing only the job ID. To get the
output from the excutable once completed, a callback URL must be included in the request.
Request
When posting to the API endpoint to start an executable, the following attributes can be set.
Bases: BaseModel
Request parameters for running an arbitrary executable.
Attributes:
| Name | Type | Description |
|---|---|---|
executable_name |
ExecutableName
|
The absolute path to the executable. |
args |
list[str]
|
A list of arguments that is provided to the script. |
callback |
HttpUrl
|
A callback URL where the execution result of the script is posted to. |
is_async |
bool
|
Whether this script should be executed asynchronously. |
Response
Once the API request is received, it returns a response that contains the following attributes.
Bases: BaseModel
Response for running an arbitrary executable.
Attributes:
| Name | Type | Description |
|---|---|---|
job_id |
UUID
|
Unique identifier for the executable run. |
result |
ExecutionResult
|
Executable result if the request was made with |