Connections
ConnectionsService ¶
Service for managing UiPath external service connections.
This service provides methods to retrieve direct connection information retrieval and secure token management.
list ¶
Lists all connections with optional filtering.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
Optional[str]
|
Optional connection name to filter (supports partial matching) |
None
|
folder_path
|
Optional[str]
|
Optional folder path for filtering connections |
None
|
folder_key
|
Optional[str]
|
Optional folder key (mutually exclusive with folder_path) |
None
|
connector_key
|
Optional[str]
|
Optional connector key to filter by specific connector type |
None
|
skip
|
Optional[int]
|
Number of records to skip (for pagination) |
None
|
top
|
Optional[int]
|
Maximum number of records to return |
None
|
Returns:
Type | Description |
---|---|
List[Connection]
|
List[Connection]: List of connection instances |
Raises:
Type | Description |
---|---|
ValueError
|
If both folder_path and folder_key are provided together, or if folder_path is provided but cannot be resolved to a folder_key |
Examples:
list_async
async
¶
list_async(
*,
name=None,
folder_path=None,
folder_key=None,
connector_key=None,
skip=None,
top=None,
)
Asynchronously lists all connections with optional filtering.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
Optional[str]
|
Optional connection name to filter (supports partial matching) |
None
|
folder_path
|
Optional[str]
|
Optional folder path for filtering connections |
None
|
folder_key
|
Optional[str]
|
Optional folder key (mutually exclusive with folder_path) |
None
|
connector_key
|
Optional[str]
|
Optional connector key to filter by specific connector type |
None
|
skip
|
Optional[int]
|
Number of records to skip (for pagination) |
None
|
top
|
Optional[int]
|
Maximum number of records to return |
None
|
Returns:
Type | Description |
---|---|
List[Connection]
|
List[Connection]: List of connection instances |
Raises:
Type | Description |
---|---|
ValueError
|
If both folder_path and folder_key are provided together, or if folder_path is provided but cannot be resolved to a folder_key |
Examples:
retrieve ¶
Retrieve connection details by its key.
This method fetches the configuration and metadata for a connection, which can be used to establish communication with an external service.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
The unique identifier of the connection to retrieve. |
required |
Returns:
Name | Type | Description |
---|---|---|
Connection |
Connection
|
The connection details, including configuration parameters and authentication information. |
retrieve_async
async
¶
Asynchronously retrieve connection details by its key.
This method fetches the configuration and metadata for a connection, which can be used to establish communication with an external service.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
The unique identifier of the connection to retrieve. |
required |
Returns:
Name | Type | Description |
---|---|---|
Connection |
Connection
|
The connection details, including configuration parameters and authentication information. |
retrieve_event_payload ¶
Retrieve event payload from UiPath Integration Service.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event_args
|
EventArguments
|
The event arguments. Should be passed along from the job's input. |
required |
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Dict[str, Any]: The event payload data |
retrieve_event_payload_async
async
¶
Retrieve event payload from UiPath Integration Service.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event_args
|
EventArguments
|
The event arguments. Should be passed along from the job's input. |
required |
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
Dict[str, Any]: The event payload data |
retrieve_token ¶
Retrieve an authentication token for a connection.
This method obtains a fresh authentication token that can be used to communicate with the external service. This is particularly useful for services that use token-based authentication.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
The unique identifier of the connection. |
required |
token_type
|
ConnectionTokenType
|
The token type to use. |
DIRECT
|
Returns:
Name | Type | Description |
---|---|---|
ConnectionToken |
ConnectionToken
|
The authentication token details, including the token value and any associated metadata. |
retrieve_token_async
async
¶
Asynchronously retrieve an authentication token for a connection.
This method obtains a fresh authentication token that can be used to communicate with the external service. This is particularly useful for services that use token-based authentication.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
The unique identifier of the connection. |
required |
token_type
|
ConnectionTokenType
|
The token type to use. |
DIRECT
|
Returns:
Name | Type | Description |
---|---|---|
ConnectionToken |
ConnectionToken
|
The authentication token details, including the token value and any associated metadata. |