Taskrunstatus#

class fews_py_wrapper._api.endpoints.Taskrunstatus[source]#
static endpoint_function(*, client, task_id, max_wait_millis=<fews_openapi_py_client.types.Unset object>, document_format=<fews_openapi_py_client.types.Unset object>, document_version=<fews_openapi_py_client.types.Unset object>)#

Track the status of a workflow using the taskId, typically used to determine if a taskrun is completed

Track the status of a workflow using the taskId, typically used to determine if a taskrun is

completed.<p>Possible response codes are:<ul><li>I = Invalid<li>P = Pending</li><li>T = Terminated<li>R = running</li><li>F = Failed</li><li>C = Completed fully successful</li><li>D = Completed partly successful</li><li>A = Approved</li><li>B = Approved partly successful</li><li>null = No status available (produces when method call times-out)</li></ul>

Parameters:

  • task_id (str)

  • max_wait_millis (str | Unset)

  • document_format (TaskrunstatusDocumentFormat | Unset)

  • document_version (str | Unset)

  • client (AuthenticatedClient | Client)

Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Any]

Return type:

Response[Any]

execute(*, client, **kwargs)[source]#

Execute the API endpoint call.

Parameters:

  • client (AuthenticatedClient | Client) – AuthenticatedClient or Client instance for API calls.

  • document_format – Format of the returned document.

  • **kwargs (Any) – Keyword arguments for the API call.

Returns:

Parsed response content based on the returned content type.

Return type:

dict[str, Any]