Get Machine Sessions by Key

Overview

<uipath-connector:sessions-get-machine-sessions-by-key>

• OAuth required scopes: OR.Robots or OR.Robots.Read
• Required permissions: Machines.View

This operation makes an HTTP GET request to the /odata/Sessions/UiPath.Server.Configuration.OData.GetMachineSessions(key= {key}) endpoint.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		Yes
key	Number	key		Yes
$expand	String	Indicates the related entities to be represented inline. The maximum depth is 2.
$top	Number	Limits the number of items returned from a collection. The maximum value is 1000.
$count	Boolean	Indicates whether the total count of items within a collection are returned in the result.	false
$orderby	String	Specifies the order in which items are returned. The maximum number of expressions is 5.
$filter	String	Restricts the set of items returned. The maximum number of expressions is 100.
$select	String	Limits the properties returned in the result.
$skip	Number	Excludes the specified number of items of the queried collection from the result.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component.		Yes
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure if repeatable streams should be used and their behaviour.
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for request to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout.
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.
Target Variable	String	The name of a variable on which the operation’s output is placed.
Target Value	String	An expression that is evaluated against the operation’s output and the outcome of that expression is stored in the target variable.	# [payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Output

Type	Attributes Type
Any	Http Response Attributes

See Configuration parameters.

Throws

• UIPATH-CONNECTOR:BAD_REQUEST
• UIPATH-CONNECTOR:CLIENT_ERROR
• UIPATH-CONNECTOR:CONNECTIVITY
• UIPATH-CONNECTOR:INTERNAL_SERVER_ERROR
• UIPATH-CONNECTOR:NOT_ACCEPTABLE
• UIPATH-CONNECTOR:NOT_FOUND
• UIPATH-CONNECTOR:RETRY_EXHAUSTED
• UIPATH-CONNECTOR:SERVER_ERROR
• UIPATH-CONNECTOR:SERVICE_UNAVAILABLE
• UIPATH-CONNECTOR:TIMEOUT
• UIPATH-CONNECTOR:TOO_MANY_REQUESTS
• UIPATH-CONNECTOR:UNAUTHORIZED
• UIPATH-CONNECTOR:UNSUPPORTED_MEDIA_TYPE