ScriptExecution

Script Execution resource allows you to run a script in a runspace. The API allows you to create, cancel, and retrieve script executions.

Properties

string

script Required

Content of the script.

string

runspace_id Required

Unique identifier of the runspace where script execution is performed.

string

id Optional

Unique identifier for the object.

string

name Optional

Name of the script execution. It is optional to give a name of the script execution on create request. If name was not specified on the script execution creation, the field has null value.

OutputObjectsFormat Enum

output_objects_format Optional

Not available

Possible values are: text , json

string

reason Optional

Reason for the current script execution state. In most of the cases reason field will be empty. In case of an error or cancellation reason will contain information about the reason that caused script execution to become in this state.

string

end_time Optional

Time at which the script execution was finished. String representing time in format ISO 8601.

array of BooleanArrayScriptParameter

script_parameters Optional

List of arguments that will be passed to the script. If script content defines parameters argument can be provided. The parameter names defined in the script content should match the names specified in this list.

string

start_time Optional

Time at which the script execution was started. String representing time in format ISO 8601.

ScriptExecutionState Enum

state Optional

Not available

Possible values are: success , error , running , canceled

JSON Example

Show optional properties

{
    "runspace_id": "string",
    "script": "string"
}

{
    "end_time": "string",
    "id": "string",
    "name": "string",
    "output_objects_format": "enum",
    "reason": "string",
    "runspace_id": "string",
    "script": "string",
    "script_parameters": [
        {
            "name": "string",
            "script": "string"
        }
    ],
    "start_time": "string",
    "state": "enum"
}

Parameter To

Create Script Execution

Returned By

List Script Executions
Create Script Execution
Get Script Execution

ScriptExecution

Properties

JSON Example

Parameter To

Returned By

Was this page helpful?