Jobs

JobsService

Bases: FolderContext, BaseService

Service for managing API payloads and job inbox interactions.

A job represents a single execution of an automation - it is created when you start a process and contains information about that specific run, including its status, start time, and any input/output data.

resume(*, inbox_id=None, job_id=None, folder_key=None, folder_path=None, payload)

resume(*, inbox_id: str, payload: Any) -> None

resume(*, job_id: str, payload: Any) -> None

Sends a payload to resume a paused job waiting for input, identified by its inbox ID.

Parameters:

Name	Type	Description	Default
inbox_id	Optional[str]	The inbox ID of the job.	None
job_id	Optional[str]	The job ID of the job.	None
folder_key	Optional[str]	The key of the folder to execute the process in. Override the default one set in the SDK config.	None
folder_path	Optional[str]	The path of the folder to execute the process in. Override the default one set in the SDK config.	None
payload	Any	The payload to deliver.	required

resume_async(*, inbox_id=None, job_id=None, folder_key=None, folder_path=None, payload) async

Asynchronously sends a payload to resume a paused job waiting for input, identified by its inbox ID.

Parameters:

Name	Type	Description	Default
inbox_id	Optional[str]	The inbox ID of the job. If not provided, the execution context will be used to retrieve the inbox ID.	None
job_id	Optional[str]	The job ID of the job.	None
folder_key	Optional[str]	The key of the folder to execute the process in. Override the default one set in the SDK config.	None
folder_path	Optional[str]	The path of the folder to execute the process in. Override the default one set in the SDK config.	None
payload	Any	The payload to deliver.	required

Examples:

import asyncio

from uipath import UiPath

sdk = UiPath()


async def main():  # noqa: D103
    payload = await sdk.jobs.resume_async(job_id="38073051", payload="The response")
    print(payload)


asyncio.run(main())