Jobs
JobsService ¶
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.
create_attachment ¶
create_attachment(
*,
name,
content=None,
source_path=None,
job_key=None,
category=None,
folder_key=None,
folder_path=None,
)
Create and upload an attachment, optionally linking it to a job.
This method handles creating an attachment from a file or memory data. If a job key is provided or available in the execution context, the attachment will be created in UiPath and linked to the job. If no job is available, the file will be saved to a temporary storage folder.
Note
The local storage functionality (when no job is available) is intended for local development and debugging purposes only.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
The name of the attachment file. |
required |
content
|
Optional[Union[str, bytes]]
|
The content to upload (string or bytes). |
None
|
source_path
|
Optional[Union[str, Path]]
|
The local path of the file to upload. |
None
|
job_key
|
Optional[Union[str, UUID]]
|
The key of the job to link the attachment to. |
None
|
category
|
Optional[str]
|
Optional category for the attachment in the context of the job. |
None
|
folder_key
|
Optional[str]
|
The key of the folder. Override the default one set in the SDK config. |
None
|
folder_path
|
Optional[str]
|
The path of the folder. Override the default one set in the SDK config. |
None
|
Returns:
Type | Description |
---|---|
UUID
|
uuid.UUID: The unique identifier for the created attachment, regardless of whether it was uploaded to UiPath or stored locally. |
Raises:
Type | Description |
---|---|
ValueError
|
If neither content nor source_path is provided, or if both are provided. |
Exception
|
If the upload fails. |
Examples:
from uipath import UiPath
client = UiPath()
# Create attachment from file and link to job
attachment_id = client.jobs.create_attachment(
name="document.pdf",
source_path="path/to/local/document.pdf",
job_key="38073051"
)
print(f"Created and linked attachment: {attachment_id}")
# Create attachment from memory content (no job available - saves to temp storage)
attachment_id = client.jobs.create_attachment(
name="report.txt",
content="This is a text report"
)
print(f"Created attachment: {attachment_id}")
create_attachment_async
async
¶
create_attachment_async(
*,
name,
content=None,
source_path=None,
job_key=None,
category=None,
folder_key=None,
folder_path=None,
)
Create and upload an attachment asynchronously, optionally linking it to a job.
This method asynchronously handles creating an attachment from a file or memory data. If a job key is provided or available in the execution context, the attachment will be created in UiPath and linked to the job. If no job is available, the file will be saved to a temporary storage folder.
Note
The local storage functionality (when no job is available) is intended for local development and debugging purposes only.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
The name of the attachment file. |
required |
content
|
Optional[Union[str, bytes]]
|
The content to upload (string or bytes). |
None
|
source_path
|
Optional[Union[str, Path]]
|
The local path of the file to upload. |
None
|
job_key
|
Optional[Union[str, UUID]]
|
The key of the job to link the attachment to. |
None
|
category
|
Optional[str]
|
Optional category for the attachment in the context of the job. |
None
|
folder_key
|
Optional[str]
|
The key of the folder. Override the default one set in the SDK config. |
None
|
folder_path
|
Optional[str]
|
The path of the folder. Override the default one set in the SDK config. |
None
|
Returns:
Type | Description |
---|---|
UUID
|
uuid.UUID: The unique identifier for the created attachment, regardless of whether it was uploaded to UiPath or stored locally. |
Raises:
Type | Description |
---|---|
ValueError
|
If neither content nor source_path is provided, or if both are provided. |
Exception
|
If the upload fails. |
Examples:
import asyncio
from uipath import UiPath
client = UiPath()
async def main():
# Create attachment from file and link to job
attachment_id = await client.jobs.create_attachment_async(
name="document.pdf",
source_path="path/to/local/document.pdf",
job_key="38073051"
)
print(f"Created and linked attachment: {attachment_id}")
# Create attachment from memory content (no job available - saves to temp storage)
attachment_id = await client.jobs.create_attachment_async(
name="report.txt",
content="This is a text report"
)
print(f"Created attachment: {attachment_id}")
link_attachment ¶
Link an attachment to a job.
This method links an existing attachment to a specific job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
attachment_key
|
UUID
|
The key of the attachment to link. |
required |
job_key
|
UUID
|
The key of the job to link the attachment to. |
required |
category
|
Optional[str]
|
Optional category for the attachment in the context of this job. |
None
|
folder_key
|
Optional[str]
|
The key of the folder. Override the default one set in the SDK config. |
None
|
folder_path
|
Optional[str]
|
The path of the folder. Override the default one set in the SDK config. |
None
|
Raises:
Type | Description |
---|---|
Exception
|
If the link operation fails. |
link_attachment_async
async
¶
link_attachment_async(
*,
attachment_key,
job_key,
category=None,
folder_key=None,
folder_path=None,
)
Link an attachment to a job asynchronously.
This method asynchronously links an existing attachment to a specific job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
attachment_key
|
UUID
|
The key of the attachment to link. |
required |
job_key
|
UUID
|
The key of the job to link the attachment to. |
required |
category
|
Optional[str]
|
Optional category for the attachment in the context of this job. |
None
|
folder_key
|
Optional[str]
|
The key of the folder. Override the default one set in the SDK config. |
None
|
folder_path
|
Optional[str]
|
The path of the folder. Override the default one set in the SDK config. |
None
|
Raises:
Type | Description |
---|---|
Exception
|
If the link operation fails. |
list_attachments ¶
List attachments associated with a specific job.
This method retrieves all attachments linked to a job by its key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
job_key
|
UUID
|
The key of the job to retrieve attachments for. |
required |
folder_key
|
Optional[str]
|
The key of the folder. Override the default one set in the SDK config. |
None
|
folder_path
|
Optional[str]
|
The path of the folder. Override the default one set in the SDK config. |
None
|
Returns:
Type | Description |
---|---|
List[str]
|
List[str]: A list of attachment IDs associated with the job. |
Raises:
Type | Description |
---|---|
Exception
|
If the retrieval fails. |
list_attachments_async
async
¶
List attachments associated with a specific job asynchronously.
This method asynchronously retrieves all attachments linked to a job by its key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
job_key
|
UUID
|
The key of the job to retrieve attachments for. |
required |
folder_key
|
Optional[str]
|
The key of the folder. Override the default one set in the SDK config. |
None
|
folder_path
|
Optional[str]
|
The path of the folder. Override the default one set in the SDK config. |
None
|
Returns:
Type | Description |
---|---|
List[str]
|
List[str]: A list of attachment IDs associated with the job. |
Raises:
Type | Description |
---|---|
Exception
|
If the retrieval fails. |
Examples:
resume ¶
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
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:
retrieve ¶
Retrieve a job identified by its key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
job_key
|
str
|
The job unique identifier. |
required |
folder_key
|
Optional[str]
|
The key of the folder in which the job was executed. |
None
|
folder_path
|
Optional[str]
|
The path of the folder in which the job was executed. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Job |
Job
|
The retrieved job. |
Examples:
retrieve_async
async
¶
Asynchronously retrieve a job identified by its key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
job_key
|
str
|
The job unique identifier. |
required |
folder_key
|
Optional[str]
|
The key of the folder in which the job was executed. |
None
|
folder_path
|
Optional[str]
|
The path of the folder in which the job was executed. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Job |
Job
|
The retrieved job. |
Examples: