Sherpa RPA

https://docs.sherparpa.ru/
Admin
Sherpa RPA is a Robotic Process Automation (RPA) platform that provides tools for process discovery,...
Tokens:194,599
Snippets:1,025
Trust Score:7.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Docker Engine

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Installs the Docker engine on Ubuntu systems. It enables the Docker service to start automatically on boot and then starts the service immediately. Assumes Docker is not already installed or requires reinstallation.

```bash
sudo apt install docker.io -y
sudo systemctl enable docker
sudo systemctl start docker
```

--------------------------------

### Install Docker Compose

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Installs the latest version of Docker Compose. This involves downloading the binary from GitHub based on the detected OS and architecture, making it executable, and placing it in the system's PATH. Requires `curl` to be installed.

```bash
sudo apt install curl -y
LATEST_COMPOSE_VERSION=$(curl -s https://api.github.com/repos/docker/compose/releases/latest | grep 'tag_name' | cut -d" -f4)
sudo curl -L "https://github.com/docker/compose/releases/download/${LATEST_COMPOSE_VERSION}/docker-compose-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m | tr '[:upper:]' '[:lower:]')" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```

--------------------------------

### Install NVIDIA Container Toolkit

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Installs the NVIDIA Container Toolkit, which provides a Docker image with runtime support for NVIDIA GPUs. This involves setting up the official NVIDIA repository for the toolkit, updating the package list, and then installing the toolkit. It includes steps for both production and experimental repositories.

```bash
curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg 
&& curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | 
sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | 
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list
```

```bash
sed -i -e '/experimental/ s/^#//g' /etc/apt/sources.list.d/nvidia-container-toolkit.list
```

```bash
sudo apt-get update
```

```bash
sudo apt-get install -y nvidia-container-toolkit
```

--------------------------------

### Обновление базы данных

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Выполнение скрипта миграции базы данных для применения изменений.

```bash
sudo sh ./oais/migrate.sh
```

--------------------------------

### Добавление пользователя в группу Docker

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команда для добавления текущего пользователя в группу 'docker', что необходимо для работы с Docker без sudo.

```bash
sudo usermod -aG docker <username>
```

--------------------------------

### Создание директорий и копирование модели

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Создание структуры директорий для хранения моделей и копирование скачанной модели в соответствующее место.

```bash
sudo mkdir -p /opt/sais/model-store/meta-llama
sudo cp Meta-Llama-3-8B-Instruct-Q4_K_S.gguf /opt/sais/model-store/meta-llama
```

--------------------------------

### Install NVIDIA Docker Toolkit (nvidia-docker2)

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Installs the NVIDIA Docker 2 package, which allows Docker containers to access NVIDIA GPUs. This involves purging any existing `nvidia-docker` installations, adding the NVIDIA Docker repository, updating the package list, and installing `nvidia-docker2`. Requires `curl` and `apt-key`.

```bash
sudo apt-get purge -y nvidia-docker
distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | sudo apt-key add -
curl -s -L https://nvidia.github.io/nvidia-docker/$distribution/nvidia-docker.list | sudo tee /etc/apt/sources.list.d/nvidia-docker.list
sudo apt-get update
sudo apt-get install -y nvidia-docker2
sudo systemctl restart docker
```

--------------------------------

### Обновление драйвера NVIDIA

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Инструкции по распаковке архива с драйверами NVIDIA и запуску установщика драйвера для обновления системы.

```bash
tar -xzvf nvidia-graphics-drivers-535_535.129.03.orig-amd64.tar.gz --strip-components=1
sudo bash NVIDIA-Linux-x86_64-535.129.03.run
```

--------------------------------

### Создание базы данных

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команда для создания базы данных 'orchestrator' с указанной кодировкой и правилами сортировки через Docker.

```bash
docker exec -it orchestrator-db mysql -u root -e "CREATE DATABASE IF NOT EXISTS orchestrator CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci"
```

--------------------------------

### Загрузка Docker образов

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команда для загрузки Docker образов из файла .tar архива в локальное хранилище Docker.

```bash
sudo docker load --input sais20CPU-images.tar
```

--------------------------------

### Удаление временных файлов

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команда для удаления архивов после завершения установки с целью освобождения дискового пространства.

```bash
rm <file_name>
```

--------------------------------

### Install NVIDIA GPU Drivers

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Installs the NVIDIA driver version 535 on Ubuntu systems after updating the package list and upgrading existing packages. A system reboot is required after installation. The `nvidia-smi` command is used to verify the driver installation.

```bash
sudo apt update && sudo apt upgrade
sudo apt install nvidia-driver-535
sudo reboot
```

```bash
nvidia-smi
```

--------------------------------

### Запуск контейнеров приложения

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Запуск всех необходимых Docker-контейнеров для работы приложения с помощью скрипта run.sh.

```bash
sudo sh ./run.sh
```

--------------------------------

### Update Linux OS

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Updates the package list for the Linux operating system to ensure all packages are up-to-date before installing new software. This is a standard first step in many Linux installations.

```bash
sudo apt update
```

--------------------------------

### Распаковка архивов приложения

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команды для распаковки скачанных архивов приложения, содержащих основные компоненты сервера.

```bash
sudo tar -xf sais20CPU-20250425.tar.gz
sudo tar -xf sentence-transformers-model.tar.gz
```

--------------------------------

### Назначение прав на исполнение сценариев

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Поиск всех .sh файлов в текущей директории и назначение им прав на исполнение.

```bash
sudo find ./*.sh -type f | sudo xargs chmod +x
```

--------------------------------

### Проверка использования ресурсов Docker

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команда для мониторинга использования ресурсов (CPU, память) запущенными Docker-контейнерами.

```bash
docker stats
```

--------------------------------

### Настройка прав на конфигурационный файл MySQL

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Установка прав на чтение (0444) для конфигурационного файла MySQL.

```bash
sudo chmod 0444 /opt/sais/oais/backend/config/my.cnf
```

--------------------------------

### Создание Docker сети

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Создание новой bridge-сети для Docker с определенным диапазоном подсети, которая будет использоваться контейнерами приложения.

```bash
sudo docker network create --driver bridge --subnet 172.18.0.0/16 llm-net
```

--------------------------------

### Настройка переменных окружения CUDA

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Добавление путей к исполняемым файлам и библиотекам CUDA в переменные окружения ~/.bashrc и их последующее применение.

```bash
echo 'export PATH=/usr/local/cuda/bin:$PATH' >> ~/.bashrc
echo 'export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH' >> ~/.bashrc
source ~/.bashrc
```

--------------------------------

### Get Robot Status by GUID (API Request)

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/robot/api-robot-getstatus-guid

This snippet demonstrates how to call the SherpaRPA API to retrieve the status of a specific robot using its GUID. It shows the endpoint, HTTP method, and an example request URL.

```bash
GET /api/robot/getStatus/554ab883-1f82-48e1-bb12-5049002e7d70
```

--------------------------------

### Конфигурация Sherpa Coordinator

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-rpa-coordinator/ustanovka-sherpa-coordinator-na-redos

Редактирование файла setting.ini для указания сервера Оркестратора и GUID Координатора, а также настройка других параметров.

```bash
mcedit /home/sherpacoordinator/.config/sherpa-rpa-data/coordinator/setting.ini
```

--------------------------------

### Get Trigger Information by GUID (JSON)

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/trigger/api-schedule-read-guid

This snippet shows an example JSON response for the /api/schedule/read/{guid} endpoint, which provides details about a trigger based on its unique identifier (GUID).

```json
{
"id": "55",
"guid": "554ab883-1f82-48e1-bb12-5049002e7d70",
"name": "Test Trigger",
"processing_type": 1,
"robot_type": 2,
"robot_id": 24,
"process_id": 42
}
```

--------------------------------

### Python Robot Configuration Example

Source: https://docs.sherparpa.ru/sherpa-orchestrator/python-sherpa-framework/pervonachalnaya-ustanovka-i-nastroika-komponentov-platformy-na-primere-sherpa-orchestrator

This snippet shows how to set the RobotGUID variable in a Python script, which is necessary for a Python robot to connect to the Sherpa Orchestrator. Ensure the GUID is correctly copied from the Orchestrator.

```python
RobotGUID = "PASTE_COPIED_GUID_HERE"
# Rest of your Python robot script...
```

--------------------------------

### Скачивание файлов для установки CUDA offline

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команды для скачивания необходимых архивов для оффлайн установки CUDA, включая CUDA Toolkit и драйверы NVIDIA.

```bash
wget https://sherparpa.ru/downloads/private/SherpaAIServer/cuda-offline-install.tar.gz
wget https://sherparpa.ru/downloads/private/SherpaAIServer/nvidia-graphics-drivers-535_535.129.03.orig-amd64.tar.gz
```

--------------------------------

### Настройка автозагрузки Sherpa Coordinator

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-rpa-coordinator/ustanovka-sherpa-coordinator-na-redos

Создание директории autostart и копирование туда файла .desktop для автоматической загрузки Sherpa Coordinator при старте системы.

```bash
mkdir $HOME/.config/autostart
```

```bash
cp -f /usr/lib/sherpa-coordinator/sherpa-coordinator.desktop $HOME/.config/autostart
```

--------------------------------

### Retrieve Task by GUID/Name - API Request Example

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/zadacha/api-task-read

This snippet shows an example of how to make a GET request to the SherpaRPA API to retrieve a task. The request includes the task's GUID or name as part of the URL. Authorization is required.

```http
GET /api/task/read/123
```

--------------------------------

### Скачивание файлов приложения Sherpa AI Server

Source: https://docs.sherparpa.ru/sherpa-ai-server/ustanovka-sherpa-ai-server

Команды для скачивания необходимых архивов и моделей для установки приложения Sherpa AI Server с использованием wget.

```bash
sudo wget -O Meta-Llama-3-8B-Instruct-Q4_K_S.gguf https://sherparpa.ru/downloads/private/SherpaAIServer/Meta-Llama-3-8B-Instruct-Q4_K_S.gguf
sudo wget -O sais20CPU-20250425.tar.gz https://sherparpa.ru/downloads/private/SherpaAIServer/sais20CPU-20250425.tar.gz
sudo wget -O sentence-transformers-model.tar.gz https://sherparpa.ru/downloads/private/SherpaAIServer/sentence-transformers-model.tar.gz
```

--------------------------------

### Read Process by GUID Request Example (JSON)

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/process/api-process-read-guid

This snippet shows an example of a JSON request body to retrieve a process by its GUID. The GUID is a mandatory parameter for this operation.

```json
{
"Guid": "554ab883-1f82-48e1-bb12-5049002e7d70"
}
```

--------------------------------

### GET /api/robot/getStatus/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/robot/api-robot-getstatus-guid

Retrieves the status of a robot using its unique GUID.

```APIDOC
## GET /api/robot/getStatus/{guid}

### Description
Retrieves the status of a robot by its GUID.

### Method
GET

### Endpoint
/api/robot/getStatus/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the robot.

### Request Example
/api/robot/getStatus/554ab883-1f82-48e1-bb12-5049002e7d70

### Response
#### Success Response (200)
- **Status** (integer) - The current status of the robot.

#### Response Example
```json
{
  "Status": 1
}
```
```

--------------------------------

### Установка .NET Core 8 SDK на Debian

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-robot/ustanovka-sherpa-robot-attended-na-linux/ustanovka-sherpa-robot-attended-na-astra-linux

Устанавливает .NET Core 8 SDK, следуя официальным инструкциям Microsoft для Debian. Требует прав sudo. Включает добавление репозитория Microsoft, обновление списка пакетов и установку SDK.

```shell
wget https://packages.microsoft.com/config/debian/10/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb
sudo apt-get update
sudo apt-get install -y dotnet-sdk-8.0
```

--------------------------------

### Read Process by GUID Response Example (JSON)

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/process/api-process-read-guid

This snippet provides an example of a JSON response when successfully reading a process by its GUID. It includes details such as process ID, GUID, name, version, and creation/update timestamps.

```json
[
"id": "1",
"guid": "554ab883-1f82-48e1-bb12-5049002e7d70",
"name": "TestProcess",
"description": "test",
"process_version_id": "1",
"min_version_to_run": "1.14",
"created": "2023-05-26 09:50:27",
"updated": "2023-05-26 09:50:43",
"is_deleted": "0",
"account_id": "1",
"process_type": "0",
"process_version_guid": "554ab883-1f82-48e1-bb12-5045562e7d70"
]
```

--------------------------------

### GET /api/asset/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/resurs/api-asset-read-guid

Retrieves information about an asset using its GUID. Requires authorization.

```APIDOC
## GET /api/asset/read/{guid}

### Description
Retrieves detailed information about a specific asset using its globally unique identifier (GUID).

### Method
GET

### Endpoint
/api/asset/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The globally unique identifier of the asset.

### Request Example
```
/api/asset/read/16f94238-ede9-435b-a001-1489b32e7dc2
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the asset.
- **guid** (string) - The globally unique identifier of the asset.
- **name** (string) - The name of the asset.
- **description** (string) - A description of the asset.
- **type** (integer) - The type of the asset.
- **text** (string) - Text content associated with the asset.
- **password** (string) - The password for the asset (if applicable).
- **password_expiration** (string) - The expiration date of the password.
- **robot_type** (integer) - The type of robot associated with the asset.
- **robot_id** (string) - The ID of the robot associated with the asset.
- **robot_group_id** (string) - The ID of the robot group associated with the asset.
- **is_deleted** (integer) - Flag indicating if the asset is deleted (0 for not deleted, 1 for deleted).
- **created_at** (string) - The timestamp when the asset was created.
- **updated_at** (string) - The timestamp when the asset was last updated.

#### Response Example
```json
{
"id": "16",
"guid": "16f94238-ede9-435b-a001-1489b32e7dc2",
"name": "Asset 1",
"description": "My new test Asset",
"type": 2,
"text": "Hello World",
"password": null,
"password_expiration": null,
"robot_type": 3,
"robot_id": null,
"robot_group_id": null,
"is_deleted": 0,
"created_at": "2023-05-30 08:57:23",
"updated_at": "2023-05-30 09:00:00"
}
```
```

--------------------------------

### Get Robot Status Response Example

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/robot/api-robot-getstatus-guid

This snippet provides an example of the JSON response received from the SherpaRPA API when querying the status of a robot. It includes the status code.

```json
{
"Status": 1
}
```

--------------------------------

### GET /api/queue/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/ochered/api-queue-read-guid

Reads a queue item by its GUID. Requires authentication.

```APIDOC
## GET /api/queue/read/{guid}

### Description
Reads a queue item by its GUID.

### Method
GET

### Endpoint
/api/queue/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The GUID of the queue item.

### Request Example
```
/api/queue/read/554ab883-1f82-48e1-bb12-5049002e7d70
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the queue item.
- **guid** (string) - The GUID of the queue item.
- **name** (string) - The name of the queue item.
- **description** (string) - The description of the queue item.
- **auto_change_status** (integer) - Flag for automatic status change.
- **unique_tasks** (integer) - Flag for unique tasks.

#### Response Example
```json
[
"id": 53,
"guid": "554ab883-1f82-48e1-bb12-5049002e7d70",
"name": "Test Queue",
"description": "Test Queue Description",
"auto_change_status": 0,
"unique_tasks": 1,
]
```
```

--------------------------------

### GET /api/files/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/khranilishe/api-files-read-guid

Retrieves information about a file using its unique GUID.

```APIDOC
## GET /api/files/read/{guid}

### Description
Retrieves information about a file using its unique GUID.

### Method
GET

### Endpoint
/api/files/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the file.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **Name** (string) - The name of the file.

#### Response Example
```json
{
  "Name": "Test Robot"
}
```
```

--------------------------------

### Копирование файла автозагрузки

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-rpa-coordinator/ustanovka-sherpa-coordinator-na-os-astra-linux

Копирует файл sherpa-coordinator.desktop в директорию автозагрузки пользователя, чтобы Координатор запускался автоматически при старте системы.

```bash
cp -f /usr/lib/sherpa-coordinator/sherpa-coordinator.desktop $HOME/.config/autostart
```

--------------------------------

### GET /api/processVersion/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/versiya-processa/api-processversion-create

Retrieves a specific process version by its GUID.

```APIDOC
## GET /api/processVersion/read/{guid}

### Description
Retrieves a specific process version by its GUID.

### Method
GET

### Endpoint
/api/processVersion/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The GUID of the process version to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
(Response structure not provided in the input text.)

#### Response Example
(Response structure not provided in the input text.)
```

--------------------------------

### GET /api/job/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/rabota/api-job-create

Reads job details using its GUID. Authorization is required.

```APIDOC
## GET /api/job/read/{guid}

### Description
Reads job details using its GUID. Authorization is required.

### Method
GET

### Endpoint
/api/job/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The GUID of the job to read.

### Response
#### Success Response (200)
- **status** (integer) - Status of the job.
- **process_version_id** (string) - The ID of the process version.
- **robot_id** (integer) - The ID of the robot.
- **account_id** (integer) - The ID of the account.
- **schedule_id** (integer) - The ID of the schedule.
- **stop_after** (string) - The timestamp when the job should stop.
- **created_at** (string) - The timestamp when the job was created.
- **updated_at** (string) - The timestamp when the job was last updated.

#### Response Example
```json
{
  "status": 1,
  "process_version_id": "55",
  "robot_id": 1,
  "account_id": 4,
  "schedule_id": 2,
  "stop_after": "2023-03-04 12:00:00",
  "created_at": "2023-03-03 12:48:06",
  "updated_at": "2023-03-03 13:24:26"
}
```
```

--------------------------------

### Установка xfreerdp на RedOS

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-rpa-coordinator/ustanovka-sherpa-coordinator-na-redos

Устанавливает пакет xfreerdp (freerdp2) для обеспечения удаленных подключений к Unattended-роботам. Требует прав sudo.

```bash
sudo dnf install freerdp2
```

--------------------------------

### Get File Information by GUID

Source: https://docs.sherparpa.ru/sherpa-ai-server/rabota-v-sherpa-ai-server/api

Retrieves information about a specific file using its GUID.

```APIDOC
## GET /api/files/read/{guid}

### Description
Retrieves information about a specific file using its GUID.

### Method
GET

### Endpoint
/api/files/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier of the file.

### Request Example
```
/api/files/read/a1b2c3d4-e5f6-7890-1234-567890abcdef
```

### Response
#### Success Response (200)
- **Name** (string) - The name of the file.

#### Response Example
```json
{
  "Name": "Test Robot"
}
```
```

--------------------------------

### Установка .NET SDK 8.0

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-robot/ustanovka-sherpa-robot-attended-na-linux/ustanovka-sherpa-robot-attended-na-redos

Устанавливает .NET SDK версии 8.0 с использованием пакетного менеджера dnf. Это необходимо для запуска приложений, разработанных с использованием .NET Core.

```bash
sudo dnf install -y dotnet-sdk-8.0
```

--------------------------------

### GET /api/process/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/process/api-process-read-guid

Reads process information by providing its unique GUID. This endpoint is crucial for retrieving specific process details.

```APIDOC
## GET /api/process/read/{guid}

### Description
Retrieves process details using its unique GUID.

### Method
GET

### Endpoint
/api/process/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the process to read.

### Request Example
```json
{
  "Guid": "554ab883-1f82-48e1-bb12-5049002e7d70"
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the process.
- **guid** (string) - The GUID of the process.
- **name** (string) - The name of the process.
- **description** (string) - The description of the process.
- **process_version_id** (string) - The ID of the process version.
- **min_version_to_run** (string) - The minimum version required to run the process.
- **created** (string) - The timestamp when the process was created.
- **updated** (string) - The timestamp when the process was last updated.
- **is_deleted** (string) - Indicates if the process is deleted ('0' for no, '1' for yes).
- **account_id** (string) - The ID of the account associated with the process.
- **process_type** (string) - The type of the process.
- **process_version_guid** (string) - The GUID of the process version.

#### Response Example
```json
[
  {
    "id": "1",
    "guid": "554ab883-1f82-48e1-bb12-5045562e7d70",
    "name": "TestProcess",
    "description": "test",
    "process_version_id": "1",
    "min_version_to_run": "1.14",
    "created": "2023-05-26 09:50:27",
    "updated": "2023-05-26 09:50:43",
    "is_deleted": "0",
    "account_id": "1",
    "process_type": "0",
    "process_version_guid": "554ab883-1f82-48e1-bb12-5045562e7d70"
  }
]
```
```

--------------------------------

### Редактирование файла настроек coordinator

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-rpa-coordinator/ustanovka-sherpa-coordinator-na-os-astra-linux

Открывает файл setting.ini в редакторе kate для настройки параметров Координатора, таких как сервер Оркестратора и GUID.

```bash
kate /home/sherpacoordinator/.config/sherpa-rpa-data/coordinator/setting.ini
```

--------------------------------

### GET /api/robot/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/robot/api-robot-read-guid

Retrieves information about a specific robot using its GUID.

```APIDOC
## GET /api/robot/read/{guid}

### Description
Retrieves information about a specific robot using its GUID.

### Method
GET

### Endpoint
/api/robot/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - GUID of the robot.

### Request Example
```
/api/robot/read/554ab883-1f82-48e1-bb12-5049002e7d70
```

### Response
#### Success Response (200)
- **GUID** (string) - The unique identifier of the robot.
- **Name** (string) - The name of the robot.
- **Machine** (string) - The machine the robot is running on.
- **Status** (integer) - The current status of the robot (e.g., 0 for inactive).
- **IP** (string) - The IP address of the robot.
- **MAC** (string) - The MAC address of the robot.
- **Description** (string) - A description of the robot.
- **LicenseExpiration** (integer) - Timestamp of license expiration.
- **LicenseString** (string) - The license string for the robot.
- **CreatedAt** (integer) - Timestamp of creation.
- **UpdatedAt** (integer) - Timestamp of last update.
- **LastHeartbeatAt** (integer) - Timestamp of the last heartbeat.

#### Response Example
```json
{
  "GUID": "16f94238-ede9-435b-a001-1489b32e7dc2",
  "Name": "r1",
  "Machine": "",
  "Status": 0,
  "IP": "",
  "MAC": "",
  "Description": "",
  "LicenseExpiration": 12345789,
  "LicenseString": "",
  "CreatedAt": 12345789,
  "UpdatedAt": 12345789,
  "LastHeartbeatAt": 0
}
```
```

--------------------------------

### Установка плагина Sherpa RPA для Yandex Browser

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-robot/ustanovka-sherpa-robot-attended-na-linux/ustanovka-sherpa-robot-attended-na-redos

Инструкции по установке плагина Sherpa RPA для Yandex Browser путем копирования файла .crx и выполнения скрипта install_host.sh. Указывает путь к файлам робота и инструкции для браузера.

```bash
/home/user/sherpa-robot
```

```bash
/home/user/sherpa-robot/Chrome
```

```bash
chmod +x install_host.sh
```

```bash
./install_host.sh
```

--------------------------------

### GET /api/schedule/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/trigger/api-schedule-read-guid

Retrieves information about a specific trigger using its GUID.

```APIDOC
## GET /api/schedule/read/{guid}

### Description
Retrieves information about a specific trigger using its GUID.

### Method
GET

### Endpoint
/api/schedule/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the trigger.

### Request Example
```
/api/schedule/read/554ab883-1f82-48e1-bb12-5049002e7d70
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the trigger.
- **guid** (string) - The GUID of the trigger.
- **name** (string) - The name of the trigger.
- **processing_type** (integer) - The type of processing.
- **robot_type** (integer) - The type of robot.
- **robot_id** (integer) - The ID of the robot.
- **process_id** (integer) - The ID of the process.

#### Response Example
```json
{
"id": "55",
"guid": "554ab883-1f82-48e1-bb12-5049002e7d70",
"name": "Test Trigger",
"processing_type": 1,
"robot_type": 2,
"robot_id": 24,
"process_id": 42
}
```
```

--------------------------------

### GET /api/log/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/log/api-log-read-guid

Retrieves log information using a specific GUID. Authorization is required.

```APIDOC
## GET /api/log/read/{guid}

### Description
Retrieves detailed information about a specific log entry using its unique GUID.

### Method
GET

### Endpoint
/api/log/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the log entry to retrieve.

### Request Example
```
/api/log/read/c39713ea-d8b9-4669-976e-5ff39677dc64
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the log.
- **guid** (string) - The GUID of the log.
- **robot_id** (string) - The ID of the robot associated with the log.
- **process_version_id** (string) - The ID of the process version.
- **job_id** (string) - The ID of the job.
- **Level** (integer) - The log level.
- **Message** (string) - The log message.
- **created_at** (string) - The timestamp when the log was created.
- **updated_at** (string) - The timestamp when the log was last updated.

#### Response Example
```json
{
"id": "1",
"guid": "16f94238-ede9-435b-a001-1489b32e7dc2",
"robot_id": "16",
"process_version_id": "39",
"job_id": "70",
"Level": 1,
"Message": "no message",
"created_at": "2023-09-17 15:39:06",
"updated_at": "2023-09-17 16:39:06"
}
```
```

--------------------------------

### Запуск установщика Sherpa RPA

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-robot/ustanovka-sherpa-robot-i-sherpa-assistant-na-windows

Этот код представляет собой команду для запуска исполняемого файла установщика Sherpa RPA на Windows. Файл 'SherpaRPA.exe' запускает процесс установки программного обеспечения.

```bash
SherpaRPA.exe
```

--------------------------------

### Выполнение коммита и push в GitHub с помощью Sherpa Designer

Source: https://docs.sherparpa.ru/sherpa-designer/kak-razmestit-proekt-na-github-s-pomoshyu-sherpa-designer

Процесс фиксации изменений в проекте и отправки их в удаленный репозиторий GitHub через Sherpa Designer. Исключает файлы бэкапов из коммита.

```text
1. Откройте проект в Sherpa Designer.
2. Нажмите на иконку “Git Commit“ на верхней панели.
3. В окне “Git Commit” выберите файлы для коммита (исключая бэкапы).
4. В поле “Сообщение” введите описание изменений (commit message).
5. Нажмите “Commit and push” для отправки изменений в репозиторий.
```

--------------------------------

### GET /api/folders/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/khranilishe/api-folders-read-guid

Retrieves information about a specific folder using its GUID. Requires authorization.

```APIDOC
## GET /api/folders/read/{guid}

### Description
Retrieves information about a specific folder by its unique identifier (GUID).

### Method
GET

### Endpoint
/api/folders/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier of the folder.

### Request Example
GET /api/folders/read/4dd6abf4-daa3-45d0-9347-6780c2b46b0c

### Response
#### Success Response (200)
- **id** (integer) - The internal ID of the folder.
- **guid** (string) - The unique identifier of the folder.
- **name** (string) - The name of the folder.
- **description** (string) - A description of the folder.
- **created** (string) - The timestamp when the folder was created.
- **updated** (string) - The timestamp when the folder was last updated.
- **is_deleted** (integer) - Indicates if the folder is marked as deleted (0 for no, 1 for yes).
- **account_id** (integer) - The ID of the account associated with the folder.

#### Response Example
```json
{
  "id": 1,
  "guid": "4dd6abf4-daa3-45d0-9347-6780c2b46b0c",
  "name": "Test Folder 1",
  "description": "My new test Folder",
  "created": "2023-01-29 10:29:25",
  "updated": "2023-01-29 10:44:09",
  "is_deleted": 0,
  "account_id": 1
}
```
```

--------------------------------

### GET /api/robotGroup/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/gruppy-robotov/api-robotgroup-read-guid

Retrieves information about a Robot Group using its GUID.

```APIDOC
## GET /api/robotGroup/read/{guid}

### Description
Retrieves information about a Robot Group by its unique identifier (GUID).

### Method
GET

### Endpoint
/api/robotGroup/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the Robot Group.

### Request Example
GET /api/robotGroup/read/554ab883-1f82-48e1-bb12-5049002e7d70

### Response
#### Success Response (200)
- **id** (string) - The ID of the Robot Group.
- **guid** (string) - The GUID of the Robot Group.
- **name** (string) - The name of the Robot Group.
- **description** (string) - The description of the Robot Group.
- **created** (string) - The creation timestamp.
- **updated** (string) - The last updated timestamp.
- **is_deleted** (string) - Indicates if the group is deleted ('0' for not deleted).
- **account_id** (string) - The ID of the associated account.

#### Response Example
```json
{
"id": "55",
"guid": "554ab883-1f82-48e1-bb12-5049002e7d70",
"name": "TestRobotGroup",
"description": "Test Description",
"created": "2023-06-27 12:31:29",
"updated": "2023-06-27 12:31:29",
"is_deleted": "0",
"account_id": "1"
}
```
```

--------------------------------

### Установка PowerShell на Debian

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-robot/ustanovka-sherpa-robot-attended-na-linux/ustanovka-sherpa-robot-attended-na-astra-linux

Устанавливает PowerShell на Debian, используя менеджер пакетов apt. Требует прав sudo. Зависит от предварительно настроенных репозиториев.

```shell
sudo apt-get install -y powershell
```

--------------------------------

### GET /api/job/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/rabota/api-job-read-guid

Reads job information by its GUID. This endpoint requires authorization and retrieves specific job details based on the provided GUID.

```APIDOC
## GET /api/job/read/{guid}

### Description
Reads job information by its GUID. This endpoint requires authorization and retrieves specific job details based on the provided GUID.

### Method
GET

### Endpoint
/api/job/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - GUID of the Process Version to retrieve the Process for which a new Version is being created.

### Request Example
```json
{
  "example": "/api/processVersion/read/554ab883-1f82-48e1-bb12-5049002e7d70"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the job.
- **guid** (string) - The globally unique identifier for the job.
- **process_id** (string) - The identifier of the associated process.
- **name** (string) - The name of the job.
- **description** (string) - A description of the job.
- **process_file_name** (string) - The name of the process file.
- **created** (string) - The timestamp when the job was created.
- **updated** (string) - The timestamp when the job was last updated.
- **is_deleted** (string) - Flag indicating if the job is deleted ('0' for not deleted, '1' for deleted).
- **account_id** (string) - The identifier of the account associated with the job.

#### Response Example
```json
{
  "id": "6",
  "guid": "554ab883-1f82-48e1-bb12-5049002e7d70",
  "process_id": "5",
  "name": "New Version",
  "description": "New Version for Process 5",
  "process_file_name": "new-file.robot",
  "created": "2023-06-29 14:51:30",
  "updated": "2023-06-29 14:51:30",
  "is_deleted": "0",
  "account_id": "5"
}
```
```

--------------------------------

### POST /websites/sherparpa_ru/CreateFTPFolder

Source: https://docs.sherparpa.ru/sherpa-designer/spravochnik-blokov/ftp-sftp/sozdat-papku-createftpfolder

Creates a folder on an FTP/SFTP server. Supports both FTP and SFTP protocols. Requires server URL, username, and password for authentication. Optionally accepts a private key file for SFTP authentication.

```APIDOC
## POST /websites/sherparpa_ru/CreateFTPFolder

### Description
Creates a folder on an FTP/SFTP server. Supports both FTP and SFTP protocols. Requires server URL, username, and password for authentication. Optionally accepts a private key file for SFTP authentication.

### Method
POST

### Endpoint
/websites/sherparpa_ru/CreateFTPFolder

### Parameters
#### Request Body
- **URL** (string) - Required - The full path to the FTP directory, starting with the protocol (e.g., "ftp://server.url/folder" or "sftp://server.url/folder").
- **Имя пользователя** (string) - Required - The username for authorization on the FTP server.
- **Пароль** (string/SecureString) - Required - The password for authorization on the FTP server.
- **Файл приватного ключа** (string) - Optional - The private key file for SFTP authorization. If used, the password property can be used for the key's passphrase.
- **Уровень обработки** (string) - Optional - Specifies the error handling level. Possible values: "Default", "Ignore", "Handle".
- **Уровень сообщений** (string) - Optional - Specifies the message logging level. Possible values: "Default", "Release", "Debug", "Detailed".

### Response
#### Success Response (200)
- **Текст ошибки** (string) - Returns detailed error information if the block execution was incorrect.
```

--------------------------------

### GET /api/robot/read/{guid}

Source: https://docs.sherparpa.ru/sherpa-orchestrator/api/robot/api-robot-create

Retrieves information about a specific Robot using its GUID. Requires authentication.

```APIDOC
## GET /api/robot/read/{guid}

### Description
Retrieves information about a specific Robot using its GUID. Requires authentication.

### Method
GET

### Endpoint
/api/robot/read/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the Robot to retrieve.

### Response
#### Success Response (200)
- **Name** (string) - The name of the Robot.
- **Description** (string) - The description of the Robot.
- **GUID** (string) - The unique identifier (GUID) of the Robot.
- **Status** (integer) - The status code of the Robot.

#### Response Example
```json
{
"Name": "test robot",
"Description": "test robot description",
"GUID": "1ed7e9a1-87a9-4f56-b977-498485a28e6f",
"Status": 0
}
```
```

--------------------------------

### Установка .NET SDK 8.0 и PowerShell

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-robot/ustanovka-sherpa-robot-unattended-na-linux/ustanovka-sherpa-robot-unattended-na-astra-linux

Устанавливает .NET SDK версии 8.0 и PowerShell на систему Debian.

```shell
sudo apt-get install -y dotnet-sdk-8.0
sudo apt-get install -y powershell
```

--------------------------------

### Создание директории автозагрузки

Source: https://docs.sherparpa.ru/sherpa-orchestrator/razvertyvanie-platformy-pod-upravleniem-orkestratora/ustanovka-sherpa-rpa-coordinator/ustanovka-sherpa-coordinator-na-os-astra-linux

Создает директорию .config/autostart в домашней директории пользователя, если она еще не существует. Используется для настройки автозагрузки приложений.

```bash
mkdir $HOME/.config/autostart
```
Tokens:
Raw