## UiPath Integrations Overview

Upon creation of a new project a number of integrations related to UiPath will be added your project. These are across two different base URL:

### Humley UIPath 1.0

|Integration Name | Description |
|--|--|
| GET Get Job State | Retrieves the state of a specified job |
| GET Get Queue Item State | Retrieves the state of a specific queue item |
| GET Get Robot State | Retrieves the state of a specified robot |
| GET Query Robot Availability | Queries the availability of robots against a given tenancy |
| GET Query Robot Availability | Queries the availability of robots against a given tenancy |
| POST Add Queue Item | Adds an item to a specified queue |
| POST Stop Job | Stops a job that is currently running |

### Humley UIPath 1.1

| Integration Name | Description |
|--|--|
| POST Start A Job | Retrieves the state of a specified job |
| POST Starts A Job With Arguments | Starts a job with accompanying arguments |

## UiPath Integrations Breakdowm

The following explains each of these in more detail:

#### Humley UIPath 1.0 / GET Get Job State

The Get Job State endpoint allows you to get the state of any job by providing a JobId.

You can read more about this in the UiPath Orchestrator API documentation found [here](https://orchestrator.uipath.com/reference#jobs-requests)

##### Request Parameters

| Request Parameter | Description |
|--|--|
| ConversationId | Used within the Humley platform to provide a result within conversation |
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |
| JobId | The Job that wish to get the state for |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |
| JobState | Starts a job with accompanying arguments |
| Result | The full result as returned from UiPath, this is will be presented as a JSON Object |

#### Humley UIPath 1.0 / GET Get Queue Item State

The Get Queue Item State endpoint allows you to get the state of any queue item by providing a RefId.

##### Request Parameters

| Request Parameter | Description |
|--|--|
| ConversationId | Used within the Humley platform to provide a result within conversation |
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |
| RefId | A unique identifier against the queue item |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |
| QueueItemState | The status of queue item that you queried |
| Result | The full result as returned from UiPath, this is will be presented as a JSON Object |

#### Humley UIPath 1.0 / GET Get Robot State

The Get Robot State endpoint allows you to get the state of any robot by providing a RobotId.

You can read more about this in the UiPath Orchestrator API documentation found [here](https://orchestrator.uipath.com/reference#robots-requests)

##### Request Parameters

| Request Parameter | Description |
|--|--|
| ConversationId | Used within the Humley platform to provide a result within conversation |
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| RobotId | The robot id that you wish to query availability for |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |
| RobotState | The state of the robot queried |
| Result | The full result as returned from UiPath, this is will be presented as a JSON Object |

#### Humley UIPath 1.0 / GET Query Robot Availability

The Query Robot Availability endpoint allows you to get the a list of robots that currently available.

##### Request Parameters

| Request Parameter | Description |
|--|--|
| ConversationId | Used within the Humley platform to provide a result within conversation |
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |
| RobotState | The first available robot from your robot collection |
| Result | The full result as returned from UiPath, this is will be presented as a JSON Object |

#### Humley UIPath 1.0 / POST Add Queue Item

The Add Queue Item endpoint allows you to add a queue item by specifying the QueueName and a RefId

##### Request Parameters

| Request Parameter | Description |
|--|--|
| ConversationId | Used within the Humley platform to provide a result within conversation |
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |
| QueueName | The name of the queue that you wish the item to be added to |
| RefId | A unique identifier against the queue item |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |
| Result | The full result as returned from UiPath, this is will be presented as a JSON Object |
| QueueItemId | The id of the item added to queue |

#### Humley UIPath 1.0 / POST Stop Job

The Stop Job endpoint allows you to get the stop any jon by providing a JobId.

You can read more about this in the UiPath Orchestrator API documentation found [here](https://orchestrator.uipath.com/reference#jobs-requests)

##### Request Parameters

| Request Parameter | Description |
|--|--|
| ConversationId | Used within the Humley platform to provide a result within conversation |
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |
| JobId | The id of the job you wish to stop |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |

#### Humley UIPath 1.1 / POST Start a job

The Start Job endpoint allows you to start a job by providing a ReleaseKey and RobotId.

You can read more about this in the UiPath Orchestrator API documentation found [here](https://orchestrator.uipath.com/reference#jobs-requests)

##### Request Parameters

| Request Parameter | Description |
|--|--|
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |
| RobotId | The robot that should be used for the job |
| ReleaseKey | The release key of the process that should be carried out |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |
| Result | The full result as returned from UiPath, this is will be presented as a JSON Object |
| JobId | The unqiue identifier of newly created job |
| JobKey | A key that relates to the newly created job |

#### Humley UIPath 1.1 / POST Start a job with arguements

The Start Job endpoint allows you to start a job by providing a ReleaseKey and RobotId, this endpoint also allows you configure input paramaters.

You can read more about this in the UiPath Orchestrator API documentation found [here](https://orchestrator.uipath.com/reference#jobs-requests)

##### Request Parameters

| Request Parameter | Description |
|--|--|
| Domain | Represents the name or domain\name of the machine on which Orchestrator is installed, or the user account, such as docteam or uipath.local\docteam. |
| Password | Your UiPath password |
| TenacyName | Your UiPath Tenacy Name |
| Username | Your UiPath username |
| RobotId | The robot that should be used for the job |
| ReleaseKey | The release key of the process that should be carried out |

##### Response Defintions

| Request Parameter | Description |
|--|--|
| Exception | In the event of an error, this will contain a status code related to issue along with a description of the error |
| Result | The full result as returned from UiPath, this is will be presented as a JSON Object |
| JobId | The unqiue identifier of newly created job |
| JobKey | A key that relates to the newly created job |