Data API — Scripts

12 min

scripts_list

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET, include_archived: bool | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ScriptListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET
include_archived	bool \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[ScriptListItemResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

script_archive

sync(name: str, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
name	str	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

script_describe

sync(name: str, version: str, client: AuthenticatedClient | Client) -> ProblemDetails | ScriptResponse | list[ErrorResponse] | None

Parameter	Type	Default
name	str	required
version	str	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | ScriptResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

script_publish

sync(client: AuthenticatedClient | Client, body: ScriptPublishFilesBody | ScriptPublishJsonBody | Unset = UNSET) -> IActionResult | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	ScriptPublishFilesBody \| ScriptPublishJsonBody \| Unset	UNSET

Returns: IActionResult | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

script_queue

sync(name: str, version: str, client: AuthenticatedClient | Client, body: ScriptQueueBodyRequest | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
name	str	required
version	str	required
client	AuthenticatedClient \| Client	required
body	ScriptQueueBodyRequest \| Unset	UNSET

body — Request body for enqueuing a script job (excludes script and version, which are provided via route).

Returns: ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

script_unarchive

sync(name: str, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
name	str	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.